edu.stanford.nlp.semgraph.SemanticGraphEdge.java Source code

Introduction

Here is the source code for edu.stanford.nlp.semgraph.SemanticGraphEdge.java

Source

package edu.stanford.nlp.semgraph;

import java.io.Serializable;
import java.util.Comparator;

import edu.stanford.nlp.ling.IndexedWord;
import edu.stanford.nlp.trees.GrammaticalRelation;

/**
 * Represents an edge in the dependency graph. Equal only if source, target, and relation are equal.
 *
 * @author Christopher Cox
 * @author Teg Grenager
 * @see SemanticGraph
 */
public class SemanticGraphEdge implements Comparable<SemanticGraphEdge>, Serializable {

    public static boolean printOnlyRelation = false; // a hack for displaying SemanticGraph in JGraph.  Should be redone better.

    private GrammaticalRelation relation;
    private double weight;

    private boolean isExtra;

    private final IndexedWord source;
    private final IndexedWord target;

    /**
     * @param source The source IndexedWord for this edge
     * @param target The target IndexedWord for this edge
     * @param relation The relation between the two words represented by this edge
     * @param weight A score or weight to attach to the edge (not often used)
     * @param isExtra Whether or not the dependency this edge represents was "extra"
     */
    public SemanticGraphEdge(IndexedWord source, IndexedWord target, GrammaticalRelation relation, double weight,
            boolean isExtra) {
        this.source = source;
        this.target = target;
        this.relation = relation;
        this.weight = weight;
        this.isExtra = isExtra;
    }

    public SemanticGraphEdge(SemanticGraphEdge e) {
        this(e.getSource(), e.getTarget(), e.getRelation(), e.getWeight(), e.isExtra());
    }

    @Override
    public String toString() {
        if (!printOnlyRelation) {
            return getSource() + " -> " + getTarget() + " (" + getRelation() + ")";
        } else {
            return getRelation().toString();
        }
    }

    public GrammaticalRelation getRelation() {
        return relation;
    }

    public void setRelation(GrammaticalRelation relation) {
        this.relation = relation;
    }

    public IndexedWord getSource() {
        return source;
    }

    public IndexedWord getGovernor() {
        return getSource();
    }

    public IndexedWord getTarget() {
        return target;
    }

    public IndexedWord getDependent() {
        return getTarget();
    }

    public double getWeight() {
        return weight;
    }

    public void setWeight(double weight) {
        this.weight = weight;
    }

    public boolean isExtra() {
        return isExtra;
    }

    public void setIsExtra(boolean isExtra) {
        this.isExtra = isExtra;
    }

    /**
     * @return true if the edges are of the same relation type
     */
    public boolean typeEquals(SemanticGraphEdge e) {
        return (this.relation.equals(e.relation));
    }

    private static class SemanticGraphEdgeTargetComparator implements Comparator<SemanticGraphEdge> {

        public int compare(SemanticGraphEdge o1, SemanticGraphEdge o2) {
            int targetVal = o1.getTarget().compareTo(o2.getTarget());
            if (targetVal != 0) {
                return targetVal;
            }
            int sourceVal = o1.getSource().compareTo(o2.getSource());
            if (sourceVal != 0) {
                return sourceVal;
            }
            return o1.getRelation().toString().compareTo(o2.getRelation().toString()); // todo: cdm: surely we shouldn't have to do toString() now?
        }

    }

    private static Comparator<SemanticGraphEdge> targetComparator = new SemanticGraphEdgeTargetComparator();

    public static Comparator<SemanticGraphEdge> orderByTargetComparator() {
        return targetComparator;
    }

    /** Compares SemanticGraphEdges.
     * Warning: compares on the sources, targets, and then the STRINGS of the relations.
     * @param other Edge to compare to
     * @return Whether this is smaller, same, or larger
     */
    public int compareTo(SemanticGraphEdge other) {
        int sourceVal = getSource().compareTo(other.getSource());
        if (sourceVal != 0) {
            return sourceVal;
        }
        int targetVal = getTarget().compareTo(other.getTarget());
        if (targetVal != 0) {
            return targetVal;
        }
        String thisRelation = getRelation().toString();
        String thatRelation = other.getRelation().toString();
        return thisRelation.compareTo(thatRelation);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (!(o instanceof SemanticGraphEdge))
            return false;

        final SemanticGraphEdge semanticGraphEdge = (SemanticGraphEdge) o;

        if (relation != null) {
            boolean retFlag = relation.equals(semanticGraphEdge.relation);
            boolean govMatch = getGovernor().equals(semanticGraphEdge.getGovernor());
            boolean depMatch = getDependent().equals(semanticGraphEdge.getDependent());
            boolean matched = retFlag && govMatch && depMatch;
            return matched;
        }

        //   if (relation != null ? !relation.equals(semanticGraphEdge.relation) : semanticGraphEdge.relation != null) return false;
        return super.equals(o);
    }

    @Override
    public int hashCode() {
        int result;
        result = (relation != null ? relation.hashCode() : 0);
        result = 29 * result + (getSource() != null ? getSource().hashCode() : 0);
        result = 29 * result + (getTarget() != null ? getTarget().hashCode() : 0);
        return result;
    }

    private static final long serialVersionUID = 2L;

}