net.sf.extjwnl.data

Enum PointerType

java.lang.Object

java.lang.Enum<PointerType>

net.sf.extjwnl.data.PointerType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PointerType>

public enum PointerType
extends java.lang.Enum<PointerType>

Instances of this class enumerate the possible WordNet pointer types, and are used to label PointerTypes. Each PointerType carries additional information: a human-readable label, an optional reflexive type that labels links pointing the opposite direction, an encoding of parts-of-speech that it applies to, and a short string that represents it in the dictionary files.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANTONYM
ATTRIBUTE
CATEGORY
CATEGORY_MEMBER
CAUSE
DERIVATION
DOMAIN_ALL
ENTAILMENT
HYPERNYM
HYPONYM
INSTANCE_HYPERNYM
INSTANCES_HYPONYM
MEMBER_ALL
MEMBER_HOLONYM
MEMBER_MERONYM
PART_HOLONYM
PART_MERONYM
PARTICIPLE_OF
PERTAINYM
REGION
REGION_MEMBER
SEE_ALSO
SIMILAR_TO
SUBSTANCE_HOLONYM
SUBSTANCE_MERONYM
USAGE
USAGE_MEMBER
VERB_GROUP

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(POS pos) Returns whether or not this PointerType can be associated with pos.
static java.util.List<PointerType>	getAllPointerTypes()
static java.util.List<PointerType>	getAllPointerTypesForPOS(POS pos)
int	getFlags()
java.lang.String	getKey()
java.lang.String	getLabel()
static PointerType	getPointerTypeForKey(java.lang.CharSequence key) Return the PointerType whose key matches key and applies to pos.
static PointerType	getPointerTypeForKey(java.lang.String key) Return the PointerType whose key matches key and applies to pos.
PointerType	getSymmetricType() Returns the pointer type that is symmetric to this type.
boolean	isSymmetric()
static boolean	isSymmetric(PointerType type) Returns true if type is a symmetric pointer type (it is its own symmetric type).
boolean	symmetricTo(PointerType type) Returns true if type is symmetric to this pointer type.
java.lang.String	toString()
static PointerType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PointerType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANTONYM

public static final PointerType ANTONYM

HYPERNYM

public static final PointerType HYPERNYM

HYPONYM

public static final PointerType HYPONYM

ENTAILMENT

public static final PointerType ENTAILMENT

SIMILAR_TO

public static final PointerType SIMILAR_TO

MEMBER_HOLONYM

public static final PointerType MEMBER_HOLONYM

SUBSTANCE_HOLONYM

public static final PointerType SUBSTANCE_HOLONYM

PART_HOLONYM

public static final PointerType PART_HOLONYM

MEMBER_MERONYM

public static final PointerType MEMBER_MERONYM

SUBSTANCE_MERONYM

public static final PointerType SUBSTANCE_MERONYM

PART_MERONYM

public static final PointerType PART_MERONYM

CAUSE

public static final PointerType CAUSE

PARTICIPLE_OF

public static final PointerType PARTICIPLE_OF

SEE_ALSO

public static final PointerType SEE_ALSO

PERTAINYM

public static final PointerType PERTAINYM

ATTRIBUTE

public static final PointerType ATTRIBUTE

VERB_GROUP

public static final PointerType VERB_GROUP

DERIVATION

public static final PointerType DERIVATION

DOMAIN_ALL

public static final PointerType DOMAIN_ALL

MEMBER_ALL

public static final PointerType MEMBER_ALL

CATEGORY

public static final PointerType CATEGORY

USAGE

public static final PointerType USAGE

REGION

public static final PointerType REGION

CATEGORY_MEMBER

public static final PointerType CATEGORY_MEMBER

USAGE_MEMBER

public static final PointerType USAGE_MEMBER

REGION_MEMBER

public static final PointerType REGION_MEMBER

INSTANCE_HYPERNYM

public static final PointerType INSTANCE_HYPERNYM

INSTANCES_HYPONYM

public static final PointerType INSTANCES_HYPONYM

Method Detail

values

public static PointerType[] 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 (PointerType c : PointerType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PointerType 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

isSymmetric

public static boolean isSymmetric(PointerType type)

Returns true if type is a symmetric pointer type (it is its own symmetric type).

Parameters:

type - pointer type

Returns:

if type is a symmetric pointer type

getPointerTypeForKey

public static PointerType getPointerTypeForKey(java.lang.String key)

Return the PointerType whose key matches key and applies to pos.

Parameters:

key - pointer type key

Returns:

the PointerType whose key matches key

getPointerTypeForKey

public static PointerType getPointerTypeForKey(java.lang.CharSequence key)

Return the PointerType whose key matches key and applies to pos.

Parameters:

key - pointer type key

Returns:

the PointerType whose key matches key

getAllPointerTypes

public static java.util.List<PointerType> getAllPointerTypes()

getAllPointerTypesForPOS

public static java.util.List<PointerType> getAllPointerTypesForPOS(POS pos)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<PointerType>

getKey

public java.lang.String getKey()

getLabel

public java.lang.String getLabel()

appliesTo

public boolean appliesTo(POS pos)

Returns whether or not this PointerType can be associated with pos.

Parameters:

pos - part of speech

Returns:

true if this PointerType can be associated with pos

isSymmetric

public boolean isSymmetric()

symmetricTo

public boolean symmetricTo(PointerType type)

Returns true if type is symmetric to this pointer type.

Parameters:

type - pointer type

Returns:

true if type is symmetric to this pointer type

getSymmetricType

public PointerType getSymmetricType()

Returns the pointer type that is symmetric to this type.

Returns:

the pointer type that is symmetric to this type

getFlags

public int getFlags()