ixa.kaflib.Timex3 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kaflib-naf Show documentation
Kaflib-naf is a java library to create and edit NAF documents.
The newest version!
package ixa.kaflib;

import ixa.kaflib.KAFDocument.AnnotationType;
import ixa.kaflib.KAFDocument.Utils;

import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;


/** The coreference layer creates clusters of term spans (which we call mentions) which share the same referent. For instance, “London” and “the capital city of England” are two mentions referring to the same entity. It is said that those mentions corefer. */
public class Timex3 extends IdentifiableAnnotation implements TLinkReferable {

    /** Timex3's type (required)*/
    private String type;

    private Timex3 beginPoint;
    
    private Timex3 endPoint;

    private String quant;

    private String freq;

    /** Timex3's functionInDocument */
    private String functionInDocument;

    private Boolean temporalFunction;

    /** Timex3's value */
    private String value;

    private String valueFromFunction;

    private String mod;

    private String anchorTimeId;

    private String comment;

    private Span span;

    /** Mentions to the same entity (at least one required) */
    //private List> mentions;

    Timex3(String id, String type){
        super(id);
	this.type = type;
	//this.mentions = new ArrayList>();
    }

    /*
    Timex3(String timex3id, List> mentions) {
	if (mentions.size() < 1) {
	    throw new IllegalStateException("Timex3 must contain at least one reference span");
	}
	if (mentions.get(0).size() < 1) {
	   throw new IllegalStateException("Timex3' reference's spans must contain at least one target");
	}
	this.timex3id = timex3id;
	this.mentions = mentions;
    }
    */

    /*
    Timex3(Timex3 timex3, HashMap WFs) {
	this.timex3id = timex3.timex3id;
	this.type = timex3.type;

	String id = timex3.getId();
	this.mentions = new ArrayList>();
	for (Span span : timex3.getSpans()) {

	    List targets = span.getTargets();
	    List copiedTargets = new ArrayList();
	    for (WF wf : targets) {
		WF copiedWF = WFs.get(wf.getId());
		if (copiedWF == null) {
		    throw new IllegalStateException("Term not found when copying " + id);
		}
		copiedTargets.add(copiedWF);
	    }
	    if (span.hasHead()) {
		WF copiedHead = WFs.get(span.getHead().getId());
		this.mentions.add(new Span(copiedTargets, copiedHead));
	    }
	    else {
		this.mentions.add(new Span(copiedTargets));
	    }
	}
    }
    */

    public String getType() {
	return type;
    }

    public void setType(String type){
	this.type = type;
    }

    public boolean hasBeginPoint() {
	return this.beginPoint != null;
    }

    public Timex3 getBeginPoint() {
	return this.beginPoint;
    }

    public void setBeginPoint(Timex3 beginPoint) {
	this.beginPoint = beginPoint;
    }

    public boolean hasEndPoint() {
	return this.endPoint != null;
    }

    public Timex3 getEndPoint() {
	return this.endPoint;
    }

    public void setEndPoint(Timex3 endPoint) {
	this.endPoint = endPoint;
    }

    public boolean hasFreq() {
	return this.freq != null;
    }

    public String getFreq() {
	return this.freq;
    }

    public void setFreq(String freq) {
	this.freq = freq;
    }

    public boolean hasQuant() {
	return this.quant != null;
    }

    public String getQuant() {
	return this.quant;
    }

    public void setQuant(String quant) {
	this.quant = quant;
    }

    public boolean hasFunctionInDocument() {
	return this.functionInDocument != null;
    }

    public String getFunctionInDocument() {
	return this.functionInDocument;
    }

    public void setFunctionInDocument(String functionInDocument) {
	this.functionInDocument = functionInDocument;
    }

    public boolean hasTemporalFunction() {
	return this.temporalFunction != null;
    }

    public Boolean getTemporalFunction() {
	return this.temporalFunction;
    }

    public void setTemporalFunction(Boolean temporalFunction) {
	this.temporalFunction = temporalFunction;
    }

    public boolean hasValue() {
	return this.value != null;
    }

    public String getValue() {
	return value;
    }

    public void setValue(String value){
	this.value = value;
    }

    public boolean hasValueFromFunction() {
	return this.valueFromFunction != null;
    }

    public String getValueFromFunction() {
	return this.valueFromFunction;
    }

    public void setValueFromFunction(String valueFromFunction) {
	this.valueFromFunction = valueFromFunction;
    }

    public boolean hasMod() {
	return this.mod != null;
    }

    public String getMod() {
	return this.mod;
    }

    public void setMod(String mod) {
	this.mod = mod;
    }

    public boolean hasAnchorTimeId() {
	return this.anchorTimeId != null;
    }

    public String getAnchorTimeId() {
	return this.anchorTimeId;
    }

    public void setAnchorTimeId(String anchorTimeId) {
	this.anchorTimeId = anchorTimeId;
    }

    public boolean hasComment() {
	return this.comment != null;
    }

    public String getComment() {
	return this.comment;
    }

    public void setComment(String comment) {
	this.comment = comment;
    }
    
    /*
    public Integer getSent() {
	return this.span.getFirstTarget().getSent();
    }
    
    public Integer getPara() {
	return this.span.getFirstTarget().getPara();
    }
    */

    public boolean hasSpan() {
	return this.span != null;
    }

    public Span getSpan() {
	return this.span;
    }

    public void setSpan(Span span) {
	this.span = span;
    }

    public String getSpanStr(Span span) {
	String str = "";
	for (WF wf : span.getTargets()) {
	    if (!str.isEmpty()) {
		str += " ";
	    }
	    str += wf.getForm();
	}
	return str;
    }
    
    Map> getReferencedAnnotations() {
	Map> referenced = new HashMap>();
	List wfs = new ArrayList();
	if (this.span != null) {
	    wfs.addAll((List)(List) this.span.getTargets());
	}
	referenced.put(AnnotationType.WF, wfs);
	return referenced;
    }

    /*
    @Override
    public boolean equals(Object o) {
	if (this == o) return true;
	if (!(o instanceof Timex3)) return false;
	Timex3 ann = (Timex3) o;
	return Utils.areEquals(this.type, ann.type) &&
		Utils.areEquals(this.beginPoint, ann.beginPoint) &&
		Utils.areEquals(this.endPoint, ann.endPoint) &&
		Utils.areEquals(this.quant, ann.quant) &&
		Utils.areEquals(this.freq, ann.freq) &&
		Utils.areEquals(this.functionInDocument, ann.functionInDocument) &&
		Utils.areEquals(this.temporalFunction, ann.temporalFunction) &&
		Utils.areEquals(this.value, ann.value) &&
		Utils.areEquals(this.valueFromFunction, ann.valueFromFunction) &&
		Utils.areEquals(this.mod, ann.mod) &&
		Utils.areEquals(this.anchorTimeId, ann.anchorTimeId) &&
		Utils.areEquals(this.comment, ann.comment) &&
		Utils.areEquals(this.span, ann.span);
    }
    */
}