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

Class ParseDocument

java.lang.Object

edu.kit.ipd.are.archdoclink.nlp.parse.ParseDocument

All Implemented Interfaces:

Annotatable, Document, Identifiable, TextElement

public class ParseDocument
extends Object
implements Document

Constructor Summary

Constructors

Constructor	Description
ParseDocument(edu.kit.ipd.parse.luna.graph.IGraph graph, String documentId)

Method Summary

Modifier and Type	Method	Description
void	annotate(Annotation annotation)	Annotates the given annotation to this document.
edu.kit.ipd.parse.luna.graph.INode	createNodeForPhrase(ParsePhrase phrase)	Creates a node for a phrase.
void	createReference(edu.kit.ipd.parse.luna.graph.INode node, Annotation annotation)	Creates a reference from the given node to the given annotation.
void	createReference(List<ParseWord> words, Annotation annotation)	Creates a reference from the given annotation to the given words.
boolean	equals(Object obj)
List<ParseCoreference>	getCoreferences()
String	getId()
org.eclipse.collections.api.list.MutableList<ParseWord>	getNamedEntityWords()
org.eclipse.collections.api.list.MutableList<ParsePhrase>	getNounPhrases()
org.eclipse.collections.api.list.MutableList<ParsePhrase>	getPhrases()
org.eclipse.collections.api.list.MutableList<ParsePhrase>	getPhrasesOfType(PhraseType type)
Calendar	getProcessingDate()
org.eclipse.collections.api.list.MutableList<ParseSentence>	getSentences()
String	getText()
org.eclipse.collections.api.list.MutableList<ParseWord>	getWords()
int	hashCode()
String	toDebugString()
String	toExtensiveDebugString()
String	toString()

Methods inherited from class java.lang.Object

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

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

annotate

Constructor Detail

ParseDocument

public ParseDocument(edu.kit.ipd.parse.luna.graph.IGraph graph,
                     String documentId)

Method Detail

getNamedEntityWords

public org.eclipse.collections.api.list.MutableList<ParseWord> getNamedEntityWords()

Specified by:

getNamedEntityWords in interface Document

getWords

public org.eclipse.collections.api.list.MutableList<ParseWord> getWords()

Specified by:

getWords in interface Document

Returns:

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

getPhrases

public org.eclipse.collections.api.list.MutableList<ParsePhrase> getPhrases()

Specified by:

getPhrases in interface Document

Returns:

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

getNounPhrases

public org.eclipse.collections.api.list.MutableList<ParsePhrase> getNounPhrases()

Specified by:

getNounPhrases in interface Document

Returns:

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

getPhrasesOfType

public org.eclipse.collections.api.list.MutableList<ParsePhrase> getPhrasesOfType(PhraseType type)

Specified by:

getPhrasesOfType in interface Document

Parameters:

type - type of phrase

Returns:

list of phrase of the specific phrasetype contained in the sentence

getSentences

public org.eclipse.collections.api.list.MutableList<ParseSentence> getSentences()

Specified by:

getSentences in interface Document

Returns:

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

getText

public String getText()

Specified by:

getText in interface TextElement

Returns:

the text of the element

getCoreferences

public List<ParseCoreference> getCoreferences()

Specified by:

getCoreferences in interface Document

getId

public String getId()

Specified by:

getId in interface Identifiable

Returns:

the Id

getProcessingDate

public Calendar getProcessingDate()

Specified by:

getProcessingDate in interface Document

Returns:

the processing date of the document.

toDebugString

public String toDebugString()

toExtensiveDebugString

public String toExtensiveDebugString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

annotate

public void annotate(Annotation annotation)

Description copied from interface: Document

Annotates the given annotation to this document.

Specified by:

annotate in interface Document

Parameters:

annotation - Annotation that should be annotated to this document.

createReference

public void createReference(List<ParseWord> words,
                            Annotation annotation)

Creates a reference from the given annotation to the given words. Searches the graph for the INode corresponding to the annotation or throws an IllegalArgumentException when no node is found.

Parameters:

words - Words that should be referenced

annotation - Annotation that references the word

createReference

public void createReference(edu.kit.ipd.parse.luna.graph.INode node,
                            Annotation annotation)

Creates a reference from the given node to the given annotation. The annotation needs to have an arcName set.

Parameters:

node - Node where the reference begins

annotation - annotation where the reference should head to

createNodeForPhrase

public edu.kit.ipd.parse.luna.graph.INode createNodeForPhrase(ParsePhrase phrase)

Creates a node for a phrase.

Parameters:

phrase - Phrase for which a node should be created

Returns:

the created node