story.scheherazade.parameters
Class InvokedStateParameter

java.lang.Object
  extended by story.scheherazade.parameters.SCHParameter
      extended by story.scheherazade.parameters.StoryQueryParameter
          extended by story.scheherazade.parameters.NarrativeMatchingQueryParameter
              extended by story.scheherazade.parameters.InvokedStateParameter

public class InvokedStateParameter
extends NarrativeMatchingQueryParameter

An SCHParameter which matches a state that's been declared/used in the narrative.


Constructor Summary
InvokedStateParameter(TimelineID timeline)
          Constructor to match a state
InvokedStateParameter(TimelineID timeline, VariableID reference)
          Constructor to match a state and leave an outreference
 
Method Summary
 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 makeCopy()
          Make a copy of the Parameter at the level of the concretizing class
 SCHReferenceReqSet referenceRequirements()
          Each concretizing class needs to provide a ReferenceReqSet of all the references which must be set prior to the parameter's evaluation.
 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 specificRender()
          Each concretizing class needs to provide a render function.
 
Methods inherited from class story.scheherazade.parameters.NarrativeMatchingQueryParameter
getReference, makeClone, referenceSet, render
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InvokedStateParameter

public InvokedStateParameter(TimelineID timeline)
Constructor to match a state


InvokedStateParameter

public InvokedStateParameter(TimelineID timeline,
                             VariableID reference)
Constructor to match a state and leave an outreference

Method Detail

referenceRequirements

public SCHReferenceReqSet referenceRequirements()
Description copied from class: SCHParameter
Each concretizing class needs to provide a ReferenceReqSet of all the references which must be set prior to the parameter's evaluation.

Specified by:
referenceRequirements in class SCHParameter

specificRender

public java.lang.StringBuffer specificRender()
                                      throws Scheherexception
Description copied from class: SCHParameter
Each concretizing class needs to provide a render function. It is encapsulated inside this abstract class's render() so that we can render the outgoing reference, if any.

Specified by:
specificRender in class SCHParameter
Throws:
Scheherexception

makeCopy

public SCHParameter makeCopy()
Description copied from class: SCHParameter
Make a copy of the Parameter at the level of the concretizing class

Specified by:
makeCopy in class SCHParameter

referenceType

public SCHVariableType referenceType()
Description copied from class: NarrativeMatchingQueryParameter
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.

Specified by:
referenceType in class NarrativeMatchingQueryParameter

interpretCoreQueryResult

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

Specified by:
interpretCoreQueryResult in class NarrativeMatchingQueryParameter
Throws:
Scheherexception


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