org.wandora.topicmap

Class TopicMap

java.lang.Object

org.wandora.topicmap.TopicMap

All Implemented Interfaces:

TopicMapLogger

Direct Known Subclasses:

AbstractDatabaseTopicMap, ContainerTopicMap, DatabaseTopicMap, LinkedTopicMap, T2WTopicMap, TopicMapImpl, UndoTopicMap, WebServiceTopicMap

public abstract class TopicMap
extends java.lang.Object
implements TopicMapLogger

The abstract topic map class that all topic map implementations must extend. Simple primitive methods are left abstract and more complex methods have been implemented using the primitive methods. Some implementations may contain data structures that could be used to make complex methods more efficient. In this case it is advisable to override and reimplement them.

Usually any topic map implementation will also have its own topic and association implementations. The createTopic and createAssociation methods are used to create topics and associations instead of creating them with new operator.

Generally all methods that take topic or association parameters expect them to be topics or associations belonging in this topic map. This means that you can't get a topic from one topic map and then use it as a parameter of a method in some other topic map. There are a few methods where this is allowed. Most notably the copy methods that copy topics or associations from one topic map in to another and a few methods that test if two topics would merge with each other.

Author:

olli, akivela

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TopicMap.XTMParser

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	consistencyCheck
protected boolean	consistencyCheckWhenXTMImport
static java.lang.String	EDITTIME_SI
protected boolean	isReadOnly
protected TopicMapLogger	logger
protected TopicMap	parentTopicMap
private int	SICounter

Constructor Summary

Constructors

Constructor and Description
TopicMap()

Method Summary

Modifier and Type	Method and Description
abstract void	addTopicMapListener(TopicMapListener listener) Adds a topic map listener.
void	addTopicMapListeners(java.util.List<TopicMapListener> listeners)
void	checkAssociationConsistency()
void	checkAssociationConsistency(TopicMapLogger logger) Checks association consistency and fixes any inconsistencies.
abstract void	clearTopicMap() Completely clears the topic map.
abstract 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.
abstract void	close() Close the topic map.
abstract Association	copyAssociationIn(Association a) Copies an association of a different topic map in this topic map.
abstract void	copyTopicAssociationsIn(Topic t) Copies all associations of a topic of a different topic map in this topic map using copyAssociationIn.
java.util.Collection<Topic>	copyTopicCollectionIn(java.util.Collection topics, boolean deep) Like copyTopicIn but does it for a collection of topics.
abstract Topic	copyTopicIn(Topic t, boolean deep) Copies a topic of different topic map in this topic map.
abstract Association	createAssociation(Topic type) Creates a new association of the given type without any members.
Locator	createLocator(java.lang.String reference)
Locator	createLocator(java.lang.String notation, java.lang.String reference)
abstract Topic	createTopic() Creates a new topic without base name, subject identifier, data or any associations.
abstract Topic	createTopic(java.lang.String id) Creates a new topic without base name, subject identifier, data or any associations.
abstract void	disableAllListeners()
abstract void	enableAllListeners()
java.lang.String	escapeXML(java.lang.String data)
void	exportJTM(java.io.OutputStream out)
void	exportJTM(java.io.OutputStream out, TopicMapLogger logger)
void	exportJTM(java.lang.String file)
void	exportJTM(java.lang.String file, TopicMapLogger logger)
void	exportLTM(java.io.OutputStream out)
void	exportLTM(java.io.OutputStream out, TopicMapLogger logger)
void	exportLTM(java.lang.String file)
void	exportLTM(java.lang.String file, TopicMapLogger logger)
void	exportTopicMap(java.lang.String file)
void	exportTopicMap(java.lang.String file, TopicMapLogger logger)
void	exportXTM(java.io.OutputStream out)
void	exportXTM(java.io.OutputStream out, TopicMapLogger logger)
void	exportXTM(java.lang.String file)
void	exportXTM(java.lang.String file, TopicMapLogger logger)
void	exportXTM10(java.io.OutputStream out)
void	exportXTM10(java.io.OutputStream out, TopicMapLogger logger)
void	exportXTM10(java.lang.String file, TopicMapLogger logger)
void	exportXTM20(java.io.OutputStream out, TopicMapLogger logger)
void	exportXTM20(java.lang.String file)
boolean	forceStop()
abstract java.util.Iterator<Association>	getAssociations() Returns all associations in the topic map.
abstract java.util.Collection<Association>	getAssociationsOfType(Topic type) Returns all associations in the topic map that are of the given type.
boolean	getConsistencyCheck()
TopicMapLogger	getLogger()
java.util.Collection<Topic>	getMergingTopics(Topic t) Gets all topics that would merge with the given topic.
abstract int	getNumAssociations() Returns the number of associations in topic map.
abstract 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.
abstract TopicMapStatData	getStatistics(TopicMapStatOptions options)
abstract Topic	getTopic(Locator si) Gets a topic with subject identifier.
Topic	getTopic(java.lang.String si) Gets a topic with subject identifier.
abstract Topic	getTopicBySubjectLocator(Locator sl) Gets a topic with subject locator.
Topic	getTopicBySubjectLocator(java.lang.String sl) Gets a topic with subject locator.
abstract java.util.List<TopicMapListener>	getTopicMapListeners() Gets all topic map listeners.
abstract java.util.Iterator<Topic>	getTopics() Gets all topics in the topic map.
java.util.Collection<Topic>	getTopics(java.util.Collection sis) Gets topics with the subject identifiers in the collection given as parameter.
abstract Topic[]	getTopics(java.lang.String[] sis) Gets the topics whose subject identifiers are given in the array.
java.util.Collection<Topic>	getTopicsOfType(java.lang.String si) Gets all topics in the topic map that are of the given type.
abstract java.util.Collection<Topic>	getTopicsOfType(Topic type) Gets all topics in the topic map that are of the given type.
abstract Topic	getTopicWithBaseName(java.lang.String name) Gets a topic with topic base name.
void	hlog(java.lang.String message)
void	importJTM(java.io.File inFile)
void	importJTM(java.io.File inFile, TopicMapLogger logger)
void	importJTM(java.io.InputStream in)
void	importJTM(java.io.InputStream in, TopicMapLogger logger)
void	importJTM(java.lang.String file)
void	importJTM(java.lang.String fileName, TopicMapLogger logger)
void	importLTM(java.io.File inFile)
void	importLTM(java.io.File inFile, TopicMapLogger logger)
void	importLTM(java.io.InputStream in)
void	importLTM(java.io.InputStream in, TopicMapLogger logger)
void	importLTM(java.lang.String file)
void	importLTM(java.lang.String fileName, TopicMapLogger logger)
void	importTopicMap(java.lang.String file)
void	importTopicMap(java.lang.String file, TopicMapLogger logger)
void	importTopicMap(java.lang.String file, TopicMapLogger logger, boolean checkConsistency)
void	importXTM(java.io.InputStream in)
void	importXTM(java.io.InputStream in, TopicMapLogger logger)
void	importXTM(java.io.InputStream in, TopicMapLogger logger, boolean checkConsistency)
void	importXTM(java.lang.String file)
void	importXTM(java.lang.String file, TopicMapLogger logger)
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.
abstract boolean	isTopicMapChanged() Checks if the topic map has been changed since the last call to resetTopicMapChanged.
void	log(java.lang.Exception e)
void	log(java.lang.String message)
void	log(java.lang.String message, java.lang.Exception e)
java.lang.String	makeJTMString(java.lang.String str)
java.lang.String	makeJTMTopicId(Topic t)
java.lang.String	makeLTMString(java.lang.String str)
java.lang.String	makeLTMTopicId(Topic t)
java.lang.String	makeSubjectIndicator() Makes a URI that can be used as subject identifier or locator.
Locator	makeSubjectIndicatorAsLocator() Makes a Locator that can be used as subject identifier or locator.
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.
abstract void	removeTopicMapListener(TopicMapListener listener) Removes a topic map listener.
abstract boolean	resetTopicMapChanged()
abstract 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	setLogger(TopicMapLogger logger)
void	setLogTitle(java.lang.String title)
void	setParentTopicMap(TopicMap parent) Sets the parent of this topic map.
void	setProgress(int n)
void	setProgressMax(int maxn)
void	setReadOnly(boolean readOnly) Sets the topic map in a read-only or read-write state depending on the argument.
abstract void	setTrackDependent(boolean v) NOTE: The two trackDependent methods are mostly deprecated.
abstract boolean	trackingDependent()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected TopicMapLogger logger

consistencyCheck

protected boolean consistencyCheck

consistencyCheckWhenXTMImport

protected boolean consistencyCheckWhenXTMImport

isReadOnly

protected boolean isReadOnly

EDITTIME_SI

public static final java.lang.String EDITTIME_SI

See Also:

Constant Field Values

parentTopicMap

protected TopicMap parentTopicMap

SICounter

private int SICounter

Constructor Detail

TopicMap

public TopicMap()

Method Detail

createLocator

public Locator createLocator(java.lang.String reference)
                      throws TopicMapException

Throws:

TopicMapException

createLocator

public Locator createLocator(java.lang.String notation,
                             java.lang.String reference)
                      throws TopicMapException

Throws:

TopicMapException

getTopic

public abstract Topic getTopic(Locator si)
                        throws TopicMapException

Gets a topic with subject identifier.

Throws:

TopicMapException

getTopic

public Topic getTopic(java.lang.String si)
               throws TopicMapException

Gets a topic with subject identifier. Subject identifier is given as a URI reference string instead of Locator.

Throws:

TopicMapException

getTopicBySubjectLocator

public abstract Topic getTopicBySubjectLocator(Locator sl)
                                        throws TopicMapException

Gets a topic with subject locator.

Throws:

TopicMapException

getTopicBySubjectLocator

public Topic getTopicBySubjectLocator(java.lang.String sl)
                               throws TopicMapException

Gets a topic with subject locator. Subject locator is given as a URI reference string instead of Locator.

Throws:

TopicMapException

createTopic

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

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

Throws:

TopicMapException

createTopic

public abstract Topic createTopic()
                           throws TopicMapException

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

Throws:

TopicMapException

createAssociation

public abstract Association createAssociation(Topic type)
                                       throws TopicMapException

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

Throws:

TopicMapException

getTopicsOfType

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

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

Throws:

TopicMapException

getTopicWithBaseName

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

Gets a topic with topic base name.

Throws:

TopicMapException

getTopics

public abstract java.util.Iterator<Topic> getTopics()
                                             throws TopicMapException

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.

Throws:

TopicMapException

getTopics

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

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.

Throws:

TopicMapException

getAssociations

public abstract java.util.Iterator<Association> getAssociations()
                                                         throws TopicMapException

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.

Throws:

TopicMapException

getAssociationsOfType

public abstract java.util.Collection<Association> getAssociationsOfType(Topic type)
                                                                 throws TopicMapException

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.

Throws:

TopicMapException

getNumTopics

public abstract int getNumTopics()
                          throws TopicMapException

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.

Throws:

TopicMapException

getNumAssociations

public abstract int getNumAssociations()
                                throws TopicMapException

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.

Throws:

TopicMapException

copyTopicIn

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

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.

Throws:

TopicMapException

copyAssociationIn

public abstract Association copyAssociationIn(Association a)
                                       throws TopicMapException

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.

Throws:

TopicMapException

copyTopicAssociationsIn

public abstract void copyTopicAssociationsIn(Topic t)
                                      throws TopicMapException

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

Throws:

TopicMapException

mergeIn

public void mergeIn(TopicMap tm)
             throws TopicMapException

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.

Throws:

TopicMapException

mergeIn

public void mergeIn(TopicMap tm,
                    TopicMapLogger tmLogger)
             throws TopicMapException

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.

Throws:

TopicMapException

setTrackDependent

public abstract void setTrackDependent(boolean v)
                                throws TopicMapException

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.

Throws:

TopicMapException

trackingDependent

public abstract boolean trackingDependent()
                                   throws TopicMapException

Throws:

TopicMapException

addTopicMapListener

public abstract void addTopicMapListener(TopicMapListener listener)

Adds a topic map listener.

removeTopicMapListener

public abstract void removeTopicMapListener(TopicMapListener listener)

Removes a topic map listener.

getTopicMapListeners

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

Gets all topic map listeners.

addTopicMapListeners

public void addTopicMapListeners(java.util.List<TopicMapListener> listeners)

disableAllListeners

public abstract void disableAllListeners()

enableAllListeners

public abstract void enableAllListeners()

isTopicMapChanged

public abstract boolean isTopicMapChanged()
                                   throws TopicMapException

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

Throws:

TopicMapException

resetTopicMapChanged

public abstract boolean resetTopicMapChanged()
                                      throws TopicMapException

Throws:

TopicMapException

See Also:

isTopicMapChanged()

search

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

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

Throws:

TopicMapException

getStatistics

public abstract TopicMapStatData getStatistics(TopicMapStatOptions options)
                                        throws TopicMapException

Throws:

TopicMapException

clearTopicMap

public abstract void clearTopicMap()
                            throws TopicMapException

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

Throws:

TopicMapException

clearTopicMapIndexes

public abstract void clearTopicMapIndexes()
                                   throws TopicMapException

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

Throws:

TopicMapException

isReadOnly

public boolean isReadOnly()

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.

setReadOnly

public void setReadOnly(boolean readOnly)

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.

setConsistencyCheck

public void setConsistencyCheck(boolean value)
                         throws TopicMapException

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.

Throws:

TopicMapException

See Also:

checkAssociationConsistency(TopicMapLogger)

getConsistencyCheck

public boolean getConsistencyCheck()
                            throws TopicMapException

Throws:

TopicMapException

checkAssociationConsistency

public void checkAssociationConsistency()
                                 throws TopicMapException

Throws:

TopicMapException

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.

Throws:

TopicMapException

setParentTopicMap

public void setParentTopicMap(TopicMap parent)

Sets the parent of this topic map.

getParentTopicMap

public TopicMap getParentTopicMap()

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

getRootTopicMap

public TopicMap getRootTopicMap()

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.

isConnected

public boolean isConnected()
                    throws TopicMapException

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.

Throws:

TopicMapException

close

public abstract void close()

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

getTopics

public java.util.Collection<Topic> getTopics(java.util.Collection sis)
                                      throws TopicMapException

Gets topics with the subject identifiers in the collection given as parameter. The parameter collection may contain subject identifiers as strings or locators or a mix of both. Returned collection will contain each topic found with. Note that parameter collection and returned collection may be of different size. This can happen when some subject identifiers don't match any topics or some topic matches several of the subject identifiers. Topics in the returned collection are not ordered in any way and it will contain each topic only once.

Throws:

TopicMapException

getTopicsOfType

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

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.

Throws:

TopicMapException

copyTopicCollectionIn

public java.util.Collection<Topic> copyTopicCollectionIn(java.util.Collection topics,
                                                         boolean deep)
                                                  throws TopicMapException

Like copyTopicIn but does it for a collection of topics.

Throws:

TopicMapException

getMergingTopics

public java.util.Collection<Topic> getMergingTopics(Topic t)
                                             throws TopicMapException

Gets all topics that would merge with the given topic. Note that usually the topic given as a parameter will be a topic in a different topic map because for any topic in this topic map you will get a result containing only the topic you gave as a parameter.

Throws:

TopicMapException

setLogger

public void setLogger(TopicMapLogger logger)

getLogger

public TopicMapLogger getLogger()

hlog

public void hlog(java.lang.String message)

Specified by:

hlog in interface TopicMapLogger

log

public void log(java.lang.String message)

Specified by:

log in interface TopicMapLogger

log

public void log(java.lang.String message,
                java.lang.Exception e)

Specified by:

log in interface TopicMapLogger

log

public void log(java.lang.Exception e)

Specified by:

log in interface TopicMapLogger

setProgress

public void setProgress(int n)

Specified by:

setProgress in interface TopicMapLogger

setProgressMax

public void setProgressMax(int maxn)

Specified by:

setProgressMax in interface TopicMapLogger

setLogTitle

public void setLogTitle(java.lang.String title)

Specified by:

setLogTitle in interface TopicMapLogger

forceStop

public boolean forceStop()

Specified by:

forceStop in interface TopicMapLogger

importTopicMap

public void importTopicMap(java.lang.String file)
                    throws java.io.IOException,
                           TopicMapException

Throws:

java.io.IOException

TopicMapException

importTopicMap

public void importTopicMap(java.lang.String file,
                           TopicMapLogger logger)
                    throws java.io.IOException,
                           TopicMapException

Throws:

java.io.IOException

TopicMapException

importTopicMap

public void importTopicMap(java.lang.String file,
                           TopicMapLogger logger,
                           boolean checkConsistency)
                    throws java.io.IOException,
                           TopicMapException

Throws:

java.io.IOException

TopicMapException

exportTopicMap

public void exportTopicMap(java.lang.String file)
                    throws java.io.IOException,
                           TopicMapException

Throws:

java.io.IOException

TopicMapException

exportTopicMap

public void exportTopicMap(java.lang.String file,
                           TopicMapLogger logger)
                    throws java.io.IOException,
                           TopicMapException

Throws:

java.io.IOException

TopicMapException

exportLTM

public void exportLTM(java.lang.String file)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportLTM

public void exportLTM(java.lang.String file,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportLTM

public void exportLTM(java.io.OutputStream out)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportLTM

public void exportLTM(java.io.OutputStream out,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

makeLTMString

public java.lang.String makeLTMString(java.lang.String str)

makeLTMTopicId

public java.lang.String makeLTMTopicId(Topic t)

importLTM

public void importLTM(java.io.InputStream in)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importLTM

public void importLTM(java.io.File inFile)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importLTM

public void importLTM(java.lang.String file)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importLTM

public void importLTM(java.io.InputStream in,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importLTM

public void importLTM(java.io.File inFile,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importLTM

public void importLTM(java.lang.String fileName,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportJTM

public void exportJTM(java.lang.String file)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportJTM

public void exportJTM(java.lang.String file,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportJTM

public void exportJTM(java.io.OutputStream out)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportJTM

public void exportJTM(java.io.OutputStream out,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

makeJTMString

public java.lang.String makeJTMString(java.lang.String str)

makeJTMTopicId

public java.lang.String makeJTMTopicId(Topic t)

importJTM

public void importJTM(java.io.InputStream in)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importJTM

public void importJTM(java.io.File inFile)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importJTM

public void importJTM(java.lang.String file)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importJTM

public void importJTM(java.io.InputStream in,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importJTM

public void importJTM(java.io.File inFile,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importJTM

public void importJTM(java.lang.String fileName,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM

public void exportXTM(java.io.OutputStream out)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM

public void exportXTM(java.io.OutputStream out,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM10

public void exportXTM10(java.io.OutputStream out)
                 throws java.io.IOException,
                        TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM10

public void exportXTM10(java.io.OutputStream out,
                        TopicMapLogger logger)
                 throws java.io.IOException,
                        TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM20

public void exportXTM20(java.io.OutputStream out,
                        TopicMapLogger logger)
                 throws java.io.IOException,
                        TopicMapException

Throws:

java.io.IOException

TopicMapException

importXTM

public void importXTM(java.io.InputStream in)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importXTM

public void importXTM(java.io.InputStream in,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importXTM

public void importXTM(java.io.InputStream in,
                      TopicMapLogger logger,
                      boolean checkConsistency)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importXTM

public void importXTM(java.lang.String file,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

importXTM

public void importXTM(java.lang.String file)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM

public void exportXTM(java.lang.String file)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM20

public void exportXTM20(java.lang.String file)
                 throws java.io.IOException,
                        TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM

public void exportXTM(java.lang.String file,
                      TopicMapLogger logger)
               throws java.io.IOException,
                      TopicMapException

Throws:

java.io.IOException

TopicMapException

exportXTM10

public void exportXTM10(java.lang.String file,
                        TopicMapLogger logger)
                 throws java.io.IOException,
                        TopicMapException

Throws:

java.io.IOException

TopicMapException

makeSubjectIndicatorAsLocator

public Locator makeSubjectIndicatorAsLocator()
                                      throws TopicMapException

Makes a Locator that can be used as subject identifier or locator. The locator is guaranteed to be unique and will not cause merges with other topics in this topic map.

Throws:

TopicMapException

makeSubjectIndicator

public java.lang.String makeSubjectIndicator()

Makes a URI that can be used as subject identifier or locator. The URI is guaranteed to be unique and will not cause merges with other topics in this topic map.

escapeXML

public java.lang.String escapeXML(java.lang.String data)