edu.mit.jverbnet.data.syntax
Enum SyntaxArgType

java.lang.Object
  java.lang.Enum<SyntaxArgType>
      edu.mit.jverbnet.data.syntax.SyntaxArgType

All Implemented Interfaces:

IVerbnetType, IHasID, java.io.Serializable, java.lang.Comparable<SyntaxArgType>

public enum SyntaxArgType
extends java.lang.Enum<SyntaxArgType>
implements IVerbnetType

Syntactic argument types. The values in this enum correspond to the named elements of xsd:choice subelement of the SYNTAX portion of the Verbnet xsd file.

Since:

JVerbnet 1.0.0

Version:

1.2.0

Author:

Mark A. Finlayson

Nested Class Summary

static class

SyntaxArgType.VALUE_RULE Checks that the value meets the expectations of the type.

Enum Constant Summary

ADJ

ADV

LEX

NP

PREP

Field Summary

static java.lang.String

XSD_TYPE_NAME The name of the xsd:simpleType entry that describes this verbnet type in the XSD file.

Fields inherited from interface edu.mit.jverbnet.data.IVerbnetType

FIELD_NAME_XSD_TYPE_NAME, METHOD_NAME_getById

Method Summary

static SyntaxArgType	getById(java.lang.String id) Returns the object corresponding to the specified xsd name.
java.lang.String	getID() Returns the id of the type, as defined in the xsd file.
java.lang.String	getName() Returns a human-readable name for this argument type, suitable for display in a UI.
SyntaxArgType.VALUE_RULE	getValueRule() Returns the value rule for this argument type.
static SyntaxArgType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SyntaxArgType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NP

public static final SyntaxArgType NP

ADV

public static final SyntaxArgType ADV

ADJ

public static final SyntaxArgType ADJ

PREP

public static final SyntaxArgType PREP

LEX

public static final SyntaxArgType LEX

Field Detail

XSD_TYPE_NAME

public static final java.lang.String XSD_TYPE_NAME

The name of the xsd:simpleType entry that describes this verbnet type in the XSD file.

Since:

JVerbnet 1.0.0

See Also:

Constant Field Values

Method Detail

values

public static SyntaxArgType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SyntaxArgType c : SyntaxArgType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SyntaxArgType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getID

public java.lang.String getID()

Description copied from interface: IHasID

Returns the id of the type, as defined in the xsd file. Will never be null or empty.

Specified by:

getID in interface IHasID

Returns:

the id of the type

getName

public java.lang.String getName()

Returns a human-readable name for this argument type, suitable for display in a UI.

Returns:

a human-readable name for this argument type, suitable for display in a UI.

Since:

JVerbnet 1.0.0

getValueRule

public SyntaxArgType.VALUE_RULE getValueRule()

Returns the value rule for this argument type.

Returns:

the non-null value rule for this type

Since:

JVerbnet 1.0.0

getById

public static SyntaxArgType getById(java.lang.String id)

Returns the object corresponding to the specified xsd name. The id is matched to values without regard to case. If no value has the specified id, the method returns null. If the VerbnetTypes.isPrintingIdWarnings() flag is set, the method will print a warning to standard out if there is no value with the specified id, or if the specified id is not exactly identical to the value's id (i.e., differs in case).

Parameters:

id - the id of the type value as found in the xsd file and in the xml data files.

Returns:

the type corresponding to the specified xsd name, or null if none

Throws:

java.lang.NullPointerException - if the id is null

java.lang.IllegalArgumentException - if the id is empty or all whitespace

Since:

JVerbnet 1.0.0