/**
* NOTE: This compareTo is based on and made to be compatible with the one from
* IndexedFeatureLabel. You <em>must</em> have a DocIDAnnotation, SentenceIndexAnnotation, and
* IndexAnnotation for this to make sense and be guaranteed to work properly. Currently, it won't
* error out and will try to return something sensible if these are not defined, but that really
* isn't proper usage!
*
* <p>This compareTo method is based not by value elements like the word(), but on passage
* position. It puts NO_WORD elements first, and then orders by document, sentence, and word
* index. If these do not differ, it returns equal.
*
* @param w The IndexedWord to compare with
* @return Whether this is less than w or not in the ordering
*/
@Override
public int compareTo(IndexedWord w) {
if (this.equals(IndexedWord.NO_WORD)) {
if (w.equals(IndexedWord.NO_WORD)) {
return 0;
} else {
return -1;
}
}
if (w.equals(IndexedWord.NO_WORD)) {
return 1;
}
// Override the default comparator if pseudo-positions are set.
// This is needed for splicing trees together awkwardly in OpenIE.
if (!Double.isNaN(w.pseudoPosition) || !Double.isNaN(this.pseudoPosition)) {
double val = this.pseudoPosition() - w.pseudoPosition();
if (val < 0) {
return -1;
}
if (val > 0) {
return 1;
} else {
return 0;
}
}
// Otherwise, compare using the normal doc/sentence/token index hierarchy
String docID = this.getString(CoreAnnotations.DocIDAnnotation.class);
int docComp = docID.compareTo(w.getString(CoreAnnotations.DocIDAnnotation.class));
if (docComp != 0) return docComp;
int sentComp = sentIndex() - w.sentIndex();
if (sentComp != 0) return sentComp;
int indexComp = index() - w.index();
if (indexComp != 0) return indexComp;
return copyCount() - w.copyCount();
}
