org.wandora.topicmap.linked

Class LinkedTopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.linked.LinkedTopicMap

All Implemented Interfaces:

ContainerTopicMapListener, TopicMapListener, TopicMapLogger

public class LinkedTopicMap
extends TopicMap
implements TopicMapListener, ContainerTopicMapListener

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected Layer	linkedLayer
protected TopicMap	linkedMap
protected java.util.ArrayList<TopicMapListener>	topicMapListeners
protected ContainerTopicMap	wrappedContainer
protected java.lang.String	wrappedName

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
LinkedTopicMap(java.lang.String wrappedName)
LinkedTopicMap(TopicMap linkedMap)

Method Summary

Modifier and Type	Method and Description
void	addTopicMapListener(TopicMapListener listener) Adds a topic map listener.
void	associationChanged(Association a) A notification used to report general or large changes in association.
void	associationPlayerChanged(Association a, Topic role, Topic newPlayer, Topic oldPlayer) A notification that a player in an association with a certain role has been changed.
void	associationRemoved(Association a) A notification that an association has been completely removed.
void	associationTypeChanged(Association a, Topic newType, Topic oldType) A notification that association type has changed.
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.
Association	copyAssociationIn(Association a) Copies an association of a different topic map in this topic map.
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.
Topic	createTopic(java.lang.String id) Creates a new topic without base name, subject identifier, data or any associations.
void	disableAllListeners()
void	enableAllListeners()
protected boolean	findLinkedMap()
java.util.Iterator<Association>	getAssociations() Returns all associations in the topic map.
java.util.Collection<Association>	getAssociationsOfType(Topic type) Returns all associations in the topic map that are of the given type.
LinkedAssociation	getLinkedAssociation(Association a)
java.util.Collection<Association>	getLinkedAssociations(java.util.Collection<Association> associations)
LinkedTopic	getLinkedTopic(Topic t)
TopicMap	getLinkedTopicMap()
java.util.Collection<Topic>	getLinkedTopics(java.util.Collection<Topic> topics)
java.util.Set<Topic>	getLinkedTopics(java.util.Set<Topic> topics)
int	getNumAssociations() Returns the number of associations in topic map.
int	getNumTopics() Returns the number of topics in topic map.
TopicMapStatData	getStatistics(TopicMapStatOptions options)
Topic	getTopic(Locator si) Gets a topic with subject identifier.
Topic	getTopicBySubjectLocator(Locator sl) Gets a topic with subject locator.
java.util.List<TopicMapListener>	getTopicMapListeners() Gets all topic map listeners.
java.util.Iterator<Topic>	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.
java.util.Collection<Topic>	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.
Association	getUnlinkedAssociation(Association a)
java.util.Collection<Association>	getUnlinkedAssociations(java.util.Collection<Association> associations)
java.util.Set<Topic>	getUnlinkedSetOfTopics(java.util.Set<Topic> topics)
Topic	getUnlinkedTopic(Topic t)
java.util.Collection<Topic>	getUnlinkedTopics(java.util.Collection<Topic> topics)
boolean	isTopicMapChanged() Checks if the topic map has been changed since the last call to resetTopicMapChanged.
void	layerAdded(Layer l)
void	layerChanged(Layer oldLayer, Layer newLayer)
void	layerRemoved(Layer l)
void	layerStructureChanged()
void	layerVisibilityChanged(Layer l)
void	removeTopicMapListener(TopicMapListener listener) Removes a topic map listener.
boolean	resetTopicMapChanged()
java.util.Collection<Topic>	search(java.lang.String query, TopicMapSearchOptions options) Searches the topic map for the given string.
protected void	setLinkedMap(Layer l)
protected void	setLinkedMap(TopicMap tm)
void	setTrackDependent(boolean v) NOTE: The two trackDependent methods are mostly deprecated.
void	topicBaseNameChanged(Topic t, java.lang.String newName, java.lang.String oldName) Notification that the base name has been changed.
void	topicChanged(Topic t) A notification used to report general or large changes in topic, for example when topics are merged.
void	topicDataChanged(Topic t, Topic type, Topic version, java.lang.String newValue, java.lang.String oldValue) Notification that topic occurrence has been changed.
void	topicRemoved(Topic t) Notification that a topic has been completely removed.
void	topicSubjectIdentifierChanged(Topic t, Locator added, Locator removed) Notification that a subject identifier has changed.
void	topicSubjectLocatorChanged(Topic t, Locator newLocator, Locator oldLocator) Notification that the subject locator has been changed.
void	topicTypeChanged(Topic t, Topic added, Topic removed) Notification that a topic type has changed.
void	topicVariantChanged(Topic t, java.util.Collection<Topic> scope, java.lang.String newName, java.lang.String oldName) Notification that a variant name has been changed.
boolean	trackingDependent()
protected void	unlinkMap()

Methods inherited from class org.wandora.topicmap.TopicMap

addTopicMapListeners, checkAssociationConsistency, 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, getTopicsOfType, hlog, importJTM, importJTM, importJTM, importJTM, importJTM, importJTM, importLTM, importLTM, importLTM, importLTM, importLTM, importLTM, importTopicMap, importTopicMap, importTopicMap, importXTM, importXTM, importXTM, importXTM, importXTM, isConnected, isReadOnly, log, log, log, makeJTMString, makeJTMTopicId, makeLTMString, makeLTMTopicId, makeSubjectIndicator, makeSubjectIndicatorAsLocator, mergeIn, 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

linkedMap

protected TopicMap linkedMap

linkedLayer

protected Layer linkedLayer

wrappedContainer

protected ContainerTopicMap wrappedContainer

topicMapListeners

protected java.util.ArrayList<TopicMapListener> topicMapListeners

wrappedName

protected java.lang.String wrappedName

Constructor Detail

LinkedTopicMap

public LinkedTopicMap(TopicMap linkedMap)

LinkedTopicMap

public LinkedTopicMap(java.lang.String wrappedName)

Method Detail

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.

Specified by:

close in class TopicMap

getLinkedTopicMap

public TopicMap getLinkedTopicMap()

unlinkMap

protected void unlinkMap()

setLinkedMap

protected void setLinkedMap(Layer l)

setLinkedMap

protected void setLinkedMap(TopicMap tm)

findLinkedMap

protected boolean findLinkedMap()

getLinkedTopic

public LinkedTopic getLinkedTopic(Topic t)

getLinkedAssociation

public LinkedAssociation getLinkedAssociation(Association a)

getLinkedTopics

public java.util.Collection<Topic> getLinkedTopics(java.util.Collection<Topic> topics)

getLinkedTopics

public java.util.Set<Topic> getLinkedTopics(java.util.Set<Topic> topics)

getLinkedAssociations

public java.util.Collection<Association> getLinkedAssociations(java.util.Collection<Association> associations)

getUnlinkedTopic

public Topic getUnlinkedTopic(Topic t)

getUnlinkedAssociation

public Association getUnlinkedAssociation(Association a)

getUnlinkedTopics

public java.util.Collection<Topic> getUnlinkedTopics(java.util.Collection<Topic> topics)

getUnlinkedSetOfTopics

public java.util.Set<Topic> getUnlinkedSetOfTopics(java.util.Set<Topic> topics)

getUnlinkedAssociations

public java.util.Collection<Association> getUnlinkedAssociations(java.util.Collection<Association> associations)

getTopicMapListeners

public java.util.List<TopicMapListener> getTopicMapListeners()

Description copied from class: TopicMap

Gets all topic map listeners.

Specified by:

getTopicMapListeners in class TopicMap

addTopicMapListener

public void addTopicMapListener(TopicMapListener listener)

Description copied from class: TopicMap

Adds a topic map listener.

Specified by:

addTopicMapListener in class TopicMap

removeTopicMapListener

public void removeTopicMapListener(TopicMapListener listener)

Description copied from class: TopicMap

Removes a topic map listener.

Specified by:

removeTopicMapListener in class TopicMap

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.

Specified by:

clearTopicMap in class TopicMap

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?)

Specified by:

clearTopicMapIndexes in class TopicMap

Throws:

TopicMapException

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.

Specified by:

copyAssociationIn in class TopicMap

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.

Specified by:

copyTopicAssociationsIn in class TopicMap

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.

Specified by:

copyTopicIn in class TopicMap

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.

Specified by:

createAssociation in class TopicMap

Throws:

TopicMapException

createTopic

public Topic createTopic(java.lang.String id)
                  throws TopicMapException

Description copied from class: TopicMap

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

Specified by:

createTopic in class TopicMap

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.

Specified by:

createTopic in class TopicMap

Throws:

TopicMapException

disableAllListeners

public void disableAllListeners()

Specified by:

disableAllListeners in class TopicMap

enableAllListeners

public void enableAllListeners()

Specified by:

enableAllListeners in class TopicMap

getAssociations

public java.util.Iterator<Association> 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.

Specified by:

getAssociations in class TopicMap

Throws:

TopicMapException

getAssociationsOfType

public java.util.Collection<Association> 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.

Specified by:

getAssociationsOfType in class TopicMap

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.

Specified by:

getNumAssociations in class TopicMap

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.

Specified by:

getNumTopics in class TopicMap

Throws:

TopicMapException

getStatistics

public TopicMapStatData getStatistics(TopicMapStatOptions options)
                               throws TopicMapException

Specified by:

getStatistics in class TopicMap

Throws:

TopicMapException

getTopic

public Topic getTopic(Locator si)
               throws TopicMapException

Description copied from class: TopicMap

Gets a topic with subject identifier.

Specified by:

getTopic in class TopicMap

Throws:

TopicMapException

getTopicBySubjectLocator

public Topic getTopicBySubjectLocator(Locator sl)
                               throws TopicMapException

Description copied from class: TopicMap

Gets a topic with subject locator.

Specified by:

getTopicBySubjectLocator in class TopicMap

Throws:

TopicMapException

getTopicWithBaseName

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

Description copied from class: TopicMap

Gets a topic with topic base name.

Specified by:

getTopicWithBaseName in class TopicMap

Throws:

TopicMapException

getTopics

public java.util.Iterator<Topic> 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.

Specified by:

getTopics in class TopicMap

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.

Specified by:

getTopics in class TopicMap

Throws:

TopicMapException

getTopicsOfType

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

Description copied from class: TopicMap

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

Specified by:

getTopicsOfType in class TopicMap

Throws:

TopicMapException

isTopicMapChanged

public boolean isTopicMapChanged()
                          throws TopicMapException

Description copied from class: TopicMap

Checks if the topic map has been changed since the last call to resetTopicMapChanged.

Specified by:

isTopicMapChanged in class TopicMap

Throws:

TopicMapException

resetTopicMapChanged

public boolean resetTopicMapChanged()
                             throws TopicMapException

Specified by:

resetTopicMapChanged in class TopicMap

Throws:

TopicMapException

See Also:

TopicMap.isTopicMapChanged()

search

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

Description copied from class: TopicMap

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

Specified by:

search in class TopicMap

Throws:

TopicMapException

setTrackDependent

public void setTrackDependent(boolean v)
                       throws TopicMapException

Description copied from class: TopicMap

NOTE: The two trackDependent methods are mostly deprecated. They are used when caching html pages from topics to decide when cached pages need to be refreshed. A page needs to be updated when any topic visible in the page is changed.

Specified by:

setTrackDependent in class TopicMap

Throws:

TopicMapException

trackingDependent

public boolean trackingDependent()
                          throws TopicMapException

Specified by:

trackingDependent in class TopicMap

Throws:

TopicMapException

associationChanged

public void associationChanged(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in association. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

associationChanged in interface TopicMapListener

Throws:

TopicMapException

associationPlayerChanged

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

Description copied from interface: TopicMapListener

A notification that a player in an association with a certain role has been changed. Either newPlayer or oldPlayer can be null to indicate that the no new player for the role was set or that there was no player with the role previously. Both can also be non-null to indicate that the player of the role changed.

Specified by:

associationPlayerChanged in interface TopicMapListener

Throws:

TopicMapException

associationRemoved

public void associationRemoved(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification that an association has been completely removed.

Specified by:

associationRemoved in interface TopicMapListener

Throws:

TopicMapException

associationTypeChanged

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

Description copied from interface: TopicMapListener

A notification that association type has changed. Either newType or oldType can be null to indicate that old or new type was null. When type is changed from one topic to another, both will be non-null.

Specified by:

associationTypeChanged in interface TopicMapListener

Throws:

TopicMapException

topicBaseNameChanged

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

Description copied from interface: TopicMapListener

Notification that the base name has been changed. Either newName or oldName may be null indicating that base name was removed or old name was empty.

Specified by:

topicBaseNameChanged in interface TopicMapListener

Throws:

TopicMapException

topicChanged

public void topicChanged(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in topic, for example when topics are merged. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

topicChanged in interface TopicMapListener

Throws:

TopicMapException

topicDataChanged

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

Description copied from interface: TopicMapListener

Notification that topic occurrence has been changed. Either newValue or oldValue may be null indicating that the occurrence was removed or old value was empty.

Specified by:

topicDataChanged in interface TopicMapListener

Throws:

TopicMapException

topicRemoved

public void topicRemoved(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic has been completely removed.

Specified by:

topicRemoved in interface TopicMapListener

Throws:

TopicMapException

topicSubjectIdentifierChanged

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

Description copied from interface: TopicMapListener

Notification that a subject identifier has changed. Either added or removed is non-null and indicates that a subject identifier has been added or removed, respectively. The non-null parameter contains the new subject identifier or the removed subject identifier.

Specified by:

topicSubjectIdentifierChanged in interface TopicMapListener

Throws:

TopicMapException

topicSubjectLocatorChanged

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

Description copied from interface: TopicMapListener

Notification that the subject locator has been changed. Either newLocator or oldLocator may be null indicating that locator was removed or there was no old locator.

Specified by:

topicSubjectLocatorChanged in interface TopicMapListener

Throws:

TopicMapException

topicTypeChanged

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

Description copied from interface: TopicMapListener

Notification that a topic type has changed. Either added or removed is non-null and indicates that a type has been added or removed, respectively. The non-null parameter contains the new type or the removed type.

Specified by:

topicTypeChanged in interface TopicMapListener

Throws:

TopicMapException

topicVariantChanged

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

Description copied from interface: TopicMapListener

Notification that a variant name has been changed. Either newName or oldName may be null indicating that the variant name was removed or old name was empty.

Specified by:

topicVariantChanged in interface TopicMapListener

Throws:

TopicMapException

layerAdded

public void layerAdded(Layer l)

Specified by:

layerAdded in interface ContainerTopicMapListener

layerChanged

public void layerChanged(Layer oldLayer,
                         Layer newLayer)

Specified by:

layerChanged in interface ContainerTopicMapListener

layerRemoved

public void layerRemoved(Layer l)

Specified by:

layerRemoved in interface ContainerTopicMapListener

layerStructureChanged

public void layerStructureChanged()

Specified by:

layerStructureChanged in interface ContainerTopicMapListener

layerVisibilityChanged

public void layerVisibilityChanged(Layer l)

Specified by:

layerVisibilityChanged in interface ContainerTopicMapListener