story.scheherazade.elements
Class ValidModifier

java.lang.Object
  extended by story.scheherazade.elements.Modifier
      extended by story.scheherazade.elements.ValidModifier
All Implemented Interfaces:
InternableObject, CloneableObject, RenderableObject, Predicate, ValidPredicate

public class ValidModifier
extends Modifier
implements RenderableObject, ValidPredicate, InternableObject, CloneableObject

A Modifier that has been shown to be valid within the context of an actual Narrative. Construct a ValidModifier through a Narrative.


Field Summary
static int OVERHEAD_ARGUMENTS
           
 
Constructor Summary
ValidModifier(Timeline timelineHandler, NodeAddress timeline, ModifierType modifierType, SCHArguments arguments)
           
 
Method Summary
 SCHArguments getArgsOfRole(SemanticRole role)
          Get only those SCHArguments which satisfy a particular SemanticRole.
 StoryAssertion getFrameDefinition()
           
 GenericScheherID getFrameType()
           
 PredicateFlavor getPredicateFlavor()
           
 NodeAddress getPrototypeNode()
          Get the NodeAddress of the declaration (the prototype node) for the modifier type.
 SCHArguments getSCHArguments()
          Get the arguments used to instantiate this Modifier
 SCHArguments getSCHArguments(boolean includeOverheadArguments)
          Get the arguments used to instantiate this Modifier
 TimelineID getTimeline()
          Get the ID of the Timeline in whose scope this Modifier was deemed valid.
 ValidModifier intern()
           
 boolean isInterned()
           
 ValidModifier makeClone()
           
 java.lang.StringBuffer render()
           
 ValidModifier unintern()
           
 
Methods inherited from class story.scheherazade.elements.Modifier
equals, getType, render
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OVERHEAD_ARGUMENTS

public static final int OVERHEAD_ARGUMENTS
See Also:
Constant Field Values
Constructor Detail

ValidModifier

public ValidModifier(Timeline timelineHandler,
                     NodeAddress timeline,
                     ModifierType modifierType,
                     SCHArguments arguments)
              throws Scheherexception
Throws:
Scheherexception
Method Detail

getPrototypeNode

public NodeAddress getPrototypeNode()
Get the NodeAddress of the declaration (the prototype node) for the modifier type.

Specified by:
getPrototypeNode in interface ValidPredicate

getSCHArguments

public SCHArguments getSCHArguments(boolean includeOverheadArguments)
                             throws Scheherexception
Get the arguments used to instantiate this Modifier

Specified by:
getSCHArguments in interface ValidPredicate
Throws:
Scheherexception

getSCHArguments

public SCHArguments getSCHArguments()
                             throws Scheherexception
Get the arguments used to instantiate this Modifier

Specified by:
getSCHArguments in interface ValidPredicate
Overrides:
getSCHArguments in class Modifier
Throws:
Scheherexception

render

public java.lang.StringBuffer render()
                              throws Scheherexception
Specified by:
render in interface RenderableObject
Specified by:
render in interface ValidPredicate
Overrides:
render in class Modifier
Throws:
Scheherexception

getTimeline

public TimelineID getTimeline()
                       throws Scheherexception
Get the ID of the Timeline in whose scope this Modifier was deemed valid.

Specified by:
getTimeline in interface ValidPredicate
Throws:
Scheherexception

getArgsOfRole

public SCHArguments getArgsOfRole(SemanticRole role)
                           throws Scheherexception
Get only those SCHArguments which satisfy a particular SemanticRole.

Specified by:
getArgsOfRole in interface ValidPredicate
Throws:
Scheherexception

getPredicateFlavor

public PredicateFlavor getPredicateFlavor()
Specified by:
getPredicateFlavor in interface Predicate
Specified by:
getPredicateFlavor in interface ValidPredicate
Overrides:
getPredicateFlavor in class Modifier

intern

public ValidModifier intern()
                     throws Scheherexception
Specified by:
intern in interface InternableObject
Specified by:
intern in interface ValidPredicate
Throws:
Scheherexception

unintern

public ValidModifier unintern()
                       throws Scheherexception
Specified by:
unintern in interface InternableObject
Throws:
Scheherexception

isInterned

public boolean isInterned()
Specified by:
isInterned in interface InternableObject

getFrameDefinition

public StoryAssertion getFrameDefinition()
Specified by:
getFrameDefinition in interface ValidPredicate

getFrameType

public GenericScheherID getFrameType()
Specified by:
getFrameType in interface ValidPredicate

makeClone

public ValidModifier makeClone()
                        throws Scheherexception
Specified by:
makeClone in interface CloneableObject
Overrides:
makeClone in class Modifier
Throws:
Scheherexception


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