grammarscope.io.xml

Class XMLDocumentFactory

java.lang.Object

grammarscope.io.xml.XMLDocument

grammarscope.io.xml.XMLDocumentFactory

All Implemented Interfaces:

IDocumentFactory, IDocumentFactoryService

Direct Known Subclasses:

XMLDocumentFactoryGrammarScope, XMLDocumentFactoryStanford

public abstract class XMLDocumentFactory
extends XMLDocument
implements IDocumentFactory

Document (as read from XML formatted data)

Author:

Bernard Bou

Field Summary

Fields inherited from class grammarscope.io.xml.XMLDocument

COREFERENCE, COREFERENCE_END, COREFERENCE_HEAD, COREFERENCE_MENTION, COREFERENCE_MENTION_FROM, COREFERENCE_MENTION_REPRESENTATIVE, COREFERENCE_MENTION_TO, COREFERENCE_SENTENCE, COREFERENCE_START, COREFERENCE_TEXT, coreferences, COREFERENCES, DEPENDENCY, DEPENDENCY_TYPE, DEPENDENT, DEPENDENT_IDX, DOCUMENT, domDocument, ENTAILMENT, ENTAILMENT_SCORE, entailments, ENTAILMENTS, GOVERNOR, GOVERNOR_IDX, grammaticalStructures, GRAPH, GRAPH_DEPENDENCIES, GRAPH_MODE, GRAPH_PROVIDER, GRAPH_ROOT, GRAPH_ROOT_IDX, GRAPH_ROOTS, GRAPH_SET, GSNODE, GSNODE_ANNOTATION, GSNODE_ANNOTATION_KEY, GSNODE_DEPENDENT, GSNODE_GOVERNOR, GSNODE_HEAD, GSNODE_IDX, GSNODE_LEMMA, GSNODE_RELATION, GSNODE_SCORE, GSNODE_VALUE, GSNODE_WORD, GSNODE_WORD_IDX, GSTRUCTURE, GSTRUCTURE_FORMAT, NAMED_ENTITIES, NAMED_ENTITY, NAMED_ENTITY_ANIMACY, NAMED_ENTITY_FROM, NAMED_ENTITY_GENDER, NAMED_ENTITY_NUMBER, NAMED_ENTITY_TO, NAMED_ENTITY_WORD, namedEntities, PARSE, PARSE_FORMAT, PARSE_NODE, PARSE_NODE_IDX, PARSE_NODE_LEMMA, PARSE_NODE_SCORE, PARSE_NODE_VALUE, PARSE_NODE_WORD, PARSE_NODE_WORD_IDX, parses, poses, RELATION, ROOT, ROOT_FORMAT, segments, semanticGraphs, SENTENCE, SENTENCE_BEGIN, SENTENCE_END, SENTENCE_FROM, SENTENCE_IDX, SENTENCE_TEXT, SENTENCE_TO, SENTENCES, SENTIMENT, SENTIMENT_CLASS, SENTIMENT_VALUE, sentiments, stanfordMode, text, TEXT, TOKEN, TOKEN_BEGIN, TOKEN_END, TOKEN_FROM, TOKEN_IDX, TOKEN_LEMMA, TOKEN_NER, TOKEN_NORM_NER, TOKEN_POS, TOKEN_SENTIMENT, TOKEN_SPEAKER, TOKEN_TO, TOKEN_WORD, tokens, TOKENS, TRIPLE, TRIPLE_OBJECT, TRIPLE_RELATION, TRIPLE_SUBJECT, triples, TRIPLES, typedDependencies, TYPEDDEPENDENCIES, TYPEDDEPENDENCIES_MODE, TYPEDDEPENDENCIES_PROVIDER, TYPEDDEPENDENCIES_SET, TYPEDDEPENDENCIES_STYLE, url

Constructor Summary

Constructors

Constructor and Description
XMLDocumentFactory(java.net.URL url) Constructor

Method Summary

Modifier and Type	Method and Description
AAnalysis	getAnalysis(int sentenceIdx) Get (sentence) analysis artifact
ACoreferences	getCoreferences() Get coreferences artifact
java.util.List<Entailment>	getEntailments(int sentenceIdx) Get entailments
AGrammaticalStructure	getGrammaticalStructure(int sentenceIdx) Get grammatical structure artifact
ANamedEntities	getNamedEntities(int sentenceIdx) Get named entities artifact
AParseTree	getParseTree(int sentenceIdx) Get parse artifact
APartsOfSpeech	getPoses(int sentenceIdx) Get parts-of-speech artifact
ARelationDependents	getRelationDependents(int sentenceIdx) Get relation dependents artifact
java.lang.String	getReport(int sentenceIdx, boolean xMLFlag) Get (sentence) analysis string
java.lang.String[]	getReports(int sentenceIdx, boolean xMLFlag) Get (sentence) analysis strings
ASemanticGraph	getSemanticGraph(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get semantic graph artifact
java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>>	getSemanticGraphs(int sentenceIdx) Get semantic graph artifacts
int	getSentenceCount() Get sentence count
java.util.List<SentenceSegment>	getSentences() Get sentences
Sentiment	getSentiment(int sentenceIdx) Get sentiment
TypedDependencyMode[]	getSupportedModes() Get supported typed dependency modes
TypedDependencyProvider[]	getSupportedProviders() Get supported typed dependency providers
java.lang.String	getText() Get text
ATextAnalysis	getTextAnalysis(TypedDependencyProvider provider, TypedDependencyMode mode) Get text analysis
java.lang.String	getTextReport(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xMLModeFlag) Get text report
java.lang.String[]	getTextReports(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xMLModeFlag) Get text reports
java.util.List<Token>	getTokens(int sentenceIdx) Get tokens
java.util.List<Triple>	getTriples(int sentenceIdx) Get triples
java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ATypedDependencies>>	getTypedDependencies(int sentenceIdx) Get typed dependencies artifact
ATypedDependencies	getTypedDependencies(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get typed dependencies artifact
java.util.List<WordSegment>	getWords() Get words
boolean	init(java.lang.String text) Init processing

Methods inherited from class grammarscope.io.xml.XMLDocument

init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLDocumentFactory

public XMLDocumentFactory(java.net.URL url)

Constructor

Parameters:

url - XML document URL

Method Detail

init

public boolean init(java.lang.String text)

Description copied from interface: IDocumentFactory

Init processing

Specified by:

init in interface IDocumentFactory

Parameters:

text - input text

Returns:

true if successful

getText

public java.lang.String getText()
                         throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get text

Specified by:

getText in interface IDocumentFactoryService

Returns:

(original or reconstructed) text

Throws:

java.lang.RuntimeException

getWords

public java.util.List<WordSegment> getWords()
                                     throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get words

Specified by:

getWords in interface IDocumentFactoryService

Returns:

list of word segments

Throws:

java.lang.RuntimeException

getSentenceCount

public int getSentenceCount()
                     throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get sentence count

Specified by:

getSentenceCount in interface IDocumentFactoryService

Returns:

sentence count

Throws:

java.lang.RuntimeException

getSentences

public java.util.List<SentenceSegment> getSentences()
                                             throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get sentences

Specified by:

getSentences in interface IDocumentFactoryService

Returns:

list of sentence segments

Throws:

java.lang.RuntimeException

getTokens

public java.util.List<Token> getTokens(int sentenceIdx)
                                throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get tokens

Specified by:

getTokens in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

tokens

Throws:

java.lang.RuntimeException - runtime exception

getPoses

public APartsOfSpeech getPoses(int sentenceIdx)
                        throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get parts-of-speech artifact

Specified by:

getPoses in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

parts-of-speech artifact if successful

Throws:

java.lang.RuntimeException

getParseTree

public AParseTree getParseTree(int sentenceIdx)
                        throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get parse artifact

Specified by:

getParseTree in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

parse tree artifact if successful

Throws:

java.lang.RuntimeException

getGrammaticalStructure

public AGrammaticalStructure getGrammaticalStructure(int sentenceIdx)
                                              throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get grammatical structure artifact

Specified by:

getGrammaticalStructure in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

grammatical structure artifact if successful

Throws:

java.lang.RuntimeException

getRelationDependents

public ARelationDependents getRelationDependents(int sentenceIdx)
                                          throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get relation dependents artifact

Specified by:

getRelationDependents in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

relation dependents artifact if successful

Throws:

java.lang.RuntimeException

getTypedDependencies

public ATypedDependencies getTypedDependencies(int sentenceIdx,
                                               TypedDependencyProvider provider,
                                               TypedDependencyMode mode)
                                        throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get typed dependencies artifact

Specified by:

getTypedDependencies in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

provider - typed dependency provider

mode - typed dependency mode

Returns:

typed dependencies artifact if successful

Throws:

java.lang.RuntimeException

getTypedDependencies

public java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ATypedDependencies>> getTypedDependencies(int sentenceIdx)
                                                                                                                  throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get typed dependencies artifact

Specified by:

getTypedDependencies in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

typed dependency mode-indexed typed dependencies artifacts if successful

Throws:

java.lang.RuntimeException

getSemanticGraph

public ASemanticGraph getSemanticGraph(int sentenceIdx,
                                       TypedDependencyProvider provider,
                                       TypedDependencyMode mode)
                                throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get semantic graph artifact

Specified by:

getSemanticGraph in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

provider - typed dependency provider

mode - typed dependency mode

Returns:

semantic graph artifact if successful

Throws:

java.lang.RuntimeException

getSemanticGraphs

public java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>> getSemanticGraphs(int sentenceIdx)
                                                                                                           throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get semantic graph artifacts

Specified by:

getSemanticGraphs in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

typed dependency mode-indexed semantic graph artifacts if successful

Throws:

java.lang.RuntimeException

getNamedEntities

public ANamedEntities getNamedEntities(int sentenceIdx)
                                throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get named entities artifact

Specified by:

getNamedEntities in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

named entities artifact if successful

Throws:

java.lang.RuntimeException

getSentiment

public Sentiment getSentiment(int sentenceIdx)
                       throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get sentiment

Specified by:

getSentiment in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

sentiment if successful

Throws:

java.lang.RuntimeException

getEntailments

public java.util.List<Entailment> getEntailments(int sentenceIdx)
                                          throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get entailments

Specified by:

getEntailments in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

entailments if successful

Throws:

java.lang.RuntimeException

getTriples

public java.util.List<Triple> getTriples(int sentenceIdx)
                                  throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get triples

Specified by:

getTriples in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

triples if successful

Throws:

java.lang.RuntimeException

getCoreferences

public ACoreferences getCoreferences()
                              throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get coreferences artifact

Specified by:

getCoreferences in interface IDocumentFactoryService

Returns:

coreferences artifact if successful

Throws:

java.lang.RuntimeException

getAnalysis

public AAnalysis getAnalysis(int sentenceIdx)
                      throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get (sentence) analysis artifact

Specified by:

getAnalysis in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

analysis if successful

Throws:

java.lang.RuntimeException

getTextAnalysis

public ATextAnalysis getTextAnalysis(TypedDependencyProvider provider,
                                     TypedDependencyMode mode)
                              throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get text analysis

Specified by:

getTextAnalysis in interface IDocumentFactoryService

Parameters:

provider - provider

mode - mode

Returns:

text analysis if successful

Throws:

java.lang.RuntimeException

getReports

public java.lang.String[] getReports(int sentenceIdx,
                                     boolean xMLFlag)
                              throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get (sentence) analysis strings

Specified by:

getReports in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

xMLFlag - XML format requested

Returns:

array of strings [0] text, [1] parse tree, [2] grammatical structure, [3] typed dependencies, [4] semantic graph if successful

Throws:

java.lang.RuntimeException

getReport

public java.lang.String getReport(int sentenceIdx,
                                  boolean xMLFlag)
                           throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get (sentence) analysis string

Specified by:

getReport in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

xMLFlag - XML format requested

Returns:

string

Throws:

java.lang.RuntimeException

getTextReport

public java.lang.String getTextReport(TypedDependencyProvider provider,
                                      TypedDependencyMode mode,
                                      boolean xMLModeFlag)
                               throws java.lang.RuntimeException

Get text report

Specified by:

getTextReport in interface IDocumentFactoryService

Parameters:

mode - typed dependency mode

xMLModeFlag - xml form

provider - provider

Returns:

report

Throws:

java.lang.RuntimeException - exception

getTextReports

public java.lang.String[] getTextReports(TypedDependencyProvider provider,
                                         TypedDependencyMode mode,
                                         boolean xMLModeFlag)
                                  throws java.lang.RuntimeException

Get text reports

Specified by:

getTextReports in interface IDocumentFactoryService

Parameters:

mode - typed dependency mode

xMLModeFlag - xml form

provider - provider

Returns:

reports

Throws:

java.lang.RuntimeException - exception

getSupportedProviders

public TypedDependencyProvider[] getSupportedProviders()

Description copied from interface: IDocumentFactoryService

Get supported typed dependency providers

Specified by:

getSupportedProviders in interface IDocumentFactoryService

Returns:

array of supported typed dependency providers

getSupportedModes

public TypedDependencyMode[] getSupportedModes()

Description copied from interface: IDocumentFactoryService

Get supported typed dependency modes

Specified by:

getSupportedModes in interface IDocumentFactoryService

Returns:

array of supported typed dependency modes