org.ceryle.tm
Interface TopicMapBuilderFactory

All Known Implementing Classes:

TopicMapBuilderFactoryImpl

public interface TopicMapBuilderFactory

An interface for a factory for TopicMapBuilder objects.

Author:

Murray Altheim

Field Summary

static String

PROPERTY_BUILDER_CLASS The property name of the TopicMapBuilder implementing class.

Method Summary

TopicMapBuilder	getTopicMapBuilder(Object identifier) Returns either a new or existing TopicMapBuilder for a TMAPI TopicMap whose base URI is provided by the Object identifier, which can be a File, a URL, TMAPI Locator, String, or any Object whose toString() method returns a String that conforms to the specification of a URI.
boolean	removeTopicMapBuilder(Object identifier) Using the same identification approach as getTopicMapBuilder(Object), removes the identified TopicMapBuilder from the internal builder cache.

Field Detail

PROPERTY_BUILDER_CLASS

static final String PROPERTY_BUILDER_CLASS

The property name of the TopicMapBuilder implementing class. The value is "org.ceryle.tm.topicmapbuilder".

See Also:

Constant Field Values

Method Detail

getTopicMapBuilder

TopicMapBuilder getTopicMapBuilder(Object identifier)
                                   throws TopicMapException

Returns either a new or existing TopicMapBuilder for a TMAPI TopicMap whose base URI is provided by the Object identifier, which can be a File, a URL, TMAPI Locator, String, or any Object whose toString() method returns a String that conforms to the specification of a URI.

Reverse Lookup

This can also perform a reverse lookup: if the parameter is a TopicMap, this returns the TopicMapBuilder for it, null if it doesn't already exist. This does not create a TopicMapBuilder for an existing TopicMap.

Parameters:

identifier - the base URI of the TopicMap as a File, URL, Locator, String, or Object.

Returns:

the TopicMapBuilder used to manage the TopicMap.

Throws:

TopicMapException

removeTopicMapBuilder

boolean removeTopicMapBuilder(Object identifier)
                              throws TopicMapException

Using the same identification approach as getTopicMapBuilder(Object), removes the identified TopicMapBuilder from the internal builder cache.

Parameters:

identifier - the base URI of the TopicMap as a File, URL, Locator, String, or Object; or the TopicMap itself.

Returns:

true if the TopicMapBuilder was located and removed.

Throws:

TopicMapException