org.tmapi.index.core
Interface TopicMapObjectsIndex

All Superinterfaces:

Index, TopicMapSystem.ConfigurableHelperObject

public interface TopicMapObjectsIndex

extends Index

An index of all TopicMapObject instances in the TopicMap by the value(s) of their sourceLocator property.

Method Summary

TopicMapObject

getTopicMapObjectBySourceLocator(Locator sourceLocator) Returns the TopicMapObject with the specified locator as one of its source locators.

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

getTopicMapObjectBySourceLocator

public TopicMapObject getTopicMapObjectBySourceLocator(Locator sourceLocator)

Returns the TopicMapObject with the specified locator as one of its source locators.

Parameters:

sourceLocator - the source locator of the object to be returned (MUST NOT be null)

Returns:

the TopicMapObject with the specified source locator or null if no such object exists in the indexed TopicMap.