story.dbcore.parameters
Class MatchingParameter

java.lang.Object
  extended by story.dbcore.parameters.Parameter
      extended by story.dbcore.parameters.MatchingParameter
Direct Known Subclasses:
BooleanMatchParameter, KleeneParameter, NodeParameter, OrMatchingParameter, RelatedNodeParameter

public abstract class MatchingParameter
extends Parameter

A class with no functionality that serves to organize the Parameter hierarchy by grouping together those Parameters that match arguments and support outreferences to store their matches.

By contrast, BooleanReturnParameters filter results by testing them against boolean requirements. See BooleanReturnParameter.


Constructor Summary
MatchingParameter()
           
 
Method Summary
 VariableID getReference()
          Returns the name of the reference by which the match to this parameter should be stored during queries.
 Parameter makeClone()
          Make a clone of the Parameter.
 Parameter makeCloneWithNewReference(VariableID outgoingReference)
          Make a clone of this parameter and specify a new outgoing reference for the clone.
 boolean referenceSet()
          Reports whether the parameter has had a reference set, i.e., if matches to it should be stored in the symbol table under some ID.
abstract  VariableType referenceType()
          Each concretizing class needs to tell us what kind of variable would need to go into the reference SymbolTable should such a storage be needed.
 java.lang.StringBuffer render()
          Render the Parameter.
 
Methods inherited from class story.dbcore.parameters.Parameter
assumedNodes, makeCopy, referenceRequirements, specificRender
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MatchingParameter

public MatchingParameter()
Method Detail

referenceType

public abstract VariableType referenceType()
Each concretizing class needs to tell us what kind of variable would need to go into the reference SymbolTable should such a storage be needed.


referenceSet

public boolean referenceSet()
Reports whether the parameter has had a reference set, i.e., if matches to it should be stored in the symbol table under some ID.


getReference

public VariableID getReference()
Returns the name of the reference by which the match to this parameter should be stored during queries. Potentially null.


makeClone

public Parameter makeClone()
Make a clone of the Parameter. Unlike makeCopy, this also duplicates the outgoing reference.

Overrides:
makeClone in class Parameter

makeCloneWithNewReference

public Parameter makeCloneWithNewReference(VariableID outgoingReference)
                                    throws Scheherexception
Make a clone of this parameter and specify a new outgoing reference for the clone.

Throws:
Scheherexception

render

public java.lang.StringBuffer render()
                              throws Scheherexception
Description copied from class: Parameter
Render the Parameter.

Overrides:
render in class Parameter
Throws:
Scheherexception


Copyright © 2011 David K. Elson. All Rights Reserved.