org.wandora.topicmap.tmapi2wandora

Class T2WTopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

org.wandora.topicmap.tmapi2wandora.T2WTopicMap

All Implemented Interfaces:

TopicMapLogger

public class T2WTopicMap
extends TopicMap

This is a Wandora TopicMap that wraps inside it a TMAPI topic map. This is a read-only implementation, you cannot edit the TMAPI topic map through this. However, you can always create a new Wandora topic map, then merge in a TMAPI topic map using this wrapper, after which you have the same topic map in a Wandora implementation which you can then edit.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected org.tmapi.index.LiteralIndex	literalIndex
protected org.tmapi.index.ScopedIndex	scopedIndex
protected org.tmapi.core.TopicMap	tm
static java.lang.String	TOPIC_NAME_SI
static java.lang.String	TYPE_STRING_SI
protected org.tmapi.index.TypeInstanceIndex	typeIndex

Fields inherited from class org.wandora.topicmap.TopicMap

consistencyCheck, consistencyCheckWhenXTMImport, EDITTIME_SI, isReadOnly, logger, parentTopicMap

Constructor Summary

Constructors

Constructor and Description
T2WTopicMap(org.tmapi.core.TopicMap tm)

Method Summary

Modifier and Type	Method and Description
void	addTopicMapListener(TopicMapListener listener) Adds a topic map listener.
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()
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.
org.tmapi.index.LiteralIndex	getLiteralIndex()
int	getNumAssociations() Returns the number of associations in topic map.
int	getNumTopics() Returns the number of topics in topic map.
org.tmapi.index.ScopedIndex	getScopedIndex()
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.
org.tmapi.index.TypeInstanceIndex	getTypeIndex()
boolean	isTopicMapChanged() Checks if the topic map has been changed since the last call to resetTopicMapChanged.
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	setTrackDependent(boolean v) NOTE: The two trackDependent methods are mostly deprecated.
boolean	trackingDependent()
java.util.Collection<Association>	wrapAssociations(java.util.Collection<org.tmapi.core.Association> as)
java.util.Collection<Locator>	wrapLocators(java.util.Collection<org.tmapi.core.Locator> ls)
java.util.Collection<Topic>	wrapTopics(java.util.Collection<org.tmapi.core.Topic> ts)

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

TOPIC_NAME_SI

public static final java.lang.String TOPIC_NAME_SI

See Also:

Constant Field Values

TYPE_STRING_SI

public static final java.lang.String TYPE_STRING_SI

See Also:

Constant Field Values

tm

protected org.tmapi.core.TopicMap tm

typeIndex

protected org.tmapi.index.TypeInstanceIndex typeIndex

literalIndex

protected org.tmapi.index.LiteralIndex literalIndex

scopedIndex

protected org.tmapi.index.ScopedIndex scopedIndex

Constructor Detail

T2WTopicMap

public T2WTopicMap(org.tmapi.core.TopicMap tm)

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

getTypeIndex

public org.tmapi.index.TypeInstanceIndex getTypeIndex()

getLiteralIndex

public org.tmapi.index.LiteralIndex getLiteralIndex()

getScopedIndex

public org.tmapi.index.ScopedIndex getScopedIndex()

wrapTopics

public java.util.Collection<Topic> wrapTopics(java.util.Collection<org.tmapi.core.Topic> ts)

wrapAssociations

public java.util.Collection<Association> wrapAssociations(java.util.Collection<org.tmapi.core.Association> as)

wrapLocators

public java.util.Collection<Locator> wrapLocators(java.util.Collection<org.tmapi.core.Locator> ls)
                                           throws TopicMapException

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

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

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