org.wandora.topicmap.remote

Class RemoteTopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.memory.TopicMapImpl

org.wandora.topicmap.remote.RemoteTopicMap

All Implemented Interfaces:

TopicMapLogger

public class RemoteTopicMap
extends TopicMapImpl

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	connectionParams
private java.util.HashSet	deletedTopicSIs
private java.util.HashSet	editedAssociations
private java.util.HashSet	editedTopics
private java.util.HashSet	fetchedBaseNames
private java.util.HashSet	fetchedSIs
private java.util.HashSet	fullTopics
private java.util.HashSet	gotTopicsOfType
(package private) int	importing
private ServerInterface	server

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
RemoteTopicMap(ServerInterface server)
RemoteTopicMap(ServerInterface server, java.lang.Object params) Creates a new instance of RemoteTopicMap

Method Summary

Modifier and Type	Method and Description
private void	_associationChanged(Association a)
private void	_topicChanged(Topic t)
private void	addFetchedTopicToCatalog(Topic t)
void	associationChanged(Association a)
void	associationPlayerChanged(Association a, Topic role, Topic newPlayer, Topic oldPlayer)
void	associationRemoved(Association a)
void	associationTypeChanged(Association a, Topic newType, Topic oldType)
boolean	cipher()
void	clearTopicMap() Completely clears the topic map.
void	clearTopicMapIndexes() If the topic map implementation keeps indexes or caches of topics, calling this method will clear such data structures and cause further methods to retrieve data directly from the original data source.
void	close() Close the topic map.
void	commit()
void	commitSession(java.lang.StringBuffer session, TopicMap edited)
void	connect()
protected AssociationImpl	constructAssociation(Topic type)
protected TopicImpl	constructTopic()
Association	copyAssociationIn(Association a) Copies an association of a different topic map in this topic map.
private Topic	copyFetchedTopicIn(Topic t)
private Topic	copyFetchedTopicIn(Topic t, boolean overwrite)
void	copyTopicAssociationsIn(Topic t) Copies all associations of a topic of a different topic map in this topic map using copyAssociationIn.
Topic	copyTopicIn(Topic t, boolean deep) Copies a topic of different topic map in this topic map.
Association	createAssociation(Topic type) Creates a new association of the given type without any members.
Topic	createTopic() Creates a new topic without base name, subject identifier, data or any associations.
java.lang.String	customCommand(java.lang.String command)
private void	doCommit()
void	duplicateAssociationRemoved(Association a, Association removeda)
java.util.Iterator	getAssociations() Returns all associations in the topic map.
java.util.Collection	getAssociationsOfType(Topic type) Returns all associations in the topic map that are of the given type.
java.lang.Object	getConnectionParams()
java.util.Collection	getEditedAssociations()
TopicMap	getEditedTopicMap()
java.util.Collection	getEditedTopics()
int	getNumAssociations() Returns the number of associations in topic map.
int	getNumTopics() Returns the number of topics in topic map.
java.lang.StringBuffer	getSession()
TopicMapStatData	getStatistics(TopicMapStatOptions options)
Topic	getTopic(Locator si) Gets a topic with subject identifier.
java.util.Iterator	getTopics() Gets all topics in the topic map.
Topic[]	getTopics(java.lang.String[] sis) Gets the topics whose subject identifiers are given in the array.
Topic[]	getTopics(java.lang.String[] sis, boolean overwrite)
java.util.Collection	getTopicsOfType(java.lang.String si) Gets all topics in the topic map that are of the given type.
java.util.Collection	getTopicsOfType(Topic type) Gets all topics in the topic map that are of the given type.
Topic	getTopicWithBaseName(java.lang.String name) Gets a topic with topic base name.
boolean	gzip()
void	handleServerError(java.lang.Exception e)
boolean	isConnected() Checks if this topic map is connected to the service providing the topic map.
private boolean	isFetchedTopicDeleted(Topic t)
boolean	isLocal()
boolean	isUncommitted()
boolean	login(java.lang.String user, java.lang.String password)
Topic	makeFull(Topic t)
void	mergeIn()
boolean	needLogin()
Topic	refreshTopic(Topic t)
void	removeTopicBaseName(Topic topic)
void	removeTopicData(Topic topic, Topic type, Topic version)
void	removeTopicSubjectIdentifier(Topic topic, Locator l)
void	removeTopicType(Topic topic, Topic type)
void	removeTopicVariant(Topic topic, java.util.Collection scope)
void	rollback()
void	saveSession(Wandora parent)
java.util.Collection<Topic>	search(java.lang.String query, TopicMapSearchOptions options) Searches the topic map for the given string.
void	setErrorHandler(ErrorHandler handler)
void	setTopicData(Topic topic, Topic type, Topic version)
void	setTopicSubjectLocator(Topic topic, Locator locator, Locator oldLocator)
void	topicBaseNameChanged(Topic t, java.lang.String newName, java.lang.String oldName)
void	topicChanged(Topic t)
void	topicDataChanged(Topic t, Topic type, Topic version, java.lang.String newValue, java.lang.String oldValue)
void	topicRemoved(Topic t)
void	topicsMerged(Topic newtopic, Topic deletedtopic)
void	topicSubjectIdentifierChanged(Topic t, Locator added, Locator removed)
void	topicSubjectLocatorChanged(Topic t, Locator newLocator, Locator oldLocator)
void	topicTypeChanged(Topic t, Topic added, Topic removed)
void	topicVariantChanged(Topic t, java.util.Collection<Topic> scope, java.lang.String newName, java.lang.String oldName)
void	writelog(java.lang.String lvl, java.lang.String msg)
boolean	writeTopicMapTo(java.io.OutputStream out)

Methods inherited from class org.wandora.topicmap.memory.TopicMapImpl

addTopicMapListener, addTopicSubjectIdentifier, addTopicType, checkAssociationConsistency, constructTopic, createTopic, disableAllListeners, enableAllListeners, getTopic, getTopicBySubjectLocator, getTopicMapListeners, getTypeTopics, isTopicMapChanged, mergeIn, removeTopicMapListener, removeTopicSubjectLocator, resetTopicMapChanged, setAssociationType, setTopicName, setTrackDependent, trackingDependent

Methods inherited from class org.wandora.topicmap.TopicMap

addTopicMapListeners, checkAssociationConsistency, copyTopicCollectionIn, createLocator, createLocator, escapeXML, exportJTM, exportJTM, exportJTM, exportJTM, exportLTM, exportLTM, exportLTM, exportLTM, exportTopicMap, exportTopicMap, exportXTM, exportXTM, exportXTM, exportXTM, exportXTM10, exportXTM10, exportXTM10, exportXTM20, exportXTM20, forceStop, getConsistencyCheck, getLogger, getMergingTopics, getParentTopicMap, getRootTopicMap, getTopic, getTopicBySubjectLocator, getTopics, hlog, importJTM, importJTM, importJTM, importJTM, importJTM, importJTM, importLTM, importLTM, importLTM, importLTM, importLTM, importLTM, importTopicMap, importTopicMap, importTopicMap, importXTM, importXTM, importXTM, importXTM, importXTM, isReadOnly, log, log, log, makeJTMString, makeJTMTopicId, makeLTMString, makeLTMTopicId, makeSubjectIndicator, makeSubjectIndicatorAsLocator, mergeIn, setConsistencyCheck, setLogger, setLogTitle, setParentTopicMap, setProgress, setProgressMax, setReadOnly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

server

private ServerInterface server

fullTopics

private java.util.HashSet fullTopics

editedTopics

private java.util.HashSet editedTopics

editedAssociations

private java.util.HashSet editedAssociations

deletedTopicSIs

private java.util.HashSet deletedTopicSIs

gotTopicsOfType

private java.util.HashSet gotTopicsOfType

fetchedBaseNames

private java.util.HashSet fetchedBaseNames

fetchedSIs

private java.util.HashSet fetchedSIs

importing

int importing

connectionParams

private java.lang.Object connectionParams

Constructor Detail

RemoteTopicMap

public RemoteTopicMap(ServerInterface server,
                      java.lang.Object params)

Creates a new instance of RemoteTopicMap

RemoteTopicMap

public RemoteTopicMap(ServerInterface server)

Method Detail

getConnectionParams

public java.lang.Object getConnectionParams()

clearTopicMap

public void clearTopicMap()
                   throws TopicMapException

Description copied from class: TopicMap

Completely clears the topic map. This deletes all associations and topics and all information related to them.

Overrides:

clearTopicMap in class TopicMapImpl

Throws:

TopicMapException

clearTopicMapIndexes

public void clearTopicMapIndexes()
                          throws TopicMapException

Description copied from class: TopicMap

If the topic map implementation keeps indexes or caches of topics, calling this method will clear such data structures and cause further methods to retrieve data directly from the original data source. (NOTE: should probably be named clearTopicMapCache?)

Overrides:

clearTopicMapIndexes in class TopicMapImpl

Throws:

TopicMapException

getEditedTopics

public java.util.Collection getEditedTopics()

getEditedAssociations

public java.util.Collection getEditedAssociations()

copyAssociationIn

public Association copyAssociationIn(Association a)
                              throws TopicMapException

Description copied from class: TopicMap

Copies an association of a different topic map in this topic map. If a topic related to the association does not exist in the topic map, then that topic is copied with copyTopicIn(t,false). Otherwise the existing topic is used. The existence of a topic is checked by trying to get it with one (chosen arbitrarily) subject identifier.

Overrides:

copyAssociationIn in class TopicMapImpl

Throws:

TopicMapException

copyTopicAssociationsIn

public void copyTopicAssociationsIn(Topic t)
                             throws TopicMapException

Description copied from class: TopicMap

Copies all associations of a topic of a different topic map in this topic map using copyAssociationIn.

Overrides:

copyTopicAssociationsIn in class TopicMapImpl

Throws:

TopicMapException

copyTopicIn

public Topic copyTopicIn(Topic t,
                         boolean deep)
                  throws TopicMapException

Description copied from class: TopicMap

Copies a topic of different topic map in this topic map. If deep is true then topic types, variants and data are also copied. Only stubs of types, data types and variant scopes are copied.

Overrides:

copyTopicIn in class TopicMapImpl

Throws:

TopicMapException

createAssociation

public Association createAssociation(Topic type)
                              throws TopicMapException

Description copied from class: TopicMap

Creates a new association of the given type without any members.

Overrides:

createAssociation in class TopicMapImpl

Throws:

TopicMapException

constructTopic

protected TopicImpl constructTopic()
                            throws TopicMapException

Overrides:

constructTopic in class TopicMapImpl

Throws:

TopicMapException

constructAssociation

protected AssociationImpl constructAssociation(Topic type)
                                        throws TopicMapException

Overrides:

constructAssociation in class TopicMapImpl

Throws:

TopicMapException

createTopic

public Topic createTopic()
                  throws TopicMapException

Description copied from class: TopicMap

Creates a new topic without base name, subject identifier, data or any associations.

Overrides:

createTopic in class TopicMapImpl

Throws:

TopicMapException

getTopics

public Topic[] getTopics(java.lang.String[] sis)
                  throws TopicMapException

Description copied from class: TopicMap

Gets the topics whose subject identifiers are given in the array. Will always return an array of equal size as the parameter array with null elements where topics are not found with the given subject identifiers.

Overrides:

getTopics in class TopicMapImpl

Throws:

TopicMapException

getTopics

public Topic[] getTopics(java.lang.String[] sis,
                         boolean overwrite)
                  throws TopicMapException

Throws:

TopicMapException

getTopic

public Topic getTopic(Locator si)
               throws TopicMapException

Description copied from class: TopicMap

Gets a topic with subject identifier.

Overrides:

getTopic in class TopicMapImpl

Throws:

TopicMapException

getTopicWithBaseName

public Topic getTopicWithBaseName(java.lang.String name)
                           throws TopicMapException

Description copied from class: TopicMap

Gets a topic with topic base name.

Overrides:

getTopicWithBaseName in class TopicMapImpl

Throws:

TopicMapException

getTopicsOfType

public java.util.Collection getTopicsOfType(Topic type)
                                     throws TopicMapException

Description copied from class: TopicMap

Gets all topics in the topic map that are of the given type.

Overrides:

getTopicsOfType in class TopicMapImpl

Throws:

TopicMapException

getTopicsOfType

public java.util.Collection getTopicsOfType(java.lang.String si)
                                     throws TopicMapException

Description copied from class: TopicMap

Gets all topics in the topic map that are of the given type. Parameter is the subject identifier of the type topic. If such a topic is not found in the topic map, will return an empty collection.

Overrides:

getTopicsOfType in class TopicMap

Throws:

TopicMapException

isFetchedTopicDeleted

private boolean isFetchedTopicDeleted(Topic t)
                               throws TopicMapException

Throws:

TopicMapException

addFetchedTopicToCatalog

private void addFetchedTopicToCatalog(Topic t)
                               throws TopicMapException

Throws:

TopicMapException

copyFetchedTopicIn

private Topic copyFetchedTopicIn(Topic t)
                          throws TopicMapException

Throws:

TopicMapException

copyFetchedTopicIn

private Topic copyFetchedTopicIn(Topic t,
                                 boolean overwrite)
                          throws TopicMapException

Throws:

TopicMapException

makeFull

public Topic makeFull(Topic t)
               throws TopicMapException

Throws:

TopicMapException

refreshTopic

public Topic refreshTopic(Topic t)
                   throws TopicMapException

Throws:

TopicMapException

topicRemoved

public void topicRemoved(Topic t)
                  throws TopicMapException

Overrides:

topicRemoved in class TopicMapImpl

Throws:

TopicMapException

_topicChanged

private void _topicChanged(Topic t)
                    throws TopicMapException

Throws:

TopicMapException

_associationChanged

private void _associationChanged(Association a)
                          throws TopicMapException

Throws:

TopicMapException

topicChanged

public void topicChanged(Topic t)
                  throws TopicMapException

Overrides:

topicChanged in class TopicMapImpl

Throws:

TopicMapException

associationChanged

public void associationChanged(Association a)
                        throws TopicMapException

Overrides:

associationChanged in class TopicMapImpl

Throws:

TopicMapException

associationRemoved

public void associationRemoved(Association a)
                        throws TopicMapException

Overrides:

associationRemoved in class TopicMapImpl

Throws:

TopicMapException

topicSubjectIdentifierChanged

public void topicSubjectIdentifierChanged(Topic t,
                                          Locator added,
                                          Locator removed)
                                   throws TopicMapException

Overrides:

topicSubjectIdentifierChanged in class TopicMapImpl

Throws:

TopicMapException

topicBaseNameChanged

public void topicBaseNameChanged(Topic t,
                                 java.lang.String newName,
                                 java.lang.String oldName)
                          throws TopicMapException

Overrides:

topicBaseNameChanged in class TopicMapImpl

Throws:

TopicMapException

topicTypeChanged

public void topicTypeChanged(Topic t,
                             Topic added,
                             Topic removed)
                      throws TopicMapException

Overrides:

topicTypeChanged in class TopicMapImpl

Throws:

TopicMapException

topicVariantChanged

public void topicVariantChanged(Topic t,
                                java.util.Collection<Topic> scope,
                                java.lang.String newName,
                                java.lang.String oldName)
                         throws TopicMapException

Overrides:

topicVariantChanged in class TopicMapImpl

Throws:

TopicMapException

topicDataChanged

public void topicDataChanged(Topic t,
                             Topic type,
                             Topic version,
                             java.lang.String newValue,
                             java.lang.String oldValue)
                      throws TopicMapException

Overrides:

topicDataChanged in class TopicMapImpl

Throws:

TopicMapException

topicSubjectLocatorChanged

public void topicSubjectLocatorChanged(Topic t,
                                       Locator newLocator,
                                       Locator oldLocator)
                                throws TopicMapException

Overrides:

topicSubjectLocatorChanged in class TopicMapImpl

Throws:

TopicMapException

associationTypeChanged

public void associationTypeChanged(Association a,
                                   Topic newType,
                                   Topic oldType)
                            throws TopicMapException

Overrides:

associationTypeChanged in class TopicMapImpl

Throws:

TopicMapException

associationPlayerChanged

public void associationPlayerChanged(Association a,
                                     Topic role,
                                     Topic newPlayer,
                                     Topic oldPlayer)
                              throws TopicMapException

Overrides:

associationPlayerChanged in class TopicMapImpl

Throws:

TopicMapException

topicsMerged

public void topicsMerged(Topic newtopic,
                         Topic deletedtopic)

Overrides:

topicsMerged in class TopicMapImpl

duplicateAssociationRemoved

public void duplicateAssociationRemoved(Association a,
                                        Association removeda)

Overrides:

duplicateAssociationRemoved in class TopicMapImpl

removeTopicData

public void removeTopicData(Topic topic,
                            Topic type,
                            Topic version)
                     throws TopicMapException

Throws:

TopicMapException

removeTopicBaseName

public void removeTopicBaseName(Topic topic)
                         throws TopicMapException

Throws:

TopicMapException

removeTopicSubjectIdentifier

public void removeTopicSubjectIdentifier(Topic topic,
                                         Locator l)
                                  throws TopicMapException

Overrides:

removeTopicSubjectIdentifier in class TopicMapImpl

Throws:

TopicMapException

removeTopicType

public void removeTopicType(Topic topic,
                            Topic type)
                     throws TopicMapException

Overrides:

removeTopicType in class TopicMapImpl

Throws:

TopicMapException

removeTopicVariant

public void removeTopicVariant(Topic topic,
                               java.util.Collection scope)
                        throws TopicMapException

Throws:

TopicMapException

setTopicData

public void setTopicData(Topic topic,
                         Topic type,
                         Topic version)
                  throws TopicMapException

Throws:

TopicMapException

setTopicSubjectLocator

public void setTopicSubjectLocator(Topic topic,
                                   Locator locator,
                                   Locator oldLocator)
                            throws TopicMapException

Overrides:

setTopicSubjectLocator in class TopicMapImpl

Throws:

TopicMapException

getAssociationsOfType

public java.util.Collection getAssociationsOfType(Topic type)
                                           throws TopicMapException

Description copied from class: TopicMap

Returns all associations in the topic map that are of the given type. Usually topic maps will either contain none or a very large number of associations of any type. Thus this method may potentially be very time consuming and require a very large amount of memory.

Overrides:

getAssociationsOfType in class TopicMapImpl

Throws:

TopicMapException

getAssociations

public java.util.Iterator getAssociations()
                                   throws TopicMapException

Description copied from class: TopicMap

Returns all associations in the topic map. The topic map may contain a very large number of associations and this operation may take a long time to finish even though it returns an iterator instead of all associations in a collection.

Overrides:

getAssociations in class TopicMapImpl

Throws:

TopicMapException

getNumAssociations

public int getNumAssociations()
                       throws TopicMapException

Description copied from class: TopicMap

Returns the number of associations in topic map. For some implementations this may be a very time consuming operation while for some it is a very simple thing to do.

Overrides:

getNumAssociations in class TopicMapImpl

Throws:

TopicMapException

getNumTopics

public int getNumTopics()
                 throws TopicMapException

Description copied from class: TopicMap

Returns the number of topics in topic map. For some implementations this may be a very time consuming operation while for some it is a very simple thing to do.

Overrides:

getNumTopics in class TopicMapImpl

Throws:

TopicMapException

getTopics

public java.util.Iterator getTopics()
                             throws TopicMapException

Description copied from class: TopicMap

Gets all topics in the topic map. The topic map may contain a very large number of topics and this operation may take a long time to finish even though it returns an iterator instead of all topics in a collection. Ideally this should return a TopicIterator with the special dispose method instead of a generic Iterator. The interface remains specifies just Iterator for backwards compatibility. See notes in TopicIterator.

Overrides:

getTopics in class TopicMapImpl

Throws:

TopicMapException

customCommand

public java.lang.String customCommand(java.lang.String command)
                               throws ServerException

Throws:

ServerException

writeTopicMapTo

public boolean writeTopicMapTo(java.io.OutputStream out)
                        throws java.io.IOException,
                               ServerException

Throws:

java.io.IOException

ServerException

saveSession

public void saveSession(Wandora parent)

getSession

public java.lang.StringBuffer getSession()

getEditedTopicMap

public TopicMap getEditedTopicMap()
                           throws TopicMapException

Throws:

TopicMapException

writelog

public void writelog(java.lang.String lvl,
                     java.lang.String msg)
              throws ServerException

Throws:

ServerException

gzip

public boolean gzip()
             throws ServerException

Throws:

ServerException

cipher

public boolean cipher()
               throws ServerException

Throws:

ServerException

login

public boolean login(java.lang.String user,
                     java.lang.String password)
              throws ServerException

Throws:

ServerException

needLogin

public boolean needLogin()
                  throws ServerException

Throws:

ServerException

close

public void close()

Description copied from class: TopicMap

Close the topic map. Free resources used by the topic map, the database connection, for example.

Overrides:

close in class TopicMapImpl

connect

public void connect()
             throws java.io.IOException

Throws:

java.io.IOException

handleServerError

public void handleServerError(java.lang.Exception e)

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

isLocal

public boolean isLocal()

isConnected

public boolean isConnected()

Description copied from class: TopicMap

Checks if this topic map is connected to the service providing the topic map. Some topic maps that are stored locally will be always connected while remotely hosted topic maps may sometime get disconnected.

Overrides:

isConnected in class TopicMap

search

public java.util.Collection<Topic> search(java.lang.String query,
                                          TopicMapSearchOptions options)

Description copied from class: TopicMap

Searches the topic map for the given string. Search options are given in a separate search options object.

Overrides:

search in class TopicMapImpl

getStatistics

public TopicMapStatData getStatistics(TopicMapStatOptions options)
                               throws TopicMapException

Overrides:

getStatistics in class TopicMapImpl

Throws:

TopicMapException

commitSession

public void commitSession(java.lang.StringBuffer session,
                          TopicMap edited)
                   throws ServerException,
                          WandoraException

Throws:

ServerException

WandoraException

rollback

public void rollback()
              throws ServerException

Throws:

ServerException

doCommit

private void doCommit()
               throws WandoraException,
                      ServerException

Throws:

WandoraException

ServerException

mergeIn

public void mergeIn()
             throws ServerException,
                    TopicMapException

Throws:

ServerException

TopicMapException

isUncommitted

public boolean isUncommitted()

commit

public void commit()
            throws WandoraException,
                   ServerException

Throws:

WandoraException

ServerException