org.wandora.topicmap.undowrapper

Class UndoTopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.undowrapper.UndoTopicMap

All Implemented Interfaces:

TopicMapLogger

public class UndoTopicMap
extends TopicMap

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	UndoTopicMap.TopicMapListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.WeakHashMap<Topic,java.lang.ref.WeakReference<UndoTopic>>	topicIndex
private UndoBuffer	undoBuffer
private boolean	undoDisabled
private TopicMap	wrapped
private java.util.HashMap<TopicMapListener,UndoTopicMap.TopicMapListenerWrapper>	wrappedListeners

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
UndoTopicMap(TopicMap wrapped)
UndoTopicMap(TopicMap wrapped, boolean skipEmptyOperations)

Method Summary

Modifier and Type	Method and Description
void	addTopicMapListener(TopicMapListener listener) Adds a topic map listener.
(package private) void	addUndoOperation(UndoOperation op)
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	clearUndoBuffer()
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()
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.
boolean	getConsistencyCheck()
int	getNumAssociations() Returns the number of associations in topic map.
int	getNumTopics() Returns the number of topics in topic map.
TopicMap	getParentTopicMap() Gets the parent of this topic map.
TopicMap	getRootTopicMap() Gets the root 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.
UndoBuffer	getUndoBuffer()
TopicMap	getWrappedTopicMap()
void	handleUndoException(UndoException ue)
boolean	isConnected() Checks if this topic map is connected to the service providing the topic map.
boolean	isReadOnly() Checks if the topic map is in a read only state.
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	mergeIn(TopicMap tm, TopicMapLogger tmLogger) Merges the contents of the given topic map in this topic map.
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.
void	setConsistencyCheck(boolean value) Set consistency check of associations on or off.
void	setParentTopicMap(TopicMap parent) Sets the parent of this topic map.
void	setReadOnly(boolean readOnly) Sets the topic map in a read-only or read-write state depending on the argument.
void	setTrackDependent(boolean v) NOTE: The two trackDependent methods are mostly deprecated.
void	setUndoDisabled(boolean value)
boolean	trackingDependent()
(package private) Association	wrapAssociation(Association a)
(package private) java.util.Collection<Association>	wrapAssociations(java.util.Collection<Association> as)
(package private) UndoTopic	wrapTopic(Topic t)
(package private) java.util.ArrayList<Topic>	wrapTopics(java.util.Collection<Topic> topics)
(package private) Topic[]	wrapTopics(Topic[] topics)

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, getLogger, getMergingTopics, 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, log, log, log, makeJTMString, makeJTMTopicId, makeLTMString, makeLTMTopicId, makeSubjectIndicator, makeSubjectIndicatorAsLocator, setLogger, setLogTitle, setProgress, setProgressMax

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

private TopicMap wrapped

undoBuffer

private UndoBuffer undoBuffer

undoDisabled

private boolean undoDisabled

topicIndex

private final java.util.WeakHashMap<Topic,java.lang.ref.WeakReference<UndoTopic>> topicIndex

wrappedListeners

private java.util.HashMap<TopicMapListener,UndoTopicMap.TopicMapListenerWrapper> wrappedListeners

Constructor Detail

UndoTopicMap

public UndoTopicMap(TopicMap wrapped,
                    boolean skipEmptyOperations)

UndoTopicMap

public UndoTopicMap(TopicMap wrapped)

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

setUndoDisabled

public void setUndoDisabled(boolean value)

getUndoBuffer

public UndoBuffer getUndoBuffer()

getWrappedTopicMap

public TopicMap getWrappedTopicMap()

handleUndoException

public void handleUndoException(UndoException ue)

addUndoOperation

void addUndoOperation(UndoOperation op)

wrapTopic

UndoTopic wrapTopic(Topic t)

wrapTopics

java.util.ArrayList<Topic> wrapTopics(java.util.Collection<Topic> topics)

wrapTopics

Topic[] wrapTopics(Topic[] topics)

wrapAssociation

Association wrapAssociation(Association a)

wrapAssociations

java.util.Collection<Association> wrapAssociations(java.util.Collection<Association> as)

getParentTopicMap

public TopicMap getParentTopicMap()

Description copied from class: TopicMap

Gets the parent of this topic map. Returns null if no parent has been specified.

Overrides:

getParentTopicMap in class TopicMap

getRootTopicMap

public TopicMap getRootTopicMap()

Description copied from class: TopicMap

Gets the root topic map. This is done by iteratively getting the parent of this topic map, and the parent of that and so on until getParentTopicMap returns null.

Overrides:

getRootTopicMap in class TopicMap

setParentTopicMap

public void setParentTopicMap(TopicMap parent)

Description copied from class: TopicMap

Sets the parent of this topic map.

Overrides:

setParentTopicMap in class TopicMap

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

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

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

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

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

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

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

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

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

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

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

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

getTopicMapListeners

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

Description copied from class: TopicMap

Gets all topic map listeners.

Specified by:

getTopicMapListeners in class TopicMap

disableAllListeners

public void disableAllListeners()

Specified by:

disableAllListeners in class TopicMap

enableAllListeners

public void enableAllListeners()

Specified by:

enableAllListeners in class TopicMap

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

getStatistics

public TopicMapStatData getStatistics(TopicMapStatOptions options)
                               throws TopicMapException

Specified by:

getStatistics in class TopicMap

Throws:

TopicMapException

clearUndoBuffer

public void clearUndoBuffer()

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

checkAssociationConsistency

public void checkAssociationConsistency(TopicMapLogger logger)
                                 throws TopicMapException

Description copied from class: TopicMap

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

getConsistencyCheck

public boolean getConsistencyCheck()
                            throws TopicMapException

Overrides:

getConsistencyCheck in class TopicMap

Throws:

TopicMapException

isConnected

public boolean isConnected()
                    throws TopicMapException

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

Throws:

TopicMapException

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from class: TopicMap

Sets the topic map in a read-only or read-write state depending on the argument. If argument is true, the topic map is set read-only. Notice, some topic map implementations may support only one of the states. Topic map may not support both states.

Overrides:

setReadOnly in class TopicMap

isReadOnly

public boolean isReadOnly()

Description copied from class: TopicMap

Checks if the topic map is in a read only state. This may be because the topic map implementation only allows reading, editing requires special privileges or a method has been called to set the topic map in read only state. When a topic map is read only, all write operations throw TopicMapReadOnlyException.

Overrides:

isReadOnly in class TopicMap

setConsistencyCheck

public void setConsistencyCheck(boolean value)
                         throws TopicMapException

Description copied from class: TopicMap

Set consistency check of associations on or off. This should normally be turned on but you may turn it off before some big batch operations to speed them up. After this operation you need to turn the consistency check back on and manually call checkAssociationConsistency unless you are sure that the operation did not cause any incensistencies with associations.

Note that some implementations may not allow turning consistency check off so getConsistencyCheck may return a different value that the last parameter used for setConsistencyCheck. If turning consistency check off is not supported, then it is also not needed to manually call the checkAssociationConsistency.

Overrides:

setConsistencyCheck in class TopicMap

Throws:

TopicMapException

See Also:

TopicMap.checkAssociationConsistency(TopicMapLogger)

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

mergeIn

public void mergeIn(TopicMap tm,
                    TopicMapLogger tmLogger)
             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