TextualReference.java

package io.github.infolis.model;

import io.github.infolis.util.SerializationUtils;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.google.common.base.Function;
import com.google.common.collect.Lists;

/**
 * Class for saving contexts (= surrounding words of a term).
 *
 * @author kata
 * @author kba
 *
 */
@XmlRootElement(name = "context")
@XmlAccessorType(XmlAccessType.FIELD)
@JsonIgnoreProperties(ignoreUnknown = true)
public class TextualReference extends BaseModel {

	@XmlTransient
	private List<String>	leftWords;
	@XmlTransient
	private List<String>	rightWords;
	private String			leftText;
	private String			rightText;
	@XmlAttribute
	private String			reference;
	@XmlAttribute
	private String			textFile;
	private String			pattern;
	private String			mentionsReference;
	private double			referenceReliability;


    public TextualReference() {
    	this.leftWords = new ArrayList<>();
        this.rightWords = new ArrayList<>();
        this.leftText = " ";
        this.rightText = " ";
    }

    // TODO set reference, term param is ignored...
    public TextualReference(String term) {
        this.leftText = "";
        this.rightText = "";
        this.leftWords = new ArrayList<>();
        this.rightWords = new ArrayList<>();
        //this.reference = term;
        this.textFile = "";
        this.pattern = "";
        this.mentionsReference = "";
    }

    public TextualReference(String leftText, String reference, String rightText, String textFile, String pattern, String mentionsReference) {
        setLeftText(leftText);
        setRightText(rightText);
        this.reference = reference;
        this.textFile = textFile;
        this.pattern = pattern;
        this.mentionsReference = mentionsReference;
    }

	public String toXML() {
		return "\t<context reference=\"" + SerializationUtils.escapeXML(this.getReference()) + "\" textFile=\""
				+ this.getTextFile() + "\">" 
				+ System.getProperty("line.separator") 
				+ "\t\t<leftText>" + this.getLeftText() + "</leftText>"
				+ System.getProperty("line.separator") 
				+ "\t\t<rightText>"	+ this.getRightText() + "</rightText>" 
				+ System.getProperty("line.separator")
				+ "\t\t<pattern>" + this.getPattern() + "</pattern>"
                + "\t\t<mentionsReference>" + this.getMentionsReference() + "</mentionsReference>" 
                + System.getProperty("line.separator")
                + "\t\t<referenceReliability>" + this.getReferenceReliability() + "</referenceReliability>" 
				+ System.getProperty("line.separator")
				+ "\t</context>" + System.getProperty("line.separator");
	}

	@Override
	public String toString() {
		return this.getLeftText() + this.getReference() + this.getRightText();
	}

	@JsonIgnore
	public String getContextWithoutTerm() {
		return this.getLeftText() + " " + this.getRightText();
	}

	public List<String> getLeftWords() {
		return leftWords;
	}

	public void setLeftWords(List<String> leftWords) {
		this.leftWords = leftWords;
	}

	public List<String> getRightWords() {
		return rightWords;
	}

	public void setRightWords(List<String> rightWords) {
		this.rightWords = rightWords;
	}

	public String getLeftText() {
		return leftText;
	}

	// split words on whitespace but keep information on whether text was separated from term by whitespace or not
	public void setLeftText(String leftText) {
		this.leftText = leftText;
        String[] leftWordsArray = leftText.split("\\s+");
        String lastChar = leftText.substring(leftText.length() -1, leftText.length());
        List<String> leftWords;
        String[]_leftWordsArray = new String[leftWordsArray.length + 1];
        System.arraycopy(leftWordsArray, 0, _leftWordsArray, 0, leftWordsArray.length);
        if (lastChar.matches("\\s")) _leftWordsArray[_leftWordsArray.length -1] = lastChar;
        else _leftWordsArray[_leftWordsArray.length -1] = "";
        leftWords = (Arrays.asList(_leftWordsArray));
        setLeftWords(leftWords);
	}

	public String getRightText() {
		return rightText;
	}
	// split words on whitespace but keep information on whether text was separated from term by whitespace or not// split words on whitespace but keep whitespace separating text from term
	public void setRightText(String rightText) {
		this.rightText = rightText;
		String[] rightWordsArray = rightText.trim().split("\\s+");
		String firstChar = rightText.substring(0, 1);
        List<String> rightWords;
        String[]_rightWordsArray = new String[rightWordsArray.length + 1];
        System.arraycopy(rightWordsArray, 0, _rightWordsArray, 1, rightWordsArray.length);
        if (firstChar.matches("\\s")) _rightWordsArray[0] = firstChar;
        else _rightWordsArray[0] = "";
        rightWords = (Arrays.asList(_rightWordsArray));
        setRightWords(rightWords);
	}

	public String getReference() {
		return reference;
	}

	public void setReference(String reference) {
		this.reference = reference;
	}

	public String getTextFile() {
		return textFile;
	}

	public void setTextFile(String file) {
		this.textFile = file;
	}

	public String getPattern() {
		return pattern;
	}

	public void setPattern(String patternUri) {
		this.pattern = patternUri;
	}

	public static List<String> getContextStrings(List<TextualReference> contexts) {
		Function<TextualReference, String> context_toString = new Function<TextualReference, String>() {
			public String apply(TextualReference c) {
				return c.toString();
			}
		};
		return new ArrayList<String>(Lists.transform(contexts, context_toString));
	}

	public String toPrettyString() {
		StringBuilder sb = new StringBuilder();
		return sb.append(leftText)
			.append("**[  ")
			.append(reference)
			.append("  ]**")
			.append(rightText)
			.toString();
	}

    /**
     * @return the mentionsReference
     */
    public String getMentionsReference() {
        return mentionsReference;
    }

    /**
     * @param mentionsReference the mentionsReference to set
     */
    public void setMentionsReference(String mentionsReference) {
        this.mentionsReference = mentionsReference;
    }
    
    public void setReferenceReliability(double reliability) {
    	this.referenceReliability = reliability;
    }
    
    public double getReferenceReliability() {
    	return this.referenceReliability;
    }

}