Package net.ontopia.topicmaps.utils.tmrap

Class TopicMapTopicIndex

java.lang.Object

net.ontopia.topicmaps.utils.tmrap.TopicMapTopicIndex

All Implemented Interfaces:

IndexIF, TopicIndexIF

public class TopicMapTopicIndex
extends Object
implements TopicIndexIF

EXPERIMENTAL: An implementation that looks up topics in all the given topic map.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	editBaseuri
protected String	tmid
protected TopicMapIF	topicmap
protected String	viewBaseuri

Constructor Summary

Constructors

Constructor	Description
TopicMapTopicIndex(TopicMapIF topicmap, String editBaseuri, String viewBaseuri, String tmid)

Method Summary

Modifier and Type	Method	Description
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_step)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

topicmap

protected TopicMapIF topicmap

editBaseuri

protected String editBaseuri

viewBaseuri

protected String viewBaseuri

tmid

protected String tmid

Constructor Detail

TopicMapTopicIndex

public TopicMapTopicIndex(TopicMapIF topicmap,
                          String editBaseuri,
                          String viewBaseuri,
                          String tmid)

Parameters:

editBaseuri - a URL of the form http://whatever/omnigator/stuff.jsp?tmid=%tmid%&id=%topicid% Note that the %key% tokens are used to build the correct URI.

Method Detail

getTopics

public Collection<TopicIF> getTopics(Collection<LocatorIF> indicators,
                                     Collection<LocatorIF> sources,
                                     Collection<LocatorIF> subjects)

Description copied from interface: TopicIndexIF

Returns all topics the index knows about whose identity matches one the of the locators passed as arguments.

Specified by:

getTopics in interface TopicIndexIF

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

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

Specified by:

loadRelatedTopics in interface TopicIndexIF

getTopicPages

public Collection<TopicPage> getTopicPages(Collection<LocatorIF> indicators,
                                           Collection<LocatorIF> sources,
                                           Collection<LocatorIF> subjects)

Description copied from interface: TopicIndexIF

Returns all known topic pages for the topics whose identity matches one of the locators passed as arguments.

Specified by:

getTopicPages in interface TopicIndexIF

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

public TopicPages getTopicPages2(Collection<LocatorIF> indicators,
                                 Collection<LocatorIF> sources,
                                 Collection<LocatorIF> subjects)

Description copied from interface: TopicIndexIF

Returns all known topic pages for the topics whose identity matches one of the locators passed as arguments.

Specified by:

getTopicPages2 in interface TopicIndexIF

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

public void close()

Description copied from interface: TopicIndexIF

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

Specified by:

close in interface TopicIndexIF