net.didion.jwnl.data
Class Pointer

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

public class Pointer
extends java.lang.Object
implements java.io.Serializable

A Pointer encodes a lexical or semantic relationship between WordNet entities. A lexical relationship holds between Words; a semantic relationship holds between Synsets. Relationships are directional: the two roles of a relationship are the source and target. Relationships are typed: the type of a relationship is a PointerType, and can be retrieved via getType.

See Also:
Serialized Form

Constructor Summary
Pointer(PointerTarget source, int index, PointerType pointerType, POS targetPOS, long targetOffset, int targetIndex)
           
 
Method Summary
 boolean equals(java.lang.Object object)
           
 PointerTarget getSource()
          Get the source of this pointer.
 int getSourceIndex()
           
 PointerTarget getTarget()
          Get the actual target of this pointer.
 int getTargetIndex()
           
 long getTargetOffset()
          Get the offset of the target within the target synset.
 POS getTargetPOS()
           
 Synset getTargetSynset()
          Get the synset that is a) the target of this pointer, or b) the * synset that contains the target of this pointer.
 PointerType getType()
           
 int hashCode()
           
 boolean isLexical()
          True if this pointer's source is a Word
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Pointer

public Pointer(PointerTarget source,
               int index,
               PointerType pointerType,
               POS targetPOS,
               long targetOffset,
               int targetIndex)
Method Detail

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

hashCode

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

toString

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

getSourceIndex

public int getSourceIndex()

getType

public PointerType getType()

isLexical

public boolean isLexical()
True if this pointer's source is a Word


getSource

public PointerTarget getSource()
Get the source of this pointer.


getTarget

public PointerTarget getTarget()
                        throws JWNLException
Get the actual target of this pointer.

Throws:
JWNLException

getTargetSynset

public Synset getTargetSynset()
                       throws JWNLException
Get the synset that is a) the target of this pointer, or b) the * synset that contains the target of this pointer.

Throws:
JWNLException

getTargetOffset

public long getTargetOffset()
Get the offset of the target within the target synset. If the offset is * 0, then this pointer applies to all words in the target.


getTargetIndex

public int getTargetIndex()

getTargetPOS

public POS getTargetPOS()