eu.project.ttc.readers.CollectionDocument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of termsuite-core Show documentation

A Java UIMA-based toolbox for multilingual and efficient terminology extraction an multilingual term alignment

There is a newer version: 3.0.10

package eu.project.ttc.readers;

/**
 * An interface of input documents sent to collection readers
 * 
 * @author Damien Cram
 * 
 * @see StreamingCollectionReader
 *
 */
public interface CollectionDocument {

	/**
	 * The document sentinelle  sent to the reader to stipulate that the stream is ended
	 * 
	 */
	public static final CollectionDocument LAST_DOCUMENT = new CollectionDocument() {
		@Override
		public String getUri() {
			return "http://termsuite.github.io/documents/last";
		}
		@Override
		public String getText() {
			return null;
		}
	};

	/**
	 * The unique identifier of the document.
	 * 
	 * @return the uri
	 */
	public String getUri();
	
	/**
	 * The context of the text.
	 * 
	 * @return
	 */
	public String getText();

}