net.didion.jwnl.data

Class PointerUtils

java.lang.Object

net.didion.jwnl.data.PointerUtils

public final class PointerUtils
extends java.lang.Object

This class constains 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.
private static PointerUtils	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PointerUtils()

Method Summary

Modifier and Type	Method and Description
PointerTargetNodeList	getAlsoSees(Synset synset) Find what words are related to synset
PointerTargetTree	getAlsoSeeTree(Synset synset, int depth) Find all See Also relations to depth depth.
PointerTargetNodeList	getAntonyms(Synset synset) Get the words that mean the opposite of synset
PointerTargetNodeList	getAttributes(Synset synset) Get the attributes of synset
PointerTargetNodeList	getCauses(Synset synset) Find direct cause links of synset
PointerTargetTree	getCauseTree(Synset synset) Find all cause links for synset.
PointerTargetTree	getCauseTree(Synset synset, int depth) Find all cause links for synset to depth depth.
PointerTargetNodeList	getCoordinateTerms(Synset synset) Get synset's siblings (the hyponyms of its hypernyms)
PointerTargetNodeList	getDerived(Synset synset) Find derrived links of synset
PointerTargetNodeList	getDirectHypernyms(Synset synset) Get the immediate parents of synset
PointerTargetNodeList	getDirectHyponyms(Synset synset) Get the immediate children of synset
PointerTargetNodeList	getEntailedBy(Synset synset) Find direct entailed bys of synset
PointerTargetTree	getEntailedByTree(Synset synset) Find all entailed bys of synset.
PointerTargetTree	getEntailedByTree(Synset synset, int depth) Find all entailed bys of synset to depth depth.
PointerTargetNodeList	getEntailments(Synset synset) Find direct entailments of synset
PointerTargetTree	getEntailmentTree(Synset synset) Find all entailments for synset
PointerTargetTree	getEntailmentTree(Synset synset, int depth) Find all entailments for synset to depth depth
PointerTargetTree	getExtendedAntonyms(Synset synset) Get the words that mean the opposite of synset and the immediate synonyms of those words
PointerTargetTree	getExtendedAntonyms(Synset synset, int depth) Find all antonyms of synset, and all synonyms of those antonyms to depth depth.
PointerTargetNodeList	getHolonyms(Synset synset) Get holonyms of synset
PointerTargetTree	getHypernymTree(Synset synset) Get all of the ancestors of synset
PointerTargetTree	getHypernymTree(Synset synset, int depth) Get all of the ancestors of synset to depth depth
PointerTargetTree	getHyponymTree(Synset synset) Get all of the children of synset
PointerTargetTree	getHyponymTree(Synset synset, int depth) Get all of the children of synset to depth depth
PointerTargetTree	getIndirectAntonyms(Synset synset) Get the immediate antonyms of all words that mean the same as synset.
PointerTargetTree	getIndirectAntonyms(Synset synset, int depth) Get the antonyms of all words that mean the same as synset to depth depth.
PointerTargetTree	getInheritedHolonyms(Synset synset) Get holonyms of synset and of all its ancestors
PointerTargetTree	getInheritedHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Get holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedMemberHolonyms(Synset synset) Get member holonyms of synset and of all its ancestors
PointerTargetTree	getInheritedMemberHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Get member holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedMemberMeronyms(Synset synset) Get member meronyms of synset and of its ancestors
PointerTargetTree	getInheritedMemberMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Get member meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Get meronyms of each synset, to depth pointerDepth starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedPartHolonyms(Synset synset) Get part holonyms of synset and of all its ancestors
PointerTargetTree	getInheritedPartHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Get part holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedPartMeronyms(Synset synset) Get part meronyms of synset and of all its ancestors
PointerTargetTree	getInheritedPartMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Get part meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedSubstanceHolonyms(Synset synset) Get substance holonyms of synset and of all its ancestors
PointerTargetTree	getInheritedSubstanceHolonyms(Synset synset, int pointerDepth, int ancestorDepth) Get substance holonyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
PointerTargetTree	getInheritedSubstanceMeronyms(Synset synset) Get substance meronyms of synset and of its ancestors
PointerTargetTree	getInheritedSubstanceMeronyms(Synset synset, int pointerDepth, int ancestorDepth) Get substance meronyms of each synset, to depth pointerDepth, starting at synset and going for all of synset's ancestors to depth ancestorDepth.
static PointerUtils	getInstance()
PointerTargetTree	getInteritedMeronyms(Synset synset) Get meronyms of synset and of all its ancestors
PointerTargetNodeList	getMemberHolonyms(Synset synset) Get member holonyms of synset
PointerTargetNodeList	getMemberMeronyms(Synset synset) Get member meronyms of synset
PointerTargetNodeList	getMeronyms(Synset synset) Get meronyms of synset.
PointerTargetNodeList	getPartHolonyms(Synset synset) Get part holonyms of synset
PointerTargetNodeList	getParticipleOf(Synset synset) Find participle of links of synset
PointerTargetNodeList	getPartMeronyms(Synset synset) Get part meronyms of synset
private PointerTargetNodeList	getPointerTargets(Synset synset, PointerType type) Get all the pointer targets of synset of type type.
PointerTargetNodeList	getSubstanceHolonyms(Synset synset) Get substance holonyms of synset
PointerTargetNodeList	getSubstanceMeronyms(Synset synset) Get substance meronyms of synset
PointerTargetNodeList	getSynonyms(Synset synset) Get the synonyms for synset.
PointerTargetTree	getSynonymTree(Synset synset, int depth) Get all the synonyms of synset to depth depth.
PointerTargetNodeList	getVerbGroup(Synset synset) Get the group that this verb belongs to.
PointerTargetTree	makeInheritedTree(PointerTargetTree tree, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Turn an existing tree into an inheritance tree.
PointerTargetTree	makeInheritedTree(Synset synset, PointerType searchType) Create 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.
PointerTargetTree	makeInheritedTree(Synset synset, PointerType[] searchTypes) Create 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.
PointerTargetTree	makeInheritedTree(Synset synset, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth) Create 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.
PointerTargetTree	makeInheritedTree(Synset synset, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Create 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.
PointerTargetTree	makeInheritedTree(Synset synset, PointerType searchType, PointerType labelType, int pointerDepth, int ancestorDepth) Create 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.
PointerTargetTree	makeInheritedTree(Synset synset, PointerType searchType, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Create 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.
PointerTargetTreeNodeList	makeInheritedTreeList(PointerTargetTreeNodeList list, PointerType[] searchTypes, PointerType labelType, int pointerDepth, int ancestorDepth, boolean allowRedundancies) Turn an existing tree list into an inheritance tree list.
PointerTargetTreeNodeList	makePointerTargetTreeList(PointerTargetNodeList list, PointerType[] searchTypes, PointerType labelType, int depth, boolean allowRedundancies) Make a nested list of pointer targets to depth depth, starting at each synset in list.
PointerTargetTreeNodeList	makePointerTargetTreeList(PointerTargetNodeList list, PointerType searchType, PointerType labelType, int depth, boolean allowRedundancies) Make a nested list of pointer targets to depth depth, starting at each synset in list.
PointerTargetTreeNodeList	makePointerTargetTreeList(Synset set, PointerType searchType) Make a nested list of pointer targets to the default depth, starting at synset.
PointerTargetTreeNodeList	makePointerTargetTreeList(Synset set, PointerType[] searchTypes) Make a nested list of pointer targets to the default depth, starting at synset.
PointerTargetTreeNodeList	makePointerTargetTreeList(Synset set, PointerType[] searchTypes, int depth) Make a nested list of pointer targets to depth depth, starting at synset.
PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType[] searchTypes, PointerType labelType, int depth, boolean allowRedundancies) Make a nested list of pointer targets to depth depth, starting at synset.
private PointerTargetTreeNodeList	makePointerTargetTreeList(Synset synset, PointerType[] searchTypes, PointerType labelType, int depth, boolean allowRedundancies, PointerTargetTreeNode parent)
PointerTargetTreeNodeList	makePointerTargetTreeList(Synset set, PointerType searchType, int depth) Make a nested list of pointer targets to depth depth, starting at synset.
PointerTargetTreeNodeList	makePointerTargetTreeList(Synset set, PointerType searchType, PointerType labelType, int depth, boolean allowRedundancies) Make 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

INSTANCE

private static final PointerUtils INSTANCE

Constructor Detail

PointerUtils

private PointerUtils()

Method Detail

getInstance

public static PointerUtils getInstance()

getDirectHypernyms

public PointerTargetNodeList getDirectHypernyms(Synset synset)
                                         throws JWNLException

Get the immediate parents of synset

Throws:

JWNLException

getHypernymTree

public PointerTargetTree getHypernymTree(Synset synset)
                                  throws JWNLException

Get all of the ancestors of synset

Throws:

JWNLException

getHypernymTree

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

Get all of the ancestors of synset to depth depth

Throws:

JWNLException

getDirectHyponyms

public PointerTargetNodeList getDirectHyponyms(Synset synset)
                                        throws JWNLException

Get the immediate children of synset

Throws:

JWNLException

getHyponymTree

public PointerTargetTree getHyponymTree(Synset synset)
                                 throws JWNLException

Get all of the children of synset

Throws:

JWNLException

getHyponymTree

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

Get all of the children of synset to depth depth

Throws:

JWNLException

getCoordinateTerms

public PointerTargetNodeList getCoordinateTerms(Synset synset)
                                         throws JWNLException

Get synset's siblings (the hyponyms of its hypernyms)

Throws:

JWNLException

getAntonyms

public PointerTargetNodeList getAntonyms(Synset synset)
                                  throws JWNLException

Get the words that mean the opposite of synset

Throws:

JWNLException

getExtendedAntonyms

public PointerTargetTree getExtendedAntonyms(Synset synset)
                                      throws JWNLException

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

Throws:

JWNLException

getExtendedAntonyms

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

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

Throws:

JWNLException

getIndirectAntonyms

public PointerTargetTree getIndirectAntonyms(Synset synset)
                                      throws JWNLException

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

Throws:

JWNLException

getIndirectAntonyms

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

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

Throws:

JWNLException

getAttributes

public PointerTargetNodeList getAttributes(Synset synset)
                                    throws JWNLException

Get the attributes of synset

Throws:

JWNLException

getAlsoSees

public PointerTargetNodeList getAlsoSees(Synset synset)
                                  throws JWNLException

Find what words are related to synset

Throws:

JWNLException

getAlsoSeeTree

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

Find all See Also relations to depth depth.

Throws:

JWNLException

getMeronyms

public PointerTargetNodeList getMeronyms(Synset synset)
                                  throws JWNLException

Get meronyms of synset.

Throws:

JWNLException

getPartMeronyms

public PointerTargetNodeList getPartMeronyms(Synset synset)
                                      throws JWNLException

Get part meronyms of synset

Throws:

JWNLException

getMemberMeronyms

public PointerTargetNodeList getMemberMeronyms(Synset synset)
                                        throws JWNLException

Get member meronyms of synset

Throws:

JWNLException

getSubstanceMeronyms

public PointerTargetNodeList getSubstanceMeronyms(Synset synset)
                                           throws JWNLException

Get substance meronyms of synset

Throws:

JWNLException

getInteritedMeronyms

public PointerTargetTree getInteritedMeronyms(Synset synset)
                                       throws JWNLException

Get meronyms of synset and of all its ancestors

Throws:

JWNLException

getInheritedMeronyms

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

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

Throws:

JWNLException

getInheritedPartMeronyms

public PointerTargetTree getInheritedPartMeronyms(Synset synset)
                                           throws JWNLException

Get part meronyms of synset and of all its ancestors

Throws:

JWNLException

getInheritedPartMeronyms

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

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

Throws:

JWNLException

getInheritedMemberMeronyms

public PointerTargetTree getInheritedMemberMeronyms(Synset synset)
                                             throws JWNLException

Get member meronyms of synset and of its ancestors

Throws:

JWNLException

getInheritedMemberMeronyms

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

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

Throws:

JWNLException

getInheritedSubstanceMeronyms

public PointerTargetTree getInheritedSubstanceMeronyms(Synset synset)
                                                throws JWNLException

Get substance meronyms of synset and of its ancestors

Throws:

JWNLException

getInheritedSubstanceMeronyms

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

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

Throws:

JWNLException

getHolonyms

public PointerTargetNodeList getHolonyms(Synset synset)
                                  throws JWNLException

Get holonyms of synset

Throws:

JWNLException

getPartHolonyms

public PointerTargetNodeList getPartHolonyms(Synset synset)
                                      throws JWNLException

Get part holonyms of synset

Throws:

JWNLException

getMemberHolonyms

public PointerTargetNodeList getMemberHolonyms(Synset synset)
                                        throws JWNLException

Get member holonyms of synset

Throws:

JWNLException

getSubstanceHolonyms

public PointerTargetNodeList getSubstanceHolonyms(Synset synset)
                                           throws JWNLException

Get substance holonyms of synset

Throws:

JWNLException

getInheritedHolonyms

public PointerTargetTree getInheritedHolonyms(Synset synset)
                                       throws JWNLException

Get holonyms of synset and of all its ancestors

Throws:

JWNLException

getInheritedHolonyms

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

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

Throws:

JWNLException

getInheritedPartHolonyms

public PointerTargetTree getInheritedPartHolonyms(Synset synset)
                                           throws JWNLException

Get part holonyms of synset and of all its ancestors

Throws:

JWNLException

getInheritedPartHolonyms

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

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

Throws:

JWNLException

getInheritedMemberHolonyms

public PointerTargetTree getInheritedMemberHolonyms(Synset synset)
                                             throws JWNLException

Get member holonyms of synset and of all its ancestors

Throws:

JWNLException

getInheritedMemberHolonyms

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

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

Throws:

JWNLException

getInheritedSubstanceHolonyms

public PointerTargetTree getInheritedSubstanceHolonyms(Synset synset)
                                                throws JWNLException

Get substance holonyms of synset and of all its ancestors

Throws:

JWNLException

getInheritedSubstanceHolonyms

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

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

Throws:

JWNLException

getEntailments

public PointerTargetNodeList getEntailments(Synset synset)
                                     throws JWNLException

Find direct entailments of synset

Throws:

JWNLException

getEntailmentTree

public PointerTargetTree getEntailmentTree(Synset synset)
                                    throws JWNLException

Find all entailments for synset

Throws:

JWNLException

getEntailmentTree

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

Find all entailments for synset to depth depth

Throws:

JWNLException

getEntailedBy

public PointerTargetNodeList getEntailedBy(Synset synset)
                                    throws JWNLException

Find direct entailed bys of synset

Throws:

JWNLException

getEntailedByTree

public PointerTargetTree getEntailedByTree(Synset synset)
                                    throws JWNLException

Find all entailed bys of synset.

Throws:

JWNLException

getEntailedByTree

public PointerTargetTree getEntailedByTree(Synset synset,
                                           int depth)
                                    throws JWNLException

Find all entailed bys of synset to depth depth.

Throws:

JWNLException

getCauses

public PointerTargetNodeList getCauses(Synset synset)
                                throws JWNLException

Find direct cause links of synset

Throws:

JWNLException

getCauseTree

public PointerTargetTree getCauseTree(Synset synset)
                               throws JWNLException

Find all cause links for synset.

Throws:

JWNLException

getCauseTree

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

Find all cause links for synset to depth depth.

Throws:

JWNLException

getVerbGroup

public PointerTargetNodeList getVerbGroup(Synset synset)
                                   throws JWNLException

Get the group that this verb belongs to.

Throws:

JWNLException

getParticipleOf

public PointerTargetNodeList getParticipleOf(Synset synset)
                                      throws JWNLException

Find participle of links of synset

Throws:

JWNLException

getDerived

public PointerTargetNodeList getDerived(Synset synset)
                                 throws JWNLException

Find derrived links of synset

Throws:

JWNLException

getSynonyms

public PointerTargetNodeList getSynonyms(Synset synset)
                                  throws JWNLException

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

Throws:

JWNLException

getSynonymTree

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

Get all the synonyms of synset to depth depth.

Throws:

JWNLException

getPointerTargets

private PointerTargetNodeList getPointerTargets(Synset synset,
                                                PointerType type)
                                         throws JWNLException

Get all the pointer targets of synset of type type.

Throws:

JWNLException

makePointerTargetTreeList

public PointerTargetTreeNodeList makePointerTargetTreeList(Synset set,
                                                           PointerType searchType)
                                                    throws JWNLException

Make 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.

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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.

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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:

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

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

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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.

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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.

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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:

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

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

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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:

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

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

Throws:

JWNLException

makePointerTargetTreeList

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

Make 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:

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

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

Throws:

JWNLException

makePointerTargetTreeList

private PointerTargetTreeNodeList makePointerTargetTreeList(Synset synset,
                                                            PointerType[] searchTypes,
                                                            PointerType labelType,
                                                            int depth,
                                                            boolean allowRedundancies,
                                                            PointerTargetTreeNode parent)
                                                     throws JWNLException

Throws:

JWNLException

makeInheritedTree

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

Create 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.

Throws:

JWNLException

makeInheritedTree

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

Create 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:

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

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

Throws:

JWNLException

makeInheritedTree

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

Create 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:

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

Throws:

JWNLException

makeInheritedTree

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

Create 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.

Throws:

JWNLException

makeInheritedTree

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

Create 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:

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

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

Throws:

JWNLException

makeInheritedTree

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

Create 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:

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

Throws:

JWNLException

makeInheritedTree

public 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 PointerType with which to label each pointer

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

Throws:

JWNLException

makeInheritedTreeList

public 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 PointerType with which to label each pointer

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

Throws:

JWNLException