net.didion.jwnl.data
Class PointerType

java.lang.Object
  extended by net.didion.jwnl.data.PointerType
All Implemented Interfaces:
java.io.Serializable

public final class PointerType
extends java.lang.Object
implements java.io.Serializable

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.

See Also:
Serialized Form

Field Summary
static PointerType ANTONYM
           
static PointerType ATTRIBUTE
           
static PointerType CATEGORY
           
static PointerType CATEGORY_MEMBER
           
static PointerType CAUSE
           
static PointerType DERIVED
           
static PointerType ENTAILED_BY
           
static PointerType ENTAILMENT
           
static PointerType HYPERNYM
           
static PointerType HYPONYM
           
static PointerType INSTANCE_HYPERNYM
           
static PointerType INSTANCES_HYPONYM
           
static PointerType MEMBER_HOLONYM
           
static PointerType MEMBER_MERONYM
           
static PointerType NOMINALIZATION
           
static PointerType PART_HOLONYM
           
static PointerType PART_MERONYM
           
static PointerType PARTICIPLE_OF
           
static PointerType PERTAINYM
           
static PointerType REGION
           
static PointerType REGION_MEMBER
           
static PointerType SEE_ALSO
           
static PointerType SIMILAR_TO
           
static PointerType SUBSTANCE_HOLONYM
           
static PointerType SUBSTANCE_MERONYM
           
static PointerType USAGE
           
static PointerType USAGE_MEMBER
           
static PointerType VERB_GROUP
           
 
Method Summary
 boolean appliesTo(POS pos)
          Whether or not this PointerType can be associated with pos
static java.util.List getAllPointerTypes()
           
static java.util.List getAllPointerTypesForPOS(POS pos)
           
 java.lang.String getKey()
           
 java.lang.String getLabel()
           
static PointerType getPointerTypeForKey(java.lang.String key)
          Return the PointerType whose key matches key.
 PointerType getSymmetricType()
          Returns the pointer type that is symmetric to this type.
 int hashCode()
           
static void initialize()
           
 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()
           
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ANTONYM

public static final PointerType ANTONYM

CATEGORY

public static final PointerType CATEGORY

REGION

public static final PointerType REGION

USAGE

public static final PointerType USAGE

HYPERNYM

public static final PointerType HYPERNYM

HYPONYM

public static final PointerType HYPONYM

NOMINALIZATION

public static final PointerType NOMINALIZATION

INSTANCE_HYPERNYM

public static final PointerType INSTANCE_HYPERNYM

INSTANCES_HYPONYM

public static final PointerType INSTANCES_HYPONYM

ATTRIBUTE

public static final PointerType ATTRIBUTE

SEE_ALSO

public static final PointerType SEE_ALSO

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

CATEGORY_MEMBER

public static final PointerType CATEGORY_MEMBER

REGION_MEMBER

public static final PointerType REGION_MEMBER

USAGE_MEMBER

public static final PointerType USAGE_MEMBER

ENTAILMENT

public static final PointerType ENTAILMENT

ENTAILED_BY

public static final PointerType ENTAILED_BY

CAUSE

public static final PointerType CAUSE

VERB_GROUP

public static final PointerType VERB_GROUP

SIMILAR_TO

public static final PointerType SIMILAR_TO

PARTICIPLE_OF

public static final PointerType PARTICIPLE_OF

PERTAINYM

public static final PointerType PERTAINYM

DERIVED

public static final PointerType DERIVED
Method Detail

initialize

public static void initialize()

isSymmetric

public static boolean isSymmetric(PointerType type)
Returns true if type is a symmetric pointer type (it is its own symmetric type).


getPointerTypeForKey

public static PointerType getPointerTypeForKey(java.lang.String key)
Return the PointerType whose key matches key.


getAllPointerTypes

public static java.util.List getAllPointerTypes()

getAllPointerTypesForPOS

public static java.util.List getAllPointerTypesForPOS(POS pos)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getKey

public java.lang.String getKey()

getLabel

public java.lang.String getLabel()

appliesTo

public boolean appliesTo(POS pos)
Whether or not 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.


getSymmetricType

public PointerType getSymmetricType()
Returns the pointer type that is symmetric to this type.


hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object