grammarscope.artifacts

Class AbstractDocumentFactory

java.lang.Object

grammarscope.artifacts.AbstractDocumentFactory

All Implemented Interfaces:

IDocumentFactory, IDocumentFactoryService

Direct Known Subclasses:

DocumentFactoryAsync, DocumentFactoryAsync, DocumentFactorySync, DocumentFactorySync

public abstract class AbstractDocumentFactory
extends java.lang.Object
implements IDocumentFactory

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<SentenceSegment>	sentenceSegments Sentence segments
protected java.lang.String	text Text
protected ATextAnalysis	textAnalysis Analysis
private java.util.List<WordSegment>	wordSegments Word segments
(package private) static XMLPrinter	xMLPrinter XML Printer

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentFactory() Constructor

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	coreferencesToString(ACoreferences coreferences, boolean isXml) Coreferences to string
private static java.lang.String	entailmentsToString(java.util.List<Entailment> entailments, boolean isXml) Entailments to string
private static java.util.List<WordSegment>	flatten(java.util.List<java.util.List<WordSegment>> sentenceWordSegments) Flatten hierarchical list of per-sentence word segments
AAnalysis	getAnalysis(int sentenceIdx) Get (sentence) analysis artifact
protected ACoreferences	getArtifactCoreferences() Get coreferences
protected java.util.List<Entailment>	getArtifactEntailments(int sentenceIdx) Get entailments
protected AGrammaticalStructure	getArtifactGrammaticalStructure(int sentenceIdx) Get grammatical structure
protected ANamedEntities	getArtifactNamedEntities(int sentenceIdx) Get named entities
protected AParseTree	getArtifactParseTree(int sentenceIdx) Get parse tree
protected Segmentation	getArtifactSegmentation() Get segmentation
protected ASemanticGraph	getArtifactSemanticGraph(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get semantic graph
protected java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>>	getArtifactSemanticGraphs(int sentenceIdx) Get semantic graphs
protected Sentiment	getArtifactSentiment(int sentenceIdx) Get sentiment
protected java.util.List<Triple>	getArtifactTriples(int sentenceIdx) Get triples
protected ATypedDependencies	getArtifactTypedDependencies(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get typed dependencies
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
private static Segment	getSpan(java.util.List<? extends Segment> segments) Span
TypedDependencyMode[]	getSupportedModes() Get supported typed dependency modes
TypedDependencyProvider[]	getSupportedProviders() Get supported typed dependency providers
java.lang.String	getText() Get text
protected ATextAnalysis	getTextAnalysis() Get text analysis
ATextAnalysis	getTextAnalysis(TypedDependencyProvider provider, TypedDependencyMode mode) Get text analysis
java.lang.String	getTextReport(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xMLModeFlag) Get (text) analysis string
java.lang.String[]	getTextReports(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xMLModeFlag) Get (text) analysis strings
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
private static java.lang.String	grammaticalStructureToString(AGrammaticalStructure grammaticalStructure, boolean isXml) Grammatical structure to string
private static java.util.List<SentenceSegment>	groupToSentence(java.util.List<java.util.List<WordSegment>> sentenceWordSegments) Make sentence segments and map : returns (list of segments, segment to list of words map)
boolean	init(java.lang.String text) Init processing
private static java.lang.String	namedEntitiesToString(ANamedEntities namedEntities, boolean isXml) Named entities to string
abstract java.lang.String	processText(java.lang.String text)
private static java.lang.String	semanticGraphsToString(java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>> semanticGraphs, boolean isXml) Semantic graph to string
private static java.lang.String	sentimentToString(Sentiment sentiment, boolean isXml) Sentiment to string
private static java.lang.String	tokensToString(java.util.List<Token> tokens, boolean isXml) Tokens to string
private static java.lang.String	treeToString(AParseTree parseTree, boolean isXml) Parse tree to string
private static java.lang.String	triplesToString(java.util.List<Triple> triples, boolean isXml) Triples to string
private static java.lang.String	typedDependenciesToString(java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>> semanticGraphs, boolean isXml) Typed dependencies to string

Methods inherited from class java.lang.Object

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

Field Detail

xMLPrinter

static XMLPrinter xMLPrinter

XML Printer

textAnalysis

protected ATextAnalysis textAnalysis

Analysis

text

protected java.lang.String text

Text

wordSegments

private java.util.List<WordSegment> wordSegments

Word segments

sentenceSegments

private java.util.List<SentenceSegment> sentenceSegments

Sentence segments

Constructor Detail

AbstractDocumentFactory

public AbstractDocumentFactory()

Constructor

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

getTextAnalysis

protected ATextAnalysis getTextAnalysis()

Get text analysis

Returns:

text analysis

getSupportedProviders

public TypedDependencyProvider[] getSupportedProviders()
                                                throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get supported typed dependency providers

Specified by:

getSupportedProviders in interface IDocumentFactoryService

Returns:

array of supported typed dependency providers

Throws:

java.lang.RuntimeException

getSupportedModes

public TypedDependencyMode[] getSupportedModes()
                                        throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get supported typed dependency modes

Specified by:

getSupportedModes in interface IDocumentFactoryService

Returns:

array of supported typed dependency modes

Throws:

java.lang.RuntimeException

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

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

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

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

groupToSentence

private static java.util.List<SentenceSegment> groupToSentence(java.util.List<java.util.List<WordSegment>> sentenceWordSegments)

Make sentence segments and map : returns (list of segments, segment to list of words map)

Parameters:

sentenceWordSegments - list of sentences

Returns:

list of segments

flatten

private static java.util.List<WordSegment> flatten(java.util.List<java.util.List<WordSegment>> sentenceWordSegments)

Flatten hierarchical list of per-sentence word segments

Parameters:

sentenceWordSegments - hierarchical list of per-sentence word segments

Returns:

flat word segment list

getSpan

private static Segment getSpan(java.util.List<? extends Segment> segments)

Span

Parameters:

segments - segments

Returns:

merged segment

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

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

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

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)

Description copied from interface: IDocumentFactoryService

Get sentiment

Specified by:

getSentiment in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

sentiment if successful

getEntailments

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

Description copied from interface: IDocumentFactoryService

Get entailments

Specified by:

getEntailments in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

entailments if successful

getTriples

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

Description copied from interface: IDocumentFactoryService

Get triples

Specified by:

getTriples in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

triples if successful

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

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

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

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

Description copied from interface: IDocumentFactoryService

Get (text) analysis string

Specified by:

getTextReport in interface IDocumentFactoryService

Parameters:

provider - provider

mode - mode

xMLModeFlag - XML format requested

Returns:

string

Throws:

java.lang.RuntimeException

getTextReports

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

Description copied from interface: IDocumentFactoryService

Get (text) analysis strings

Specified by:

getTextReports in interface IDocumentFactoryService

Parameters:

provider - provider

mode - mode

xMLModeFlag - XML format requested

Returns:

array of strings [0] text, [1] coreference, [2] sentence1, [3] sentence2, ...

Throws:

java.lang.RuntimeException

tokensToString

private static java.lang.String tokensToString(java.util.List<Token> tokens,
                                               boolean isXml)

Tokens to string

Parameters:

tokens - tokens

isXml - xml format

Returns:

string

treeToString

private static java.lang.String treeToString(AParseTree parseTree,
                                             boolean isXml)

Parse tree to string

Parameters:

parseTree - parse tree

isXml - xml format

Returns:

string

grammaticalStructureToString

private static java.lang.String grammaticalStructureToString(AGrammaticalStructure grammaticalStructure,
                                                             boolean isXml)

Grammatical structure to string

Parameters:

grammaticalStructure - grammatical structure

isXml - xml format

Returns:

string

typedDependenciesToString

private static java.lang.String typedDependenciesToString(java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>> semanticGraphs,
                                                          boolean isXml)

Typed dependencies to string

Parameters:

semanticGraphs - semantic graphs

isXml - xml format

Returns:

string

semanticGraphsToString

private static java.lang.String semanticGraphsToString(java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>> semanticGraphs,
                                                       boolean isXml)

Semantic graph to string

Parameters:

semanticGraphs - semantic graphs

isXml - xml format

Returns:

string

namedEntitiesToString

private static java.lang.String namedEntitiesToString(ANamedEntities namedEntities,
                                                      boolean isXml)

Named entities to string

Parameters:

namedEntities - named entities

isXml - xml format

Returns:

string

sentimentToString

private static java.lang.String sentimentToString(Sentiment sentiment,
                                                  boolean isXml)

Sentiment to string

Parameters:

sentiment - sentiment

isXml - xml format

Returns:

string

entailmentsToString

private static java.lang.String entailmentsToString(java.util.List<Entailment> entailments,
                                                    boolean isXml)

Entailments to string

Parameters:

entailments - entailments

isXml - xml format

Returns:

string

triplesToString

private static java.lang.String triplesToString(java.util.List<Triple> triples,
                                                boolean isXml)

Triples to string

Parameters:

triples - triples

isXml - xml format

Returns:

string

coreferencesToString

private static java.lang.String coreferencesToString(ACoreferences coreferences,
                                                     boolean isXml)

Coreferences to string

Parameters:

coreferences - coreferences

isXml - xml format

Returns:

string

getArtifactSegmentation

protected Segmentation getArtifactSegmentation()
                                        throws java.lang.RuntimeException

Get segmentation

Returns:

segmentation

Throws:

java.lang.RuntimeException - exception

getArtifactParseTree

protected AParseTree getArtifactParseTree(int sentenceIdx)
                                   throws java.lang.RuntimeException

Get parse tree

Parameters:

sentenceIdx - word list sentence

Returns:

parse tree if successful

Throws:

java.lang.RuntimeException - exception

getArtifactGrammaticalStructure

protected AGrammaticalStructure getArtifactGrammaticalStructure(int sentenceIdx)
                                                         throws java.lang.RuntimeException

Get grammatical structure

Parameters:

sentenceIdx - sentence

Returns:

grammatical structure if successful

Throws:

java.lang.RuntimeException

getArtifactTypedDependencies

protected ATypedDependencies getArtifactTypedDependencies(int sentenceIdx,
                                                          TypedDependencyProvider provider,
                                                          TypedDependencyMode mode)
                                                   throws java.lang.RuntimeException

Get typed dependencies

Parameters:

sentenceIdx - sentence

provider - typed dependency provider

mode - typed dependency mode

Returns:

typed dependencies if successful

Throws:

java.lang.RuntimeException - exception

getArtifactSemanticGraph

protected ASemanticGraph getArtifactSemanticGraph(int sentenceIdx,
                                                  TypedDependencyProvider provider,
                                                  TypedDependencyMode mode)
                                           throws java.lang.RuntimeException

Get semantic graph

Parameters:

sentenceIdx - sentence

provider - typed dependency provider

mode - typed dependency mode

Returns:

semantic graph if successful

Throws:

java.lang.RuntimeException

getArtifactSemanticGraphs

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

Get semantic graphs

Parameters:

sentenceIdx - sentence

Returns:

semantic graphs if successful

Throws:

java.lang.RuntimeException

getArtifactNamedEntities

protected ANamedEntities getArtifactNamedEntities(int sentenceIdx)
                                           throws java.lang.RuntimeException

Get named entities

Parameters:

sentenceIdx - sentence index

Returns:

list of named entities

Throws:

java.lang.RuntimeException - exception

getArtifactSentiment

protected Sentiment getArtifactSentiment(int sentenceIdx)
                                  throws java.lang.RuntimeException

Get sentiment

Parameters:

sentenceIdx - sentence index

Returns:

sentiment

Throws:

java.lang.RuntimeException - exception

getArtifactEntailments

protected java.util.List<Entailment> getArtifactEntailments(int sentenceIdx)

Get entailments

Parameters:

sentenceIdx - sentence index

Returns:

entailments

Throws:

java.lang.RuntimeException - exception

getArtifactTriples

protected java.util.List<Triple> getArtifactTriples(int sentenceIdx)

Get triples

Parameters:

sentenceIdx - sentence index

Returns:

triples

Throws:

java.lang.RuntimeException - exception

getArtifactCoreferences

protected ACoreferences getArtifactCoreferences()
                                         throws java.lang.RuntimeException

Get coreferences

Returns:

coreference data if successful

Throws:

java.lang.RuntimeException

processText

public abstract java.lang.String processText(java.lang.String text)
                                      throws java.lang.Exception

Throws:

java.lang.Exception