Package edu.kit.ipd.are.archdoclink.nlp

Interface Document

All Superinterfaces:

Annotatable, Identifiable, TextElement

All Known Implementing Classes:

ParseDocument

public interface Document
extends TextElement, Identifiable

This class represents a document with all its sentences, phrases, words, etc.

Author:

Jan Keim

Method Summary

Modifier and Type	Method	Description
void	annotate(Annotation annotation)	Annotates the given annotation to this document.
default void	annotate(Document document, Annotation annotation)	Annotates the given annotation to the given document
List<? extends Coreference>	getCoreferences()
List<? extends Word>	getNamedEntityWords()
List<? extends Phrase>	getNounPhrases()
List<? extends Phrase>	getPhrases()
List<? extends Phrase>	getPhrasesOfType(PhraseType type)
Calendar	getProcessingDate()
List<? extends Sentence>	getSentences()
List<? extends Word>	getWords()
String	toDebugString()
String	toExtensiveDebugString()

Methods inherited from interface edu.kit.ipd.are.archdoclink.nlp.Identifiable

getId

Methods inherited from interface edu.kit.ipd.are.archdoclink.nlp.TextElement

getText

Method Detail

getProcessingDate

Calendar getProcessingDate()

Returns:

the processing date of the document.

getPhrases

List<? extends Phrase> getPhrases()

Returns:

List of all phrases of the document. The phrases are ordered by appearance.

getNounPhrases

List<? extends Phrase> getNounPhrases()

Returns:

List of all Noun phrases of the document. The phrases are ordered by appearance.

getPhrasesOfType

List<? extends Phrase> getPhrasesOfType(PhraseType type)

Parameters:

type - type of phrase

Returns:

list of phrase of the specific phrasetype contained in the sentence

getSentences

List<? extends Sentence> getSentences()

Returns:

List of all sentences within the document. The sentences are ordered by appearance.

getWords

List<? extends Word> getWords()

Returns:

List of all words within the document. The words are ordered by appearance.

getCoreferences

List<? extends Coreference> getCoreferences()

getNamedEntityWords

List<? extends Word> getNamedEntityWords()

annotate

default void annotate(Document document,
                      Annotation annotation)

Description copied from interface: Annotatable

Annotates the given annotation to the given document

Specified by:

annotate in interface Annotatable

Parameters:

document - Document where the annotation should be added to

annotation - Annotation that should be added

annotate

void annotate(Annotation annotation)

Annotates the given annotation to this document.

Parameters:

annotation - Annotation that should be annotated to this document.

toDebugString

String toDebugString()

Returns:

a string containing debug information

toExtensiveDebugString

String toExtensiveDebugString()

Returns:

a string containing extensive debug information