net.ontopia.topicmaps.utils.tmrap
Interface TopicIndexIF

All Superinterfaces:
IndexIF
All Known Implementing Classes:
FederatedTopicIndex, RegistryTopicIndex, RemoteTopicIndex, TopicMapTopicIndex

public interface TopicIndexIF
extends IndexIF

EXPERIMENTAL: An index through which information about topics with a particular subject can be located, irrespective of where these topics happen to be stored.


Method Summary
 void close()
          Lets go of any underlying resources used by the index.
 Collection<TopicPage> getTopicPages(Collection<LocatorIF> indicators, Collection<LocatorIF> sources, Collection<LocatorIF> subjects)
          Returns all known topic pages for the topics whose identity matches one of the locators passed as arguments.
 TopicPages getTopicPages2(Collection<LocatorIF> indicators, Collection<LocatorIF> sources, Collection<LocatorIF> subjects)
          Returns all known topic pages for the topics whose identity matches one of the locators passed as arguments.
 Collection<TopicIF> getTopics(Collection<LocatorIF> indicators, Collection<LocatorIF> sources, Collection<LocatorIF> subjects)
          Returns all topics the index knows about whose identity matches one the of the locators passed as arguments.
 Collection<TopicIF> loadRelatedTopics(Collection<LocatorIF> indicators, Collection<LocatorIF> sources, Collection<LocatorIF> subjects, boolean two_steps)
           
 

Method Detail

getTopics

Collection<TopicIF> getTopics(Collection<LocatorIF> indicators,
                              Collection<LocatorIF> sources,
                              Collection<LocatorIF> subjects)
Returns all topics the index knows about whose identity matches one the of the locators passed as arguments.

Parameters:
indicators - A collection of subject identifiers as LocatorIF objects.
sources - A collection of source locators as LocatorIF objects.
subjects - A colleciton of subject locators as LocatorIF objects.
Returns:
Collection of TopicIF

loadRelatedTopics

Collection<TopicIF> loadRelatedTopics(Collection<LocatorIF> indicators,
                                      Collection<LocatorIF> sources,
                                      Collection<LocatorIF> subjects,
                                      boolean two_steps)

getTopicPages

Collection<TopicPage> getTopicPages(Collection<LocatorIF> indicators,
                                    Collection<LocatorIF> sources,
                                    Collection<LocatorIF> subjects)
Returns all known topic pages for the topics whose identity matches one of the locators passed as arguments.

Parameters:
indicators - A collection of subject identifiers as LocatorIF objects.
sources - A collection of source locators as LocatorIF objects.
subjects - A colleciton of subject locators as LocatorIF objects.
Returns:
Collection of TopicPage

getTopicPages2

TopicPages getTopicPages2(Collection<LocatorIF> indicators,
                          Collection<LocatorIF> sources,
                          Collection<LocatorIF> subjects)
Returns all known topic pages for the topics whose identity matches one of the locators passed as arguments.

Parameters:
indicators - A collection of subject identifiers as LocatorIF objects.
sources - A collection of source locators as LocatorIF objects.
subjects - A colleciton of subject locators as LocatorIF objects.
Returns:
Collection of TopicPage

close

void close()
Lets go of any underlying resources used by the index. Must be called when used with the RDBMS backend.



Copyright © 2000-2012 Ontopia.