org.aika.corpus

Class Document

java.lang.Object

org.aika.corpus.Document

All Implemented Interfaces:

Comparable<Document>

public class Document
extends Object
implements Comparable<Document>

The Document class represents a single document within a corpus of documents. A set of documents can be either used to train a new model or a document can be processed and annotated by an already trained model. The Document class contains the actual text, a set of initial annotations, the option lattice containing all the possible interpretations of this document, a set of option conflicts and a ranked list of weighted options.

Author:

Lukas Molzberger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.ActivationKey
static class	Document.Annotation

Field Summary

Fields

Modifier and Type	Field and Description
Option	bottom
NavigableMap<Document.ActivationKey,Activation>	inputActivations
int	optionIdCounter
int	primOptionIdCounter
ExpandNode	selectedExpandNode
Option	selectedOption
Option	top

Constructor Summary

Constructors

Constructor and Description
Document(String id)

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(int begin, int end, String label, int level)
void	addInputActivation(Activation act)
int	compareTo(Document d)
String	conflictsToString()
static Document	createDocument(String id, String content)
boolean	equals(Object o)
void	finalizeDocument()
List<Document.Annotation>	getAnnotations()
Set<Document.Annotation>	getAnnotations(int pos)
String	getContent()
String	getId()
Collection<Activation>	getInputActivations(int pos)
int	hashCode()
int	length()
void	removeInputActivation(Activation act)
String	selectedOptionsToString()
void	setContent(String content)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

inputActivations

public NavigableMap<Document.ActivationKey,Activation> inputActivations

primOptionIdCounter

public int primOptionIdCounter

optionIdCounter

public int optionIdCounter

top

public Option top

bottom

public Option bottom

selectedExpandNode

public ExpandNode selectedExpandNode

selectedOption

public Option selectedOption

Constructor Detail

Document

public Document(String id)

Method Detail

createDocument

public static Document createDocument(String id,
                                      String content)

getId

public String getId()

setContent

public void setContent(String content)

getContent

public String getContent()

length

public int length()

addAnnotation

public void addAnnotation(int begin,
                          int end,
                          String label,
                          int level)

getAnnotations

public List<Document.Annotation> getAnnotations()

getAnnotations

public Set<Document.Annotation> getAnnotations(int pos)

addInputActivation

public void addInputActivation(Activation act)

removeInputActivation

public void removeInputActivation(Activation act)

getInputActivations

public Collection<Activation> getInputActivations(int pos)

toString

public String toString()

Overrides:

toString in class Object

conflictsToString

public String conflictsToString()

selectedOptionsToString

public String selectedOptionsToString()

finalizeDocument

public void finalizeDocument()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Document d)

Specified by:

compareTo in interface Comparable<Document>