net.didion.jwnl.data.relationship
Class AsymmetricRelationship

java.lang.Object
  net.didion.jwnl.data.relationship.Relationship
      net.didion.jwnl.data.relationship.AsymmetricRelationship

public class AsymmetricRelationship
extends Relationship

An asymmetric relationship is one whose source and target synsets have lineages with a definite divergence point. The commonParentIndex is the index of the node in the relationship that represents this divergence point.

For example, in finding a hypernym relationship between dog and cat, the relationship is dog -> canine -> carnivore -> feline -> cat. The ancestry of "dog" and the ancestry of "cat" diverge at "carnivore," so the common parent index is thus 2.

Constructor Summary

AsymmetricRelationship(PointerType type, PointerTargetNodeList nodes, int commonParentIndex, Synset sourceSynset, Synset targetSynset)

Method Summary

int	getCommonParentIndex()
int	getRelativeTargetDepth() Get the depth of the target, from the commonParentIndex, relative to the depth of the source.
Relationship	reverse()

Methods inherited from class net.didion.jwnl.data.relationship.Relationship

equals, getDepth, getNodeList, getSize, getSourcePointerTarget, getSourceSynset, getTargetPointerTarget, getTargetSynset, getType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AsymmetricRelationship

public AsymmetricRelationship(PointerType type,
                              PointerTargetNodeList nodes,
                              int commonParentIndex,
                              Synset sourceSynset,
                              Synset targetSynset)

Method Detail

getCommonParentIndex

public int getCommonParentIndex()

getRelativeTargetDepth

public int getRelativeTargetDepth()

Get the depth of the target, from the commonParentIndex, relative to the depth of the source. If both target and source are eqidistant from the commonParentIndex, this method returns 0;

reverse

public Relationship reverse()

Specified by:

reverse in class Relationship