net.ontopia.topicmaps.query.impl.basic
Class ScopePredicate

java.lang.Object
  net.ontopia.topicmaps.query.impl.basic.ScopePredicate

All Implemented Interfaces:

BasicPredicateIF, PredicateIF

Direct Known Subclasses:

ScopePredicate

public class ScopePredicate
extends java.lang.Object
implements BasicPredicateIF

INTERNAL: Implements the 'scope(scoped, theme)' predicate.

Field Summary

protected ScopeIndexIF	index
protected TopicMapIF	topicmap

Constructor Summary

ScopePredicate(TopicMapIF topicmap)

Method Summary

protected java.util.Collection	getAllScoped()
int	getCost(boolean[] boundparams) INTERNAL.
java.lang.String	getName() INTERNAL: Returns the name of the predicate.
java.lang.String	getSignature() INTERNAL: Returns a string representing the signature of the predicate.
protected void	prefetchScope(QueryMatches matches, java.lang.Object[] arguments, int scopedix)
QueryMatches	satisfy(QueryMatches matches, java.lang.Object[] arguments)

Methods inherited from class java.lang.Object

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

Field Detail

topicmap

protected TopicMapIF topicmap

index

protected ScopeIndexIF index

Constructor Detail

ScopePredicate

public ScopePredicate(TopicMapIF topicmap)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: PredicateIF

INTERNAL: Returns the name of the predicate. This will usually be the name of the predicate within its module ('instance-of', '/=', 'starts-with'), but some virtual predicates cannot be reached from the syntax and may return names that will not parse.

Specified by:

getName in interface PredicateIF

getSignature

public java.lang.String getSignature()

Description copied from interface: PredicateIF

INTERNAL: Returns a string representing the signature of the predicate. The string consists of a whitespace-separated list of arguments, where each argument is made up of tokens representing the type or cardinality of that argument.

The instance-of predicate would have a signature of "t t", while /= would have ". .", and in would have ". .+". For full details, see topicmaps.impl.utils.ArgumentValidator.

Specified by:

getSignature in interface PredicateIF

getCost

public int getCost(boolean[] boundparams)

Description copied from interface: PredicateIF

INTERNAL.

Specified by:

getCost in interface PredicateIF

satisfy

public QueryMatches satisfy(QueryMatches matches,
                            java.lang.Object[] arguments)
                     throws InvalidQueryException

Specified by:

satisfy in interface BasicPredicateIF

Throws:

InvalidQueryException

prefetchScope

protected void prefetchScope(QueryMatches matches,
                             java.lang.Object[] arguments,
                             int scopedix)

getAllScoped

protected java.util.Collection getAllScoped()