story.scheherazade.misc
Class ActionType

java.lang.Object
  extended by story.scheherazade.misc.GenericScheherID
      extended by story.scheherazade.misc.ActionType
All Implemented Interfaces:
java.lang.Comparable, RenderableObject, ScheherIDWithType

public class ActionType
extends GenericScheherID
implements java.lang.Comparable, ScheherIDWithType

Extension of GenericScheherID that semantically represents a type of Actions (i.e., a declared abstract Action).


Field Summary
static ActionType Universal
           
 
Constructor Summary
ActionType(ActionType type, WordNetOffset offset, ActionType supertype)
          Constructor that supplements an ActionType with supertype metadata.
ActionType(CoreAction action)
           
ActionType(java.lang.String name)
           
 
Method Summary
 int compareTo(java.lang.Object other)
           
 NodeID declarationNodeID()
          Construct the DBCORE NodeID of the node that declares this Action
 GenericScheherID getType()
          Get the GenericScheherID's type (or supertype, if it's already a type).
 WordNetOffset getWordNetOffset()
          Get the GenericScheherID's WordNet synset offset
 boolean isCoreAction(CoreAction action)
          Returns whether this ActionType represents some CoreAction.
 ActionType makeClone()
           
 java.lang.StringBuffer render()
          Render the ID in a StringBuffer.
 
Methods inherited from class story.scheherazade.misc.GenericScheherID
equals, getIDType, isEveryType, isGenericType, isGroupType, isUniversalType, toRawString, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface story.scheherazade.misc.ScheherIDWithType
isUniversalType
 

Field Detail

Universal

public static ActionType Universal
Constructor Detail

ActionType

public ActionType(java.lang.String name)
           throws Scheherexception
Throws:
Scheherexception

ActionType

public ActionType(ActionType type,
                  WordNetOffset offset,
                  ActionType supertype)
           throws Scheherexception
Constructor that supplements an ActionType with supertype metadata.

Throws:
Scheherexception

ActionType

public ActionType(CoreAction action)
           throws Scheherexception
Throws:
Scheherexception
Method Detail

declarationNodeID

public NodeID declarationNodeID()
                         throws Scheherexception
Construct the DBCORE NodeID of the node that declares this Action

Throws:
Scheherexception

makeClone

public ActionType makeClone()
                     throws Scheherexception
Throws:
Scheherexception

render

public java.lang.StringBuffer render()
                              throws Scheherexception
Description copied from class: GenericScheherID
Render the ID in a StringBuffer. Automatically punctuates according to ID type.

Specified by:
render in interface RenderableObject
Specified by:
render in class GenericScheherID
Throws:
Scheherexception

isCoreAction

public boolean isCoreAction(CoreAction action)
Returns whether this ActionType represents some CoreAction.


compareTo

public int compareTo(java.lang.Object other)
              throws java.lang.ClassCastException
Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class GenericScheherID
Throws:
java.lang.ClassCastException

getType

public GenericScheherID getType()
                         throws Scheherexception
Description copied from interface: ScheherIDWithType
Get the GenericScheherID's type (or supertype, if it's already a type).

Specified by:
getType in interface ScheherIDWithType
Throws:
Scheherexception

getWordNetOffset

public WordNetOffset getWordNetOffset()
Description copied from interface: ScheherIDWithType
Get the GenericScheherID's WordNet synset offset

Specified by:
getWordNetOffset in interface ScheherIDWithType


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