net.ontopia.topicmaps.query.parser
Interface PredicateIF

All Known Subinterfaces:

BasicPredicateIF, JDOPredicateIF

All Known Implementing Classes:

AbstractDynamicPredicate, AbstractInstanceOfPredicate, AssociationPredicate, AssociationPredicate, AssociationRolePredicate, AssociationRolePredicate, BaseLocatorPredicate, BaseLocatorPredicate, CoalescePredicate, CoalescePredicate, DatatypePredicate, DatatypePredicate, DirectInstanceOfPredicate, DirectInstanceOfPredicate, DynamicAssociationPredicate, DynamicAssociationPredicate, DynamicFailurePredicate, DynamicFailurePredicate, DynamicOccurrencePredicate, DynamicOccurrencePredicate, EqualsFilter, EqualsPredicate, EqualsPredicate, FilterPredicate, GreaterThanEqualsPredicate, GreaterThanEqualsPredicate, GreaterThanPredicate, GreaterThanPredicate, HierarchyWalkerRulePredicate, InPredicate, InPredicate, InstanceOfPredicate, InstanceOfPredicate, ItemIdentifierPredicate, ItemIdentifierPredicate, JavaPredicate, JavaSearcherPredicate, JDOBasicPredicate, LessThanEqualsPredicate, LessThanEqualsPredicate, LessThanPredicate, LessThanPredicate, NamePredicate, NamePredicate, NotEqualsPredicate, NotEqualsPredicate, ObjectIdPredicate, ObjectIdPredicate, OccurrencePredicate, OccurrencePredicate, ProcessPredicate, QueryOptimizer.PumpPredicate, ReifiesPredicate, ReifiesPredicate, RemoveDuplicatesPredicate, ResourcePredicate, ResourcePredicate, RolePlayerPredicate, RolePlayerPredicate, RulePredicate, RulePredicate, ScopePredicate, ScopePredicate, StringModule.EndsWithPredicate, StringModule.StartsWithPredicate, SubjectIdentifierPredicate, SubjectIdentifierPredicate, SubjectLocatorPredicate, SubjectLocatorPredicate, TopicMapPredicate, TopicMapPredicate, TopicNamePredicate, TopicNamePredicate, TopicPredicate, TopicPredicate, TypePredicate, TypePredicate, ValueLikePredicate, ValueLikePredicate, ValuePredicate, ValuePredicate, VariantPredicate, VariantPredicate

public interface PredicateIF

INTERNAL: Represents a predicate.

Method Summary

int	getCost(boolean[] boundparams) INTERNAL.
String	getName() INTERNAL: Returns the name of the predicate.
String	getSignature() INTERNAL: Returns a string representing the signature of the predicate.

Method Detail

getName

String getName()

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.

getSignature

String getSignature()
                    throws InvalidQueryException

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.

Throws:

InvalidQueryException

getCost

int getCost(boolean[] boundparams)

INTERNAL.