org.tm4j.tmapi.core
Class TMAPITopicMapSystemImpl

java.lang.Object
  extended byorg.tm4j.tmapi.core.TMAPITopicMapSystemImpl
All Implemented Interfaces:
org.tmapi.core.TopicMapSystem

public class TMAPITopicMapSystemImpl
extends java.lang.Object
implements org.tmapi.core.TopicMapSystem


Nested Class Summary
 
Nested classes inherited from class org.tmapi.core.TopicMapSystem
org.tmapi.core.TopicMapSystem.ConfigurableHelperObject
 
Field Summary
static java.lang.String DEFAULT_PROVIDER
           
static java.lang.String PROVIDER_KEY
           
 
Constructor Summary
TMAPITopicMapSystemImpl(java.lang.String providerFactoryClass, java.util.Properties initProps, java.util.Map features)
          Creates a new TopicMapSystem which will add newly created topic maps to a new TopicMapProvider which will be created using an instance of the the provider factory class specified by providerFactoryClass.
 
Method Summary
 void close()
           
 org.tmapi.core.TopicMap createTopicMap(java.lang.String baseLocatorAddress)
           
 org.tmapi.core.TopicMap createTopicMap(java.lang.String baseLocatorNotation, java.lang.String baseLocatorAddress)
           
 java.util.Set getBaseLocators()
           
 boolean getFeature(java.lang.String featureName)
           
 java.lang.String getProperty(java.lang.String propertyName)
           
 org.tmapi.core.TopicMap getTopicMap(org.tmapi.core.Locator baseLoc)
           
 org.tmapi.core.TopicMap getTopicMap(java.lang.String baseLocatorAddress)
           
 org.tmapi.core.TopicMap getTopicMap(java.lang.String baseLocatorNotation, java.lang.String baseLocatorAddress)
           
 TopicMapProvider getTopicMapProvider()
          Returns the underlying TM4J TopicMapProvider which is encapsulated by the TopicMapSystem.
 java.util.Map getTopicMaps()
           
 void setProperties(java.util.Properties props)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_PROVIDER

public static final java.lang.String DEFAULT_PROVIDER
See Also:
Constant Field Values

PROVIDER_KEY

public static final java.lang.String PROVIDER_KEY
See Also:
Constant Field Values
Constructor Detail

TMAPITopicMapSystemImpl

public TMAPITopicMapSystemImpl(java.lang.String providerFactoryClass,
                               java.util.Properties initProps,
                               java.util.Map features)
Creates a new TopicMapSystem which will add newly created topic maps to a new TopicMapProvider which will be created using an instance of the the provider factory class specified by providerFactoryClass.

Parameters:
providerFactoryClass - the Java class name of the TopicMapProviderFactory class to instantiate and use for the creation of the provider.
initProps - properties used to initialise the provider.
Method Detail

createTopicMap

public org.tmapi.core.TopicMap createTopicMap(java.lang.String baseLocatorAddress)
Specified by:
createTopicMap in interface org.tmapi.core.TopicMapSystem

createTopicMap

public org.tmapi.core.TopicMap createTopicMap(java.lang.String baseLocatorNotation,
                                              java.lang.String baseLocatorAddress)
Specified by:
createTopicMap in interface org.tmapi.core.TopicMapSystem

getTopicMap

public org.tmapi.core.TopicMap getTopicMap(java.lang.String baseLocatorAddress)
Specified by:
getTopicMap in interface org.tmapi.core.TopicMapSystem

getTopicMap

public org.tmapi.core.TopicMap getTopicMap(java.lang.String baseLocatorNotation,
                                           java.lang.String baseLocatorAddress)
Specified by:
getTopicMap in interface org.tmapi.core.TopicMapSystem

getTopicMaps

public java.util.Map getTopicMaps()

setProperties

public void setProperties(java.util.Properties props)

getTopicMapProvider

public TopicMapProvider getTopicMapProvider()
Returns the underlying TM4J TopicMapProvider which is encapsulated by the TopicMapSystem. Currently, using the TopicMapProvider interface is the only way to load a topic map from an XTM file.

Note:When TMAPI supports parsing of topic map file formats, this method will be deprecated and then removed.

Returns:
the underlying TopicMapProvider

getFeature

public boolean getFeature(java.lang.String featureName)
                   throws org.tmapi.core.FeatureNotRecognizedException
Specified by:
getFeature in interface org.tmapi.core.TopicMapSystem
Throws:
org.tmapi.core.FeatureNotRecognizedException

getProperty

public java.lang.String getProperty(java.lang.String propertyName)
Specified by:
getProperty in interface org.tmapi.core.TopicMapSystem

getTopicMap

public org.tmapi.core.TopicMap getTopicMap(org.tmapi.core.Locator baseLoc)
Specified by:
getTopicMap in interface org.tmapi.core.TopicMapSystem

getBaseLocators

public java.util.Set getBaseLocators()
Specified by:
getBaseLocators in interface org.tmapi.core.TopicMapSystem

close

public void close()
Specified by:
close in interface org.tmapi.core.TopicMapSystem