net.sf.extjwnl.data

Class PointerUtils

java.lang.Object

net.sf.extjwnl.data.PointerUtils

public abstract class PointerUtils
extends java.lang.Object

This class contains static methods for performing various pointer operations. A pointer from one synset/word to another connotes a relationship between those words. The type of the relationship is specified by the type of pointer. See the WordNet documentation for information on pointer types. To avoid confusion with the Relationship class, these relationships will be referred to as links.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITY Representation of infinite depth.

Constructor Summary

Constructors

Constructor and Description
PointerUtils()

Method Summary

Modifier and Type	Method and Description
static PointerTargetNodeList	getAlsoSees(Synset synset) Finds what words are related to synset.
static PointerTargetTree	getAlsoSeeTree(Synset synset, int depth) Finds all See Also relations to depth depth.
static PointerTargetNodeList	getAntonyms(Synset synset) Returns the words that mean the opposite of synset.
static PointerTargetNodeList	getAttributes(Synset synset) Returns the attributes of synset.
static PointerTargetNodeList	getCauses(Synset synset) Finds direct cause links of synset.
static PointerTargetTree	getCauseTree(Synset synset) Finds all cause links for synset.
static PointerTargetTree	getCauseTree(Synset synset, int depth) Finds all cause links for synset to depth depth.
static PointerTargetNodeList	getCoordinateTerms(Synset synset) Returns synset's siblings (the hyponyms of its hypernyms).
static PointerTargetNodeList	getDirectHypernyms(Synset synset) Returns the immediate parents of synset.
static PointerTargetNodeList	getDirectHyponyms(Synset synset) Returns the immediate children of synset.
static PointerTargetNodeList	getEntailments(Synset synset) Finds direct entailments of synset.
static PointerTargetTree	getEntailmentTree(Synset synset) Finds all entailments for synset.
static PointerTargetTree	getEntailmentTree(Synset synset, int depth) Finds all entailments for synset to depth depth.
static PointerTargetTree	getExtendedAntonyms(Synset synset) Returns the words that mean the opposite of synset and the immediate synonyms of those words.
static PointerTargetTree	getExtendedAntonyms(Synset synset, int depth) Finds all antonyms of synset, and all synonyms of those antonyms to depth depth.
static PointerTargetNodeList	getHolonyms(Synset synset) Returns holonyms of synset.
static PointerTargetTree	getHypernymTree(Synset synset) Returns all of the ancestors of synset.
static PointerTargetTree	getHypernymTree(Synset synset, int depth) Returns all of the ancestors of synset to depth depth.
static PointerTargetTree	getHyponymTree(Synset synset) Returns all of the children of synset.
static PointerTargetTree	getHyponymTree(Synset synset, int depth) Returns all of the children of synset to depth depth.
static PointerTargetTree	getIndirectAntonyms(Synset synset) Returns the immediate antonyms of all words that mean the same as synset.
static PointerTargetTree	getIndirectAntonyms(Synset synset, int depth) Returns the antonyms of all words that mean the same as synset to depth depth.
static PointerTargetTree	getInheritedHolonyms(Synset synset) Returns holonyms of synset and of all its ancestors.
static PointerTargetTree	getInheritedHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Returns holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedMemberHolonyms(Synset synset) Returns member holonyms of synset and of all its ancestors.
static PointerTargetTree	getInheritedMemberHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Returns member holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedMemberMeronyms(Synset synset) Returns member meronyms of synset and of its ancestors.
static PointerTargetTree	getInheritedMemberMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Returns member meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedMeronyms(Synset synset) Returns meronyms of synset and of all its ancestors.
static PointerTargetTree	getInheritedMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Returns meronyms of each synset, to depth pointerDepth starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedPartHolonyms(Synset synset) Returns part holonyms of synset and of all its ancestors.
static PointerTargetTree	getInheritedPartHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Returns part holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedPartMeronyms(Synset synset) Returns part meronyms of synset and of all its ancestors.
static PointerTargetTree	getInheritedPartMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Returns part meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedSubstanceHolonyms(Synset synset) Returns substance holonyms of synset and of all its ancestors.
static PointerTargetTree	getInheritedSubstanceHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Returns substance holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetTree	getInheritedSubstanceMeronyms(Synset synset) Returns substance meronyms of synset and of its ancestors.
static PointerTargetTree	getInheritedSubstanceMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Returns substance meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerTargetNodeList	getMemberHolonyms(Synset synset) Returns member holonyms of synset.
static PointerTargetNodeList	getMemberMeronyms(Synset synset) Returns member meronyms of synset.
static PointerTargetNodeList	getMeronyms(Synset synset) Returns meronyms of synset.
static PointerTargetNodeList	getPartHolonyms(Synset synset) Returns part holonyms of synset.
static PointerTargetNodeList	getParticipleOf(Synset synset) Finds participle of links of synset.
static PointerTargetNodeList	getPartMeronyms(Synset synset) Returns part meronyms of synset.
static PointerTargetNodeList	getPertainyms(Synset synset) Returns the pertainyms for synset.
static PointerTargetNodeList	getSubstanceHolonyms(Synset synset) Returns substance holonyms of synset.
static PointerTargetNodeList	getSubstanceMeronyms(Synset synset) Returns substance meronyms of synset.
static PointerTargetNodeList	getSynonyms(Synset synset) Returns the synonyms for synset.
static PointerTargetTree	getSynonymTree(Synset synset, int depth) Returns all the synonyms of synset to depth depth.
static PointerTargetNodeList	getVerbGroup(Synset synset) Returns the group that this verb belongs to.
static PointerTargetTree	makeInheritedTree(PointerTargetTree tree, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Turn an existing tree into an inheritance tree.
static PointerTargetTree	makeInheritedTree(Synset synset, PointerType searchType) Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of type searchType, starting at the node's pointer target.
static PointerTargetTree	makeInheritedTree(Synset synset, PointerType[] searchTypes) Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of the types specified in searchTypes, starting at the node's pointer target.
static PointerTargetTree	makeInheritedTree(Synset synset, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth) Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of the types specified in searchTypes, starting at the node's pointer target.
static PointerTargetTree	makeInheritedTree(Synset synset, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of the types specified in searchTypes, starting at the node's pointer target.
static PointerTargetTree	makeInheritedTree(Synset synset, PointerType searchType, PointerType labelType, int pointerDepth, int ancestorDepth) Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of type searchType, starting at the node's pointer target.
static PointerTargetTree	makeInheritedTree(Synset synset, PointerType searchType, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of type searchType, starting at the node's pointer target.
static PointerTargetTreeNodeList	makeInheritedTreeList(PointerTargetTreeNodeList list, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Turn an existing tree list into an inheritance tree list.
static PointerTargetTreeNodeList	makePointerTargetTreeList(PointerTargetNodeList list, PointerType[] searchTypes, PointerType labelType, int depth, boolean allowRedundancies) Makes a nested list of pointer targets to depth depth, starting at each synset in list.
static PointerTargetTreeNodeList	makePointerTargetTreeList(PointerTargetNodeList list, PointerType searchType, PointerType labelType, int depth, boolean allowRedundancies) Makes a nested list of pointer targets to depth depth, starting at each synset in list.
static PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType searchType) Makes a nested list of pointer targets to the default depth, starting at synset.
static PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType[] searchTypes) Makes a nested list of pointer targets to the default depth, starting at synset.
static PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType[] searchTypes, int depth) Makes a nested list of pointer targets to depth depth, starting at synset.
static PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType[] searchTypes, PointerType labelType, int depth, boolean allowRedundancies) Makes a nested list of pointer targets to depth depth, starting at synset.
static PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType searchType, int depth) Makes a nested list of pointer targets to depth depth, starting at synset.
static PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType searchType, PointerType labelType, int depth, boolean allowRedundancies) Makes a nested list of pointer targets to depth depth, starting at synset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INFINITY

public static final int INFINITY

Representation of infinite depth. Used to tell the pointer operations to return all links to an infinite depth.

See Also:

Constant Field Values

Constructor Detail

PointerUtils

public PointerUtils()

Method Detail

getDirectHypernyms

public static PointerTargetNodeList getDirectHypernyms(Synset synset)
                                                throws JWNLException

Returns the immediate parents of synset.

Parameters:

synset - synset

Returns:

the immediate parents of synset

Throws:

JWNLException - JWNLException

getHypernymTree

public static PointerTargetTree getHypernymTree(Synset synset)
                                         throws JWNLException

Returns all of the ancestors of synset.

Parameters:

synset - synset

Returns:

all of the ancestors of synset

Throws:

JWNLException - JWNLException

getHypernymTree

public static PointerTargetTree getHypernymTree(Synset synset,
                                                int depth)
                                         throws JWNLException

Returns all of the ancestors of synset to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all of the ancestors of synset to depth depth

Throws:

JWNLException - JWNLException

getDirectHyponyms

public static PointerTargetNodeList getDirectHyponyms(Synset synset)
                                               throws JWNLException

Returns the immediate children of synset.

Parameters:

synset - synset

Returns:

the immediate children of synset

Throws:

JWNLException - JWNLException

getHyponymTree

public static PointerTargetTree getHyponymTree(Synset synset)
                                        throws JWNLException

Returns all of the children of synset.

Parameters:

synset - synset

Returns:

all of the children of synset

Throws:

JWNLException - JWNLException

getHyponymTree

public static PointerTargetTree getHyponymTree(Synset synset,
                                               int depth)
                                        throws JWNLException

Returns all of the children of synset to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all of the children of synset to depth depth

Throws:

JWNLException - JWNLException

getCoordinateTerms

public static PointerTargetNodeList getCoordinateTerms(Synset synset)
                                                throws JWNLException

Returns synset's siblings (the hyponyms of its hypernyms).

Parameters:

synset - synset

Returns:

synset's siblings (the hyponyms of its hypernyms)

Throws:

JWNLException - JWNLException

getAntonyms

public static PointerTargetNodeList getAntonyms(Synset synset)
                                         throws JWNLException

Returns the words that mean the opposite of synset.

Parameters:

synset - synset

Returns:

the words that mean the opposite of synset

Throws:

JWNLException - JWNLException

getExtendedAntonyms

public static PointerTargetTree getExtendedAntonyms(Synset synset)
                                             throws JWNLException

Returns the words that mean the opposite of synset and the immediate synonyms of those words.

Parameters:

synset - synset

Returns:

the words that mean the opposite of synset and the immediate synonyms of those words

Throws:

JWNLException - JWNLException

getExtendedAntonyms

public static PointerTargetTree getExtendedAntonyms(Synset synset,
                                                    int depth)
                                             throws JWNLException

Finds all antonyms of synset, and all synonyms of those antonyms to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all antonyms of synset, and all synonyms of those antonyms to depth depth

Throws:

JWNLException - JWNLException

getIndirectAntonyms

public static PointerTargetTree getIndirectAntonyms(Synset synset)
                                             throws JWNLException

Returns the immediate antonyms of all words that mean the same as synset.

Parameters:

synset - synset

Returns:

the immediate antonyms of all words that mean the same as synset

Throws:

JWNLException - JWNLException

getIndirectAntonyms

public static PointerTargetTree getIndirectAntonyms(Synset synset,
                                                    int depth)
                                             throws JWNLException

Returns the antonyms of all words that mean the same as synset to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

the antonyms of all words that mean the same as synset to depth depth

Throws:

JWNLException - JWNLException

getAttributes

public static PointerTargetNodeList getAttributes(Synset synset)
                                           throws JWNLException

Returns the attributes of synset.

Parameters:

synset - synset

Returns:

the attributes of synset

Throws:

JWNLException - JWNLException

getAlsoSees

public static PointerTargetNodeList getAlsoSees(Synset synset)
                                         throws JWNLException

Finds what words are related to synset.

Parameters:

synset - synset

Returns:

what words are related to synset

Throws:

JWNLException - JWNLException

getAlsoSeeTree

public static PointerTargetTree getAlsoSeeTree(Synset synset,
                                               int depth)
                                        throws JWNLException

Finds all See Also relations to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all See Also relations to depth depth

Throws:

JWNLException - JWNLException

getMeronyms

public static PointerTargetNodeList getMeronyms(Synset synset)
                                         throws JWNLException

Returns meronyms of synset.

Parameters:

synset - synset

Returns:

meronyms of synset

Throws:

JWNLException - JWNLException

getPartMeronyms

public static PointerTargetNodeList getPartMeronyms(Synset synset)
                                             throws JWNLException

Returns part meronyms of synset.

Parameters:

synset - synset

Returns:

part meronyms of synset

Throws:

JWNLException - JWNLException

getMemberMeronyms

public static PointerTargetNodeList getMemberMeronyms(Synset synset)
                                               throws JWNLException

Returns member meronyms of synset.

Parameters:

synset - synset

Returns:

member meronyms of synset

Throws:

JWNLException - JWNLException

getSubstanceMeronyms

public static PointerTargetNodeList getSubstanceMeronyms(Synset synset)
                                                  throws JWNLException

Returns substance meronyms of synset.

Parameters:

synset - synset

Returns:

substance meronyms of synset

Throws:

JWNLException - JWNLException

getInheritedMeronyms

public static PointerTargetTree getInheritedMeronyms(Synset synset)
                                              throws JWNLException

Returns meronyms of synset and of all its ancestors.

Parameters:

synset - synset

Returns:

meronyms of synset and of all its ancestors

Throws:

JWNLException - JWNLException

getInheritedMeronyms

public static PointerTargetTree getInheritedMeronyms(Synset synset,
                                                     int pointerDepth,
                                                     int ancestorDepth)
                                              throws JWNLException

Returns meronyms of each synset, to depth pointerDepth starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

ancestorDepth - ancestor depth

pointerDepth - pointer depth

Returns:

meronyms

Throws:

JWNLException - JWNLException

getInheritedPartMeronyms

public static PointerTargetTree getInheritedPartMeronyms(Synset synset)
                                                  throws JWNLException

Returns part meronyms of synset and of all its ancestors.

Parameters:

synset - synset

Returns:

part meronyms of synset and of all its ancestors

Throws:

JWNLException - JWNLException

getInheritedPartMeronyms

public static PointerTargetTree getInheritedPartMeronyms(Synset synset,
                                                         int pointerDepth,
                                                         int ancestorDepth)
                                                  throws JWNLException

Returns part meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

ancestorDepth - ancestor depth

pointerDepth - pointer depth

Returns:

part meronyms

Throws:

JWNLException - JWNLException

getInheritedMemberMeronyms

public static PointerTargetTree getInheritedMemberMeronyms(Synset synset)
                                                    throws JWNLException

Returns member meronyms of synset and of its ancestors.

Parameters:

synset - synset

Returns:

member meronyms

Throws:

JWNLException - JWNLException

getInheritedMemberMeronyms

public static PointerTargetTree getInheritedMemberMeronyms(Synset synset,
                                                           int pointerDepth,
                                                           int ancestorDepth)
                                                    throws JWNLException

Returns member meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

ancestorDepth - ancestor depth

pointerDepth - pointer depth

Returns:

member meronyms

Throws:

JWNLException - JWNLException

getInheritedSubstanceMeronyms

public static PointerTargetTree getInheritedSubstanceMeronyms(Synset synset)
                                                       throws JWNLException

Returns substance meronyms of synset and of its ancestors.

Parameters:

synset - synset

Returns:

substance meronyms of synset and of its ancestors

Throws:

JWNLException - JWNLException

getInheritedSubstanceMeronyms

public static PointerTargetTree getInheritedSubstanceMeronyms(Synset synset,
                                                              int pointerDepth,
                                                              int ancestorDepth)
                                                       throws JWNLException

Returns substance meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

ancestorDepth - ancestor depth

pointerDepth - pointer depth

Returns:

substance meronyms

Throws:

JWNLException - JWNLException

getHolonyms

public static PointerTargetNodeList getHolonyms(Synset synset)
                                         throws JWNLException

Returns holonyms of synset.

Parameters:

synset - synset

Returns:

holonyms of synset

Throws:

JWNLException - JWNLException

getPartHolonyms

public static PointerTargetNodeList getPartHolonyms(Synset synset)
                                             throws JWNLException

Returns part holonyms of synset.

Parameters:

synset - synset

Returns:

part holonyms of synset

Throws:

JWNLException - JWNLException

getMemberHolonyms

public static PointerTargetNodeList getMemberHolonyms(Synset synset)
                                               throws JWNLException

Returns member holonyms of synset.

Parameters:

synset - synset

Returns:

member holonyms of synset

Throws:

JWNLException - JWNLException

getSubstanceHolonyms

public static PointerTargetNodeList getSubstanceHolonyms(Synset synset)
                                                  throws JWNLException

Returns substance holonyms of synset.

Parameters:

synset - synset

Returns:

substance holonyms of synset

Throws:

JWNLException - JWNLException

getInheritedHolonyms

public static PointerTargetTree getInheritedHolonyms(Synset synset)
                                              throws JWNLException

Returns holonyms of synset and of all its ancestors.

Parameters:

synset - synset

Returns:

holonyms

Throws:

JWNLException - JWNLException

getInheritedHolonyms

public static PointerTargetTree getInheritedHolonyms(Synset synset,
                                                     int pointerDepth,
                                                     int ancestorDepth)
                                              throws JWNLException

Returns holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

ancestorDepth - ancestor depth

pointerDepth - pointer depth

Returns:

holonyms

Throws:

JWNLException - JWNLException

getInheritedPartHolonyms

public static PointerTargetTree getInheritedPartHolonyms(Synset synset)
                                                  throws JWNLException

Returns part holonyms of synset and of all its ancestors.

Parameters:

synset - synset

Returns:

part holonyms of synset and of all its ancestors

Throws:

JWNLException - JWNLException

getInheritedPartHolonyms

public static PointerTargetTree getInheritedPartHolonyms(Synset synset,
                                                         int pointerDepth,
                                                         int ancestorDepth)
                                                  throws JWNLException

Returns part holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

pointerDepth - pointer depth

ancestorDepth - ancestor depth

Returns:

part holonyms

Throws:

JWNLException - JWNLException

getInheritedMemberHolonyms

public static PointerTargetTree getInheritedMemberHolonyms(Synset synset)
                                                    throws JWNLException

Returns member holonyms of synset and of all its ancestors.

Parameters:

synset - synset

Returns:

member holonyms of synset and of all its ancestors

Throws:

JWNLException - JWNLException

getInheritedMemberHolonyms

public static PointerTargetTree getInheritedMemberHolonyms(Synset synset,
                                                           int pointerDepth,
                                                           int ancestorDepth)
                                                    throws JWNLException

Returns member holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

pointerDepth - pointer depth

ancestorDepth - ancestor depth

Returns:

member holonyms of each synset

Throws:

JWNLException - JWNLException

getInheritedSubstanceHolonyms

public static PointerTargetTree getInheritedSubstanceHolonyms(Synset synset)
                                                       throws JWNLException

Returns substance holonyms of synset and of all its ancestors.

Parameters:

synset - synset

Returns:

substance holonyms of synset and of all its ancestors

Throws:

JWNLException - JWNLException

getInheritedSubstanceHolonyms

public static PointerTargetTree getInheritedSubstanceHolonyms(Synset synset,
                                                              int pointerDepth,
                                                              int ancestorDepth)
                                                       throws JWNLException

Returns substance holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.

Parameters:

synset - synset

pointerDepth - pointer depth

ancestorDepth - ancestor depth

Returns:

substance holonyms

Throws:

JWNLException - JWNLException

getEntailments

public static PointerTargetNodeList getEntailments(Synset synset)
                                            throws JWNLException

Finds direct entailments of synset.

Parameters:

synset - synset

Returns:

direct entailments of synset

Throws:

JWNLException - JWNLException

getEntailmentTree

public static PointerTargetTree getEntailmentTree(Synset synset)
                                           throws JWNLException

Finds all entailments for synset.

Parameters:

synset - synset

Returns:

all entailments for synset

Throws:

JWNLException - JWNLException

getEntailmentTree

public static PointerTargetTree getEntailmentTree(Synset synset,
                                                  int depth)
                                           throws JWNLException

Finds all entailments for synset to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all entailments for synset to depth depth

Throws:

JWNLException - JWNLException

getCauses

public static PointerTargetNodeList getCauses(Synset synset)
                                       throws JWNLException

Finds direct cause links of synset.

Parameters:

synset - synset

Returns:

direct cause links of synset

Throws:

JWNLException - JWNLException

getCauseTree

public static PointerTargetTree getCauseTree(Synset synset)
                                      throws JWNLException

Finds all cause links for synset.

Parameters:

synset - synset

Returns:

all cause links for synset

Throws:

JWNLException - JWNLException

getCauseTree

public static PointerTargetTree getCauseTree(Synset synset,
                                             int depth)
                                      throws JWNLException

Finds all cause links for synset to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all cause links for synset to depth depth

Throws:

JWNLException - JWNLException

getVerbGroup

public static PointerTargetNodeList getVerbGroup(Synset synset)
                                          throws JWNLException

Returns the group that this verb belongs to.

Parameters:

synset - synset

Returns:

the group that this verb belongs to

Throws:

JWNLException - JWNLException

getParticipleOf

public static PointerTargetNodeList getParticipleOf(Synset synset)
                                             throws JWNLException

Finds participle of links of synset.

Parameters:

synset - synset

Returns:

participle of links of synset

Throws:

JWNLException - JWNLException

getSynonyms

public static PointerTargetNodeList getSynonyms(Synset synset)
                                         throws JWNLException

Returns the synonyms for synset. This is meant for adjectives. Synonyms to nouns and verbs are just their hypernyms.

Parameters:

synset - synset

Returns:

the synonyms for synset

Throws:

JWNLException - JWNLException

getSynonymTree

public static PointerTargetTree getSynonymTree(Synset synset,
                                               int depth)
                                        throws JWNLException

Returns all the synonyms of synset to depth depth.

Parameters:

synset - synset

depth - depth

Returns:

all the synonyms of synset to depth depth

Throws:

JWNLException - JWNLException

getPertainyms

public static PointerTargetNodeList getPertainyms(Synset synset)
                                           throws JWNLException

Returns the pertainyms for synset.

Parameters:

synset - synset

Returns:

the pertainyms for synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                                  PointerType searchType)
                                                           throws JWNLException

Makes a nested list of pointer targets to the default depth, starting at synset. Each level of the list is related to the previous level by a pointer of type searchType.

Parameters:

synset - synset

searchType - the pointer type to include in the pointer lists

Returns:

a nested list of pointer targets to depth depth, starting at synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                                  PointerType searchType,
                                                                  int depth)
                                                           throws JWNLException

Makes a nested list of pointer targets to depth depth, starting at synset. Each level of the list is related to the previous level by a pointer of type searchType.

Parameters:

synset - synset

searchType - the pointer type to include in the pointer lists

depth - depth

Returns:

a nested list of pointer targets to depth depth, starting at synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                                  PointerType searchType,
                                                                  PointerType labelType,
                                                                  int depth,
                                                                  boolean allowRedundancies)
                                                           throws JWNLException

Makes a nested list of pointer targets to depth depth, starting at synset. Each level of the list is related to the previous level by a pointer of type searchType.

Parameters:

searchType - the pointer type to include in the pointer lists

labelType - the type used to label each pointer target in the tree

depth - depth

allowRedundancies - if true, duplicate items will be included in the tree

synset - synset

Returns:

a nested list of pointer targets to depth depth, starting at synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                                  PointerType[] searchTypes)
                                                           throws JWNLException

Makes a nested list of pointer targets to the default depth, starting at synset. Each level of the list is related to the previous level by one of the pointer types specified by searchTypes.

Parameters:

synset - synset

searchTypes - the pointer types to include in the pointer lists

Returns:

a nested list of pointer targets to depth depth, starting at synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                                  PointerType[] searchTypes,
                                                                  int depth)
                                                           throws JWNLException

Makes a nested list of pointer targets to depth depth, starting at synset. Each level of the list is related to the previous level by one of the pointer types specified by searchTypes.

Parameters:

synset - synset

searchTypes - the pointer types to include in the pointer lists

depth - depth

Returns:

a nested list of pointer targets to depth depth, starting at synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                                  PointerType[] searchTypes,
                                                                  PointerType labelType,
                                                                  int depth,
                                                                  boolean allowRedundancies)
                                                           throws JWNLException

Makes a nested list of pointer targets to depth depth, starting at synset. Each level of the list is related to the previous level by one of the pointer types specified by searchTypes.

Parameters:

searchTypes - the pointer types to include in the pointer lists

labelType - the type used to label each pointer target in the tree

depth - depth

allowRedundancies - if true, duplicate items will be included in the tree

synset - synset

Returns:

a nested list of pointer targets to depth depth, starting at synset

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(PointerTargetNodeList list,
                                                                  PointerType searchType,
                                                                  PointerType labelType,
                                                                  int depth,
                                                                  boolean allowRedundancies)
                                                           throws JWNLException

Makes a nested list of pointer targets to depth depth, starting at each synset in list. Each level of the list is related to the previous level by a pointer of type searchType.

Parameters:

list - list

searchType - the pointer type to include in the pointer lists

labelType - the type used to label each pointer target in the tree

depth - depth

allowRedundancies - if true, duplicate items will be included in the tree

Returns:

a nested list of pointer targets to depth depth, starting at each synset in list

Throws:

JWNLException - JWNLException

makePointerTargetTreeList

public static PointerTargetTreeNodeList makePointerTargetTreeList(PointerTargetNodeList list,
                                                                  PointerType[] searchTypes,
                                                                  PointerType labelType,
                                                                  int depth,
                                                                  boolean allowRedundancies)
                                                           throws JWNLException

Makes a nested list of pointer targets to depth depth, starting at each synset in list. Each level of the list is related to the previous level by one of the pointer types specified by searchTypes.

Parameters:

searchTypes - the pointer types to include in the pointer lists

labelType - the type used to label each pointer target in the tree

depth - depth

allowRedundancies - if true, duplicate items will be included in the tree

list - list

Returns:

a nested list of pointer targets to depth depth, starting at each synset in list

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(Synset synset,
                                                  PointerType searchType)
                                           throws JWNLException

Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of type searchType, starting at the node's pointer target. This method uses the default depths.

Parameters:

synset - synset

searchType - the pointer type to include in the pointer lists

Returns:

a hypernym tree starting at synset

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(Synset synset,
                                                  PointerType searchType,
                                                  PointerType labelType,
                                                  int pointerDepth,
                                                  int ancestorDepth)
                                           throws JWNLException

Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of type searchType, starting at the node's pointer target.

Parameters:

searchType - pointer type

labelType - the type used to label each pointer target in the tree

pointerDepth - the depth to which to search for each pointer list

ancestorDepth - the depth to which to go to in the hypernym list

synset - synset

Returns:

a hypernym tree starting at synset

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(Synset synset,
                                                  PointerType searchType,
                                                  PointerType labelType,
                                                  int pointerDepth,
                                                  int ancestorDepth,
                                                  boolean allowRedundancies)
                                           throws JWNLException

Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of type searchType, starting at the node's pointer target.

Parameters:

searchType - pointer type

labelType - the type used to label each pointer target in the tree

pointerDepth - the depth to which to search for each pointer list

ancestorDepth - the depth to which to go to in the hypernym list

allowRedundancies - if true, duplicate items are allowed in the list

synset - synset

Returns:

a hypernym tree starting at synset

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(Synset synset,
                                                  PointerType[] searchTypes)
                                           throws JWNLException

Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of the types specified in searchTypes, starting at the node's pointer target. This method uses the default depths.

Parameters:

synset - synset

searchTypes - the pointer types to include in the pointer lists

Returns:

hypernym tree starting at synset

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(Synset synset,
                                                  PointerType[] searchTypes,
                                                  PointerType labelType,
                                                  int pointerDepth,
                                                  int ancestorDepth)
                                           throws JWNLException

Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of the types specified in searchTypes, starting at the node's pointer target.

Parameters:

searchTypes - the pointer types to include in the pointer lists

labelType - the type used to label each pointer target in the tree

pointerDepth - the depth to which to search for each pointer list

ancestorDepth - the depth to which to go to in the hypernym list

synset - synset

Returns:

hypernym tree starting at synset

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(Synset synset,
                                                  PointerType[] searchTypes,
                                                  PointerType labelType,
                                                  int pointerDepth,
                                                  int ancestorDepth,
                                                  boolean allowRedundancies)
                                           throws JWNLException

Creates a hypernym tree starting at synset, and add to each node a nested list pointer targets of the types specified in searchTypes, starting at the node's pointer target.

Parameters:

searchTypes - the pointer types to include in the pointer lists

labelType - the type used to label each pointer target in the tree

pointerDepth - the depth to which to search for each pointer list

ancestorDepth - the depth to which to go to in the hypernym list

allowRedundancies - if true, duplicate items are allowed in the list

synset - synset

Returns:

hypernym tree starting at synset

Throws:

JWNLException - JWNLException

makeInheritedTree

public static PointerTargetTree makeInheritedTree(PointerTargetTree tree,
                                                  PointerType[] searchTypes,
                                                  PointerType labelType,
                                                  int pointerDepth,
                                                  int ancestorDepth,
                                                  boolean allowRedundancies)
                                           throws JWNLException

Turn an existing tree into an inheritance tree.

Parameters:

tree - the tree to convert

searchTypes - the pointer types to include in the pointer lists

labelType - the type used to label each pointer target in the tree

pointerDepth - the depth to which to search for each pointer list

ancestorDepth - the depth to which to go to in tree

allowRedundancies - if true, duplicate items are allowed in the list

Returns:

inheritance tree

Throws:

JWNLException - JWNLException

makeInheritedTreeList

public static PointerTargetTreeNodeList makeInheritedTreeList(PointerTargetTreeNodeList list,
                                                              PointerType[] searchTypes,
                                                              PointerType labelType,
                                                              int pointerDepth,
                                                              int ancestorDepth,
                                                              boolean allowRedundancies)
                                                       throws JWNLException

Turn an existing tree list into an inheritance tree list.

Parameters:

list - the tree list to convert

searchTypes - the pointer types to include in the pointer lists

labelType - the type used to label each pointer target in the tree

pointerDepth - the depth to which to search for each pointer list

ancestorDepth - the depth to which to go to in tree

allowRedundancies - if true, duplicate items are allowed in the list

Returns:

inheritance tree list

Throws:

JWNLException - JWNLException