story.scheherazade.parameters
Class NarrativeMatchingQueryParameter

java.lang.Object
  extended by story.scheherazade.parameters.SCHParameter
      extended by story.scheherazade.parameters.StoryQueryParameter
          extended by story.scheherazade.parameters.NarrativeMatchingQueryParameter
Direct Known Subclasses:
AssignedActionParameter, AssignedConditionParameter, DefinedNounParameter, InvokedStateParameter

public abstract class NarrativeMatchingQueryParameter
extends StoryQueryParameter

A class with no functionality that serves to organize the SCHParameter hierarchy by grouping together those Parameters that match arguments, refer to the Narrative story graph and support outreferences to store their matches.

By contrast, BooleanReturnQueryParameters filter results by testing them against boolean requirements.


Constructor Summary
NarrativeMatchingQueryParameter()
           
 
Method Summary
 VariableID getReference()
          Returns the name of the reference by which the match to this parameter should be stored during queries.
abstract  java.lang.Object interpretCoreQueryResult(Timeline timelineHandler, java.util.Enumeration e, SCHSymbolTable references)
          Interpret the elements of a DBCore QueryResult into an element of a Scheherazade SCHQueryResult using the semantics particular to Scheherazade.
 SCHParameter makeClone()
          Make a clone of the Parameter
 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  SCHVariableType 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()
           
 
Methods inherited from class story.scheherazade.parameters.SCHParameter
makeCopy, referenceRequirements, specificRender
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NarrativeMatchingQueryParameter

public NarrativeMatchingQueryParameter()
Method Detail

getReference

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


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.


referenceType

public abstract SCHVariableType 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.


interpretCoreQueryResult

public abstract java.lang.Object interpretCoreQueryResult(Timeline timelineHandler,
                                                          java.util.Enumeration e,
                                                          SCHSymbolTable references)
                                                   throws Scheherexception
Interpret the elements of a DBCore QueryResult into an element of a Scheherazade SCHQueryResult using the semantics particular to Scheherazade.

Throws:
Scheherexception

render

public java.lang.StringBuffer render()
                              throws Scheherexception
Overrides:
render in class SCHParameter
Throws:
Scheherexception

makeClone

public SCHParameter makeClone()
Make a clone of the Parameter

Overrides:
makeClone in class SCHParameter


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