org.tmapi.index.core
Interface TopicNamesIndex

All Superinterfaces:

Index, TopicMapSystem.ConfigurableHelperObject

public interface TopicNamesIndex

extends Index

This Index gives direct access to all TopicNames. you can get all TopicNames, or a TopicName by value

Since:

1.0

Author:

Stefan Lischke

Method Summary

java.util.Collection	getTopicNamesByType(Topic type) Retrieves the TopicNames in the indexed TopicMap whose type is defined by the specified Topic.
java.util.Collection	getTopicNamesByValue(java.lang.String value) Retrieves the TopicNames in the TopicMap which have a value equal to value The return value may be an empty Collection but must never be null.
java.util.Collection	getTopicNameTypes() Retrieves the topics in the TopicMap which define the type of one or more TopicNames.

Methods inherited from interface org.tmapi.index.Index

close, getFlags, isOpen, open, reindex

Methods inherited from interface org.tmapi.core.TopicMapSystem.ConfigurableHelperObject

configure

Method Detail

getTopicNamesByValue

public java.util.Collection getTopicNamesByValue(java.lang.String value)

Retrieves the TopicNames in the TopicMap which have a value equal to value The return value may be an empty Collection but must never be null.

Parameters:

value - of the TopicNames to be returned (MUST NOT be null)

Returns:

a Collection of TopicName instances.

getTopicNameTypes

public java.util.Collection getTopicNameTypes()

Retrieves the topics in the TopicMap which define the type of one or more TopicNames. The return value may be an empty Collection but must never be null.

Returns:

a Collection of Topic instances. If the processor does not support the XTM 1.1 model, this method MUST return an empty Collection.

getTopicNamesByType

public java.util.Collection getTopicNamesByType(Topic type)

Retrieves the TopicNames in the indexed TopicMap whose type is defined by the specified Topic. The return value may be an empty Collection but must never be null.

Parameters:

type - the type of the TopicNames to be retrieved. If type is null a collection containing all untyped TopicNames will be returned

Returns:

a Collection of TopicNames instances. If the processor does not support the XTM 1.1 model, this method MUST return an empty Collection.