All Implemented Interfaces:

Comparable<Document>
```
public class Document
extends Object
implements Comparable<Document>
```
The Document class represents a single document which may be either used for processing a text or as training input. A document consists of the raw text, the interpretations and the activations.
When the document is not needed any more, the method clearActivations must be called, since Aika only supports a single document per thread and model.

Author:

Lukas Molzberger

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Document.CyclicDependencyException

Field Summary

Fields
Modifier and Type	Field	Description
`static Comparator<Activation>`	`ACTIVATIONS_OUTPUT_COMPARATOR`
`ArrayList<NodeActivation>`	`addedNodeActivations`
`TreeSet<Node>`	`addedNodes`
`ArrayList<Activation>`	`candidates`
`static int`	`CLEANUP_INTERVAL`
`long`	`createV`
`static int`	`MAX_ROUND`
`int`	`positionIdCounter`
`int`	`searchNodeIdCounter`
`int`	`searchStepCounter`
`SearchNode`	`selectedSearchNode`

Constructor Summary

Constructors
Constructor Description

Document(Model model, int id, String content)

Document(Model model, String content)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`activationsToString()`
`void`	`addActivatedNeuron(INeuron n)`
`void`	`addActivatedNode(Node n)`
`void`	`addActivation(Activation act)`
`void`	`addFinallyActivatedNeuron(INeuron n)`
`void`	`addInputNeuronActivation(Activation act)`
`void`	`append(String txt)`
`char`	`charAt(int i)`
`void`	`clearActivations()`	Removes the activations of this document from the model again.
`void`	`commit()`	Updates the model after the training step.
`int`	`compareTo(Document doc)`
`void`	`dumpDebugCandidateStatistics()`
`void`	`generateCandidates()`
`String`	`generateOutputText()`
`Collection<Activation>`	`getActivations(boolean onlyFinal)`
`Collection<Activation>`	`getActivationsByPosition(int fromSlot, Position fromPos, boolean fromInclusive, int toSlot, Position toPos, boolean toInclusive)`
`Collection<Activation>`	`getActivationsByPosition(Position fromPos, boolean fromInclusive, Position toPos, boolean toInclusive)`
`String`	`getContent()`
`int`	`getId()`
`Linker`	`getLinker()`
`Model`	`getModel()`
`Map<INeuron,Set<Synapse>>`	`getModifiedWeights()`
`int`	`getNewActivationId()`
`int`	`getNewNodeActivationId()`
`long`	`getNewVisitedId()`
`Activation`	`getNextActivation(Activation currentAct)`
`NodeQueue`	`getNodeQueue()`
`int`	`getNumberOfActivations()`
`String`	`getText(Integer begin, Integer end)`
`String`	`getText(Position begin, Position end)`
`int`	`getThreadId()`
`UpperBoundQueue`	`getUpperBoundQueue()`
`ValueQueue`	`getValueQueue()`
`protected Linker`	`initLinker()`
`int`	`length()`
`Position`	`lookupFinalPosition(int pos)`
`void`	`notifyWeightModified(Synapse synapse)`
`void`	`process()`	The method `process` needs to be called after all the input activations have been added to the network.
`void`	`process(Long timeoutInMilliSeconds)`
`void`	`propagate()`
`void`	`storeFinalState()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLEANUP_INTERVAL
```
public static int CLEANUP_INTERVAL
```

MAX_ROUND
```
public static int MAX_ROUND
```

searchNodeIdCounter
```
public int searchNodeIdCounter
```

searchStepCounter
```
public int searchStepCounter
```

positionIdCounter
```
public int positionIdCounter
```

addedNodes
```
public TreeSet<Node> addedNodes
```

addedNodeActivations

public ArrayList<NodeActivation> addedNodeActivations

selectedSearchNode
```
public SearchNode selectedSearchNode
```

candidates

public ArrayList<Activation> candidates

createV
```
public long createV
```

ACTIVATIONS_OUTPUT_COMPARATOR

public static Comparator<Activation> ACTIVATIONS_OUTPUT_COMPARATOR

Constructor Detail

Document

public Document(Model model,
                String content)

Document

public Document(Model model,
                int id,
                String content)

Method Detail

initLinker
```
protected Linker initLinker()
```

getId
```
public int getId()
```

getModel
```
public Model getModel()
```

getLinker
```
public Linker getLinker()
```

getValueQueue
```
public ValueQueue getValueQueue()
```

getNewVisitedId
```
public long getNewVisitedId()
```

getNewActivationId
```
public int getNewActivationId()
```

getNewNodeActivationId
```
public int getNewNodeActivationId()
```

addActivatedNode

public void addActivatedNode(Node n)

addInputNeuronActivation

public void addInputNeuronActivation(Activation act)

addFinallyActivatedNeuron

public void addFinallyActivatedNeuron(INeuron n)

addActivatedNeuron

public void addActivatedNeuron(INeuron n)

getThreadId
```
public int getThreadId()
```

append
```
public void append(String txt)
```

charAt
```
public char charAt(int i)
```

getContent
```
public String getContent()
```

length
```
public int length()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getUpperBoundQueue

public UpperBoundQueue getUpperBoundQueue()

getNodeQueue
```
public NodeQueue getNodeQueue()
```

lookupFinalPosition

public Position lookupFinalPosition(int pos)

getText

public String getText(Position begin,
                      Position end)

getText

public String getText(Integer begin,
                      Integer end)

addActivation

public void addActivation(Activation act)

getActivations

public Collection<Activation> getActivations(boolean onlyFinal)

getActivationsByPosition

public Collection<Activation> getActivationsByPosition(int fromSlot,
                                                       Position fromPos,
                                                       boolean fromInclusive,
                                                       int toSlot,
                                                       Position toPos,
                                                       boolean toInclusive)

getActivationsByPosition

public Collection<Activation> getActivationsByPosition(Position fromPos,
                                                       boolean fromInclusive,
                                                       Position toPos,
                                                       boolean toInclusive)

getNextActivation

public Activation getNextActivation(Activation currentAct)

getNumberOfActivations
```
public int getNumberOfActivations()
```

compareTo
```
public int compareTo(Document doc)
```
Specified by:

compareTo in interface Comparable<Document>

propagate
```
public void propagate()
```

generateCandidates

public void generateCandidates()
                        throws Document.CyclicDependencyException

Throws:: Document.CyclicDependencyException

process
```
public void process()
             throws SearchNode.TimeoutException,
                    Document.CyclicDependencyException,
                    Activation.OscillatingActivationsException
```
The method process needs to be called after all the input activations have been added to the network. It performs the search for the best interpretation.

Throws:

SearchNode.TimeoutException

Document.CyclicDependencyException

Activation.OscillatingActivationsException

process

public void process(Long timeoutInMilliSeconds)
             throws SearchNode.TimeoutException,
                    Document.CyclicDependencyException,
                    Activation.OscillatingActivationsException

Throws:: SearchNode.TimeoutException; Document.CyclicDependencyException; Activation.OscillatingActivationsException

storeFinalState
```
public void storeFinalState()
```

dumpDebugCandidateStatistics

public void dumpDebugCandidateStatistics()

notifyWeightModified

public void notifyWeightModified(Synapse synapse)

getModifiedWeights

public Map<INeuron,Set<Synapse>> getModifiedWeights()

commit
```
public void commit()
```
Updates the model after the training step. It applies the weight and bias delta values and reflects the changes in the logic node structure.

clearActivations
```
public void clearActivations()
```
Removes the activations of this document from the model again.

generateOutputText
```
public String generateOutputText()
```

activationsToString
```
public String activationsToString()
```

Constructor	Description
`Document(Model model, int id, String content)`
`Document(Model model, String content)`

Class Document

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLEANUP_INTERVAL

MAX_ROUND

searchNodeIdCounter

searchStepCounter

positionIdCounter

addedNodes

addedNodeActivations

selectedSearchNode

candidates

createV

ACTIVATIONS_OUTPUT_COMPARATOR

Constructor Detail

Document

Document

Method Detail

initLinker

getId

getModel

getLinker

getValueQueue

getNewVisitedId

getNewActivationId

getNewNodeActivationId

addActivatedNode

addInputNeuronActivation

addFinallyActivatedNeuron

addActivatedNeuron

getThreadId

append

charAt

getContent

length

toString

getUpperBoundQueue

getNodeQueue

lookupFinalPosition

getText

getText

addActivation

getActivations

getActivationsByPosition

getActivationsByPosition

getNextActivation

getNumberOfActivations

compareTo

propagate

generateCandidates

process

process

storeFinalState

dumpDebugCandidateStatistics

notifyWeightModified

getModifiedWeights

commit

clearActivations

generateOutputText

activationsToString