story.scheherazade.parameters
Class SemanticRole

java.lang.Object
  story.scheherazade.parameters.SemanticRole

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, GenericType, RenderableObject

public class SemanticRole
extends java.lang.Object
implements GenericType, java.lang.Comparable, java.io.Serializable, RenderableObject

Manually implemented enum for types. Allows classes to specify types to one another by passing one of the fields of this class rather than a string. No public constructor.

Based (loosely) on http://xoot.org/index.php?name=Java+enum+classes

See Also:

Serialized Form

Field Summary

static SemanticRole	Agent
static SemanticRole	Agent2
static SemanticRole	Asset
static SemanticRole	Cause
static SemanticRole	Communication
static SemanticRole	Destination
static SemanticRole	Experiencer
static SemanticRole	Goal
static SemanticRole	IfPatient
static SemanticRole	Instrument
static SemanticRole	Mover
static SemanticRole	Patient
static SemanticRole	Patient2
static SemanticRole	PossessiveNoun
static SemanticRole	Predicate
static SemanticRole	Preposition
static SemanticRole	Preposition2
static SemanticRole	Product
static SemanticRole	Source
static SemanticRole	ThenPatient
static SemanticRole	Unknown

Method Summary

static java.lang.String	capitalize(java.lang.String in)
int	compareTo(java.lang.Object other)
boolean	equals(java.lang.Object other) Tests if one instance is the same as some other.
static SemanticRole	get(int number) Return the corresponding SemanticRole for the given Unique ID (see getUniqueID).
static SemanticRole	get(java.lang.String string) Static version of get() that gets around the Java restriction on static types in interfaces.
static ImmutableHashSet	getAllTypes() Return a HashSet of every item in the enumeration.
ImmutableHashSet	getAllTypesNonStatically() Return a HashSet of every item in the enumeration.
GenericType	getAsGeneric(java.lang.String string) Return the corresponding SemanticRole for the given string as a GenericType object.
int	getUniqueID() Get a unique numerial ID for this type that goes from 0 to (numMembers() - 1).
static int	numMembers() Get the number of members of this type.
java.lang.StringBuffer	render() Return the string equivalent of the SemanticRole with the type type, formatted with the dot operator that the command interpreter understands.
java.lang.String	toString() Return the string equivalent of the SemanticRole.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Agent

public static final SemanticRole Agent

Agent2

public static final SemanticRole Agent2

Instrument

public static final SemanticRole Instrument

Predicate

public static final SemanticRole Predicate

Cause

public static final SemanticRole Cause

Product

public static final SemanticRole Product

Patient2

public static final SemanticRole Patient2

Asset

public static final SemanticRole Asset

Communication

public static final SemanticRole Communication

Mover

public static final SemanticRole Mover

Patient

public static final SemanticRole Patient

Experiencer

public static final SemanticRole Experiencer

Destination

public static final SemanticRole Destination

Source

public static final SemanticRole Source

Goal

public static final SemanticRole Goal

Unknown

public static final SemanticRole Unknown

IfPatient

public static final SemanticRole IfPatient

ThenPatient

public static final SemanticRole ThenPatient

Preposition

public static final SemanticRole Preposition

Preposition2

public static final SemanticRole Preposition2

PossessiveNoun

public static final SemanticRole PossessiveNoun

Method Detail

get

public static SemanticRole get(int number)

Return the corresponding SemanticRole for the given Unique ID (see getUniqueID).

Parameters:

number - Number index.

toString

public java.lang.String toString()

Return the string equivalent of the SemanticRole.

Specified by:

toString in interface GenericType

Overrides:

toString in class java.lang.Object

render

public java.lang.StringBuffer render()

Return the string equivalent of the SemanticRole with the type type, formatted with the dot operator that the command interpreter understands.

Specified by:

render in interface GenericType

Specified by:

render in interface RenderableObject

equals

public boolean equals(java.lang.Object other)

Tests if one instance is the same as some other.

Specified by:

equals in interface GenericType

Overrides:

equals in class java.lang.Object

Parameters:

other - Other SemanticRole to compare to.

getAllTypes

public static ImmutableHashSet getAllTypes()

Return a HashSet of every item in the enumeration.

getAllTypesNonStatically

public ImmutableHashSet getAllTypesNonStatically()

Return a HashSet of every item in the enumeration.

Specified by:

getAllTypesNonStatically in interface GenericType

getAsGeneric

public GenericType getAsGeneric(java.lang.String string)

Return the corresponding SemanticRole for the given string as a GenericType object.

Specified by:

getAsGeneric in interface GenericType

get

public static SemanticRole get(java.lang.String string)

Static version of get() that gets around the Java restriction on static types in interfaces.

compareTo

public int compareTo(java.lang.Object other)
              throws java.lang.ClassCastException

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException

getUniqueID

public int getUniqueID()

Get a unique numerial ID for this type that goes from 0 to (numMembers() - 1).

numMembers

public static int numMembers()

Get the number of members of this type.

capitalize

public static java.lang.String capitalize(java.lang.String in)