org.wandora.topicmap.memory

Class TopicMapImpl

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.memory.TopicMapImpl

All Implemented Interfaces:

TopicMapLogger

Direct Known Subclasses:

RemoteTopicMap

public class TopicMapImpl
extends TopicMap

Author:

olli, ak

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<Association>	associations All associations in this topic map.
private java.util.Map<Topic,java.util.Collection<Association>>	associationTypeIndex Indexes associations according to their type.
private java.util.List<TopicMapListener>	disabledListeners
private static int	idCounter
private java.util.Map<java.lang.String,Topic>	idIndex Indexes topics according to their id.
private java.util.Map<java.lang.String,Topic>	nameIndex Indexes topics according to base names.
private java.util.Map<Locator,Topic>	subjectIdentifierIndex Indexes topics according to subject identifiers.
private java.util.Map<Locator,Topic>	subjectLocatorIndex Indexes topics according to subject locators.
private boolean	topicMapChanged
private static int	topicMapCounter
private int	topicMapID
private java.util.List<TopicMapListener>	topicMapListeners
private java.util.Set<Topic>	topics All topics in this topic map.
private boolean	trackDependent
private java.util.Map<Topic,java.util.Collection<Topic>>	typeIndex Indexes topics according to their type.

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
TopicMapImpl()
TopicMapImpl(java.lang.String topicmapFile) Creates a new instance of TopicMapImpl

Method Summary

Modifier and Type	Method and Description
private Association	_copyAssociationIn(Association a)
private Topic	_copyTopicIn(Topic t, boolean deep, boolean stub, java.util.Hashtable copied)
private Topic	_copyTopicIn(Topic t, boolean deep, java.util.Hashtable copied)
void	addTopicMapListener(TopicMapListener listener) Adds a topic map listener.
void	addTopicSubjectIdentifier(Topic t, Locator l)
void	addTopicType(Topic t, Topic type)
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)
void	checkAssociationConsistency(TopicMapLogger logger) Checks association consistency and fixes any inconsistencies.
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.
protected AssociationImpl	constructAssociation(Topic type)
protected TopicImpl	constructTopic()
protected TopicImpl	constructTopic(java.lang.String id)
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	duplicateAssociationRemoved(Association a, Association removeda)
void	enableAllListeners()
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.
private int	getIDCounter()
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(java.util.Collection SIs)
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	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	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.
java.util.Collection	getTypeTopics()
boolean	isTopicMapChanged() Checks if the topic map has been changed since the last call to resetTopicMapChanged.
void	mergeIn(TopicMap tm) Merges the contents of the given topic map in this topic map.
void	removeTopicMapListener(TopicMapListener listener) Removes a topic map listener.
void	removeTopicSubjectIdentifier(Topic t, Locator l)
void	removeTopicSubjectLocator(Topic t, Locator l)
void	removeTopicType(Topic t, Topic type)
boolean	resetTopicMapChanged()
java.util.Collection<Topic>	search(java.lang.String query, TopicMapSearchOptions options) Searches the topic map for the given string.
private boolean	searchMatch(java.lang.String s, java.util.regex.Pattern p)
void	setAssociationType(Association a, Topic type, Topic oldtype)
void	setTopicName(Topic t, java.lang.String name, java.lang.String oldname)
void	setTopicSubjectLocator(Topic t, Locator l, Locator oldLocator)
void	setTrackDependent(boolean v) NOTE: The two trackDependent methods are mostly deprecated.
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)
boolean	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, 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, 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

topicMapListeners

private java.util.List<TopicMapListener> topicMapListeners

disabledListeners

private java.util.List<TopicMapListener> disabledListeners

topicMapID

private int topicMapID

topicMapCounter

private static int topicMapCounter

idIndex

private java.util.Map<java.lang.String,Topic> idIndex

Indexes topics according to their id.

typeIndex

private java.util.Map<Topic,java.util.Collection<Topic>> typeIndex

Indexes topics according to their type.

subjectIdentifierIndex

private java.util.Map<Locator,Topic> subjectIdentifierIndex

Indexes topics according to subject identifiers.

subjectLocatorIndex

private java.util.Map<Locator,Topic> subjectLocatorIndex

Indexes topics according to subject locators.

nameIndex

private java.util.Map<java.lang.String,Topic> nameIndex

Indexes topics according to base names.

associationTypeIndex

private java.util.Map<Topic,java.util.Collection<Association>> associationTypeIndex

Indexes associations according to their type.

topics

private java.util.Set<Topic> topics

All topics in this topic map.

associations

private java.util.Set<Association> associations

All associations in this topic map.

trackDependent

private boolean trackDependent

topicMapChanged

private boolean topicMapChanged

idCounter

private static int idCounter

Constructor Detail

TopicMapImpl

public TopicMapImpl(java.lang.String topicmapFile)

Creates a new instance of TopicMapImpl

TopicMapImpl

public TopicMapImpl()

Method Detail

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

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

checkAssociationConsistency

public void checkAssociationConsistency(TopicMapLogger logger)
                                 throws TopicMapException

Checks association consistency and fixes any inconsistencies. Two associations are said to be inconsistent if they have the same type and same players with same roles, that is they represent the exact same association. If several such associations exist all but one of them need to be removed.

Overrides:

checkAssociationConsistency in class TopicMap

Throws:

TopicMapException

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

disableAllListeners

public void disableAllListeners()

Specified by:

disableAllListeners in class TopicMap

enableAllListeners

public void enableAllListeners()

Specified by:

enableAllListeners in class TopicMap

constructTopic

protected TopicImpl constructTopic(java.lang.String id)
                            throws TopicMapException

Throws:

TopicMapException

constructTopic

protected TopicImpl constructTopic()
                            throws TopicMapException

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

constructAssociation

protected AssociationImpl constructAssociation(Topic type)
                                        throws TopicMapException

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

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

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

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.

Specified by:

getTopicsOfType in class TopicMap

Throws:

TopicMapException

getTypeTopics

public java.util.Collection getTypeTopics()
                                   throws TopicMapException

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

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.

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

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.

Specified by:

getAssociations in class TopicMap

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.

Specified by:

getAssociationsOfType in class TopicMap

Throws:

TopicMapException

getTopic

public Topic getTopic(java.util.Collection SIs)
               throws TopicMapException

Throws:

TopicMapException

getIDCounter

private int getIDCounter()

_copyTopicIn

private Topic _copyTopicIn(Topic t,
                           boolean deep,
                           java.util.Hashtable copied)
                    throws TopicMapException

Throws:

TopicMapException

_copyTopicIn

private Topic _copyTopicIn(Topic t,
                           boolean deep,
                           boolean stub,
                           java.util.Hashtable copied)
                    throws TopicMapException

Throws:

TopicMapException

_copyAssociationIn

private Association _copyAssociationIn(Association a)
                                throws TopicMapException

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

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

mergeIn

public void mergeIn(TopicMap tm)
             throws TopicMapException

Description copied from class: TopicMap

Merges the contents of the given topic map in this topic map. At least one of mergeIn(TopicMap) or mergeIn(TopicMap,TopicMapLogger) must be overridden as they call each other in default implementation.

Overrides:

mergeIn 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

addTopicSubjectIdentifier

public void addTopicSubjectIdentifier(Topic t,
                                      Locator l)
                               throws TopicMapException

Throws:

TopicMapException

removeTopicSubjectIdentifier

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

Throws:

TopicMapException

setTopicSubjectLocator

public void setTopicSubjectLocator(Topic t,
                                   Locator l,
                                   Locator oldLocator)
                            throws TopicMapException

Throws:

TopicMapException

removeTopicSubjectLocator

public void removeTopicSubjectLocator(Topic t,
                                      Locator l)
                               throws TopicMapException

Throws:

TopicMapException

addTopicType

public void addTopicType(Topic t,
                         Topic type)
                  throws TopicMapException

Throws:

TopicMapException

removeTopicType

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

Throws:

TopicMapException

setTopicName

public void setTopicName(Topic t,
                         java.lang.String name,
                         java.lang.String oldname)
                  throws TopicMapException

Throws:

TopicMapException

setAssociationType

public void setAssociationType(Association a,
                               Topic type,
                               Topic oldtype)
                        throws TopicMapException

Throws:

TopicMapException

topicRemoved

public void topicRemoved(Topic t)
                  throws TopicMapException

Throws:

TopicMapException

associationRemoved

public void associationRemoved(Association a)
                        throws TopicMapException

Throws:

TopicMapException

topicsMerged

public void topicsMerged(Topic newtopic,
                         Topic deletedtopic)

duplicateAssociationRemoved

public void duplicateAssociationRemoved(Association a,
                                        Association removeda)

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

trackingDependent

public boolean trackingDependent()

Specified by:

trackingDependent in class TopicMap

setTrackDependent

public void setTrackDependent(boolean v)

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

topicSubjectIdentifierChanged

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

Throws:

TopicMapException

topicBaseNameChanged

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

Throws:

TopicMapException

topicTypeChanged

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

Throws:

TopicMapException

topicVariantChanged

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

Throws:

TopicMapException

topicDataChanged

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

Throws:

TopicMapException

topicSubjectLocatorChanged

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

Throws:

TopicMapException

topicChanged

public void topicChanged(Topic t)
                  throws TopicMapException

Throws:

TopicMapException

associationTypeChanged

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

Throws:

TopicMapException

associationPlayerChanged

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

Throws:

TopicMapException

associationChanged

public void associationChanged(Association a)
                        throws TopicMapException

Throws:

TopicMapException

resetTopicMapChanged

public boolean resetTopicMapChanged()

Specified by:

resetTopicMapChanged in class TopicMap

See Also:

TopicMap.isTopicMapChanged()

isTopicMapChanged

public boolean isTopicMapChanged()

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

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

searchMatch

private boolean searchMatch(java.lang.String s,
                            java.util.regex.Pattern p)

getStatistics

public TopicMapStatData getStatistics(TopicMapStatOptions options)
                               throws TopicMapException

Specified by:

getStatistics in class TopicMap

Throws:

TopicMapException