|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface is implemented by classes which provide aggregation services for TopicMapProviders. One or more TopicMapProviders may be registered with the TopicMapManager under a given id and applications may then access any of the TopicMaps handled by these TopicMapProviders.
Method Summary | |
TopicMap |
addTopicMap(TopicMapSource source,
java.lang.String providerId)
Adds a TopicMap from the given source to the given Provider |
TopicMap |
copyTopicMap(TopicMap map,
java.lang.String providerId)
Creates a copy of the TopicMap inside the given provider |
void |
deregisterProvider(java.lang.String id)
Closes the Provider with the specified id |
void |
dropTopicMap(TopicMap map)
Removes the TopicMap from the Manager and the underlaying Provider |
TopicMapProvider |
getProvider(java.lang.String id)
Returns the Provider with the specified id or throws a TopicMapProviderException if this id does not exist |
java.util.Map |
getProviders()
Returns a Map containing all registered Providers with their ids as the keys |
TopicMap |
getTopicMap(Locator baseLoc)
Gets the TopicMap generated from the resource specified by locator |
java.util.Collection |
getTopicMapBaseLocators()
Gets a collection of the base locator of all of the topic maps currently available through the registered TopicMapProviders. |
java.util.Collection |
getTopicMaps()
Gets a collection of all of the topic maps which are currently available through the registered TopicMapProviders |
void |
mergeTopicMaps(TopicMap one,
TopicMap second)
Merges the two TopicMaps |
void |
moveTopicMap(TopicMap map,
java.lang.String providerId)
Moves the TopicMap into the given Provider |
TopicMapProvider |
registerProvider(java.lang.String id,
java.lang.String providerFactoryClassName,
java.util.Properties props)
Registers a new provider with the manager. |
void |
storeTopicMap(java.io.File file,
TopicMap map)
Stores the TopicMap into the given File This method is a shortcut for using the TopicMapSerializer |
Method Detail |
public TopicMap getTopicMap(Locator baseLoc) throws TopicMapProviderException
locator
baseLoc
- The base locator of the topic map resource to be retrieved.
TopicMapProviderException
- if the underlying TopicMapProvider implementation
throws an error while accessing the specified topic map.public java.util.Collection getTopicMaps() throws TopicMapProviderException
TopicMapProviderException
- if one of the underlying TopicMapProvider implementations
throws an error while accessing the list of managed topic maps.public java.util.Collection getTopicMapBaseLocators()
public void storeTopicMap(java.io.File file, TopicMap map) throws TopicMapProcessingException
file
- the File the TopicMap is stored intomap
- the TopicMap to be stored
TopicMapProcessingException
public void mergeTopicMaps(TopicMap one, TopicMap second) throws TopicMapProviderException
one
- the TopicMap into which another TM is merged
TopicMapProviderException
public void dropTopicMap(TopicMap map) throws TopicMapProviderException
map
- the TopicMap to be removed
TopicMapProviderException
public TopicMap addTopicMap(TopicMapSource source, java.lang.String providerId) throws TopicMapProviderException
source
- providerId
-
TopicMapProviderException
public TopicMap copyTopicMap(TopicMap map, java.lang.String providerId) throws TopicMapProviderException
map
- the TopicMap to copyproviderId
- the id of the TopicMapProvider where the copy will be created
TopicMapProviderException
public void moveTopicMap(TopicMap map, java.lang.String providerId) throws TopicMapProviderException
map
- providerId
-
TopicMapProviderException
public TopicMapProvider registerProvider(java.lang.String id, java.lang.String providerFactoryClassName, java.util.Properties props) throws TopicMapProviderException
id
- the id of the new Provider to be registered underproviderFactoryClassName
- The name of the TopicMapProviderFactory
class which will create the new
TopicMapProvider.props
- The properties to be used to construct the new TopicMapProvider
TopicMapProviderException
public void deregisterProvider(java.lang.String id) throws TopicMapProviderException
id
- the id of the provider to be closed
TopicMapProviderException
- a TopicMapProviderException if the id does
not exist or in case of Problems with closing the Providerpublic TopicMapProvider getProvider(java.lang.String id) throws TopicMapProviderException
id
- the unique Id of the Provider
TopicMapProviderException
- thrown if no provider is registered for
this idpublic java.util.Map getProviders()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |