net.ontopia.topicmaps.entry

Interface TopicMapSourceIF

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

MTopicMapSource

All Known Implementing Classes:

AbstractOntopolyTopicMapSource, AbstractPathTopicMapSource, CTMPathTopicMapSource, DefaultTopicMapSource, LTMPathTopicMapSource, RDBMSPatternSingleTopicMapSource, RDBMSSingleTopicMapSource, RDBMSTopicMapSource, RDFPathTopicMapSource, ResourceTopicMapSource, TMXMLPathTopicMapSource, URLTopicMapSource, XTMPathTopicMapSource

public interface TopicMapSourceIF
extends AutoCloseable

PUBLIC: Topic map sources collect references to topic maps.

Method Summary

Modifier and Type	Method and Description
void	close() PUBLIC: Closes the source by releasing references it holds to e.g.
TopicMapReferenceIF	createTopicMap(String name, String baseAddressURI) PUBLIC: Creates a new topic map in the underlying source and returns a reference to the created topic map.
String	getId() PUBLIC: Gets the id of the source.
Collection<TopicMapReferenceIF>	getReferences() PUBLIC: Returns an unmodifiable collection of TopicMapReferenceIFs found by the topic map source.
String	getTitle() PUBLIC: Gets the title of the source.
void	refresh() PUBLIC: Refreshes the collection of references.
void	setId(String id) PUBLIC: Sets the id of the source.
void	setTitle(String title) PUBLIC: Sets the title of the source.
boolean	supportsCreate() PUBLIC: Returns true if the source supports creating new topic maps with the createTopicMap.
boolean	supportsDelete() PUBLIC: Returns true if the source supports deleting topic map with the TopicMapReferenceIF.delete() method.

Method Detail

getId

String getId()

PUBLIC: Gets the id of the source.

Since:

1.3.2

setId

void setId(String id)

PUBLIC: Sets the id of the source. Note that this method is intended for use when the source is used in a TopicMapRepositoryIF. The source should throw an UnsupportedOperationException if it does not support setting the id.

Since:

1.3.2

getTitle

String getTitle()

PUBLIC: Gets the title of the source.

Since:

3.0

setTitle

void setTitle(String title)

PUBLIC: Sets the title of the source.

Since:

3.0

getReferences

Collection<TopicMapReferenceIF> getReferences()

PUBLIC: Returns an unmodifiable collection of TopicMapReferenceIFs found by the topic map source.

refresh

void refresh()

PUBLIC: Refreshes the collection of references. This lets the source look at its underlying data source to reflect any changes made since the last refresh.

Since:

1.3.2

close

void close()

PUBLIC: Closes the source by releasing references it holds to e.g. database or file system objects.

Specified by:

close in interface AutoCloseable

Since:

5.3.0

supportsCreate

boolean supportsCreate()

PUBLIC: Returns true if the source supports creating new topic maps with the createTopicMap.

Since:

3.0

supportsDelete

boolean supportsDelete()

PUBLIC: Returns true if the source supports deleting topic map with the TopicMapReferenceIF.delete() method.

Since:

3.4.1

createTopicMap

TopicMapReferenceIF createTopicMap(String name,
                                   String baseAddressURI)

PUBLIC: Creates a new topic map in the underlying source and returns a reference to the created topic map. The method takes a name and the base address for the topic map to create.

Throws:

UnsupportedOperationException

Since:

3.0