net.ontopia.topicmaps.query.spi

Class AbstractSearcher

java.lang.Object

net.ontopia.topicmaps.query.spi.AbstractSearcher

All Implemented Interfaces:

SearcherIF

Direct Known Subclasses:

HTTPSearcher, RDBMSSearcher

public abstract class AbstractSearcher
extends Object
implements SearcherIF

PUBLIC: Abstract SearcherIF convenience superclass used to get the default implementation of the four set methods. Subclassing this class ensures better forward compatibility.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	moduleURI
protected Map	parameters
protected String	predicateName
protected TopicMapIF	topicmap

Fields inherited from interface net.ontopia.topicmaps.query.spi.SearcherIF

ITEM_IDENTIFIER, OBJECT_ID, OBJECT_VALUE, OCCURRENCE_URI, STRING_VALUE, SUBJECT_IDENTIFIER, SUBJECT_LOCATOR

Constructor Summary

Constructors

Constructor and Description
AbstractSearcher()

Method Summary

Modifier and Type	Method and Description
void	setModuleURI(String moduleURI) PUBLIC: Called by the query engine before using the instance to pass the module URI to the searcher.
void	setParameters(Map parameters) PUBLIC: Called by the query engine before using the instance to pass the parameters in the module URI to the searcher.
void	setPredicateName(String predicateName) PUBLIC: Called by the query engine before using the instance to pass the name of the predicate (the part after the colon in the QName) to the searcher.
void	setTopicMap(TopicMapIF topicmap) PUBLIC: Called by the query engine before using the instance to pass the topic map being queried to the predicate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ontopia.topicmaps.query.spi.SearcherIF

getResult, getValueType

Field Detail

moduleURI

protected String moduleURI

predicateName

protected String predicateName

topicmap

protected TopicMapIF topicmap

parameters

protected Map parameters

Constructor Detail

AbstractSearcher

public AbstractSearcher()

Method Detail

setModuleURI

public void setModuleURI(String moduleURI)

Description copied from interface: SearcherIF

PUBLIC: Called by the query engine before using the instance to pass the module URI to the searcher. No specific behaviour is required from the searcher.

Specified by:

setModuleURI in interface SearcherIF

setPredicateName

public void setPredicateName(String predicateName)

Description copied from interface: SearcherIF

PUBLIC: Called by the query engine before using the instance to pass the name of the predicate (the part after the colon in the QName) to the searcher. No specific behaviour is required from the searcher.

Specified by:

setPredicateName in interface SearcherIF

setTopicMap

public void setTopicMap(TopicMapIF topicmap)

Description copied from interface: SearcherIF

PUBLIC: Called by the query engine before using the instance to pass the topic map being queried to the predicate. No specific behaviour is required from the searcher.

Specified by:

setTopicMap in interface SearcherIF

setParameters

public void setParameters(Map parameters)

Description copied from interface: SearcherIF

PUBLIC: Called by the query engine before using the instance to pass the parameters in the module URI to the searcher. The map will contain {"foo" : "bar"} if the URI ends in "?foo=bar". No specific behaviour is required from the searcher.

Specified by:

setParameters in interface SearcherIF