GrammarScope  4.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | Static Package Attributes | Static Private Member Functions | Private Attributes | List of all members
grammarscope.artifacts.AbstractDocumentFactory Class Referenceabstract
Inheritance diagram for grammarscope.artifacts.AbstractDocumentFactory:
Inheritance graph
[legend]
Collaboration diagram for grammarscope.artifacts.AbstractDocumentFactory:
Collaboration graph
[legend]

Public Member Functions

 AbstractDocumentFactory ()
 
boolean init (final String text)
 
TypedDependencyProvider[] getSupportedProviders () throws RuntimeException
 
TypedDependencyMode[] getSupportedModes () throws RuntimeException
 
String getText () throws RuntimeException
 
List< SentenceSegmentgetSentences () throws RuntimeException
 
int getSentenceCount () throws RuntimeException
 
List< WordSegmentgetWords () throws RuntimeException
 
List< TokengetTokens (final int sentenceIdx) throws RuntimeException
 
AParseTree getParseTree (final int sentenceIdx) throws RuntimeException
 
APartsOfSpeech getPoses (final int sentenceIdx) throws RuntimeException
 
AGrammaticalStructure getGrammaticalStructure (final int sentenceIdx) throws RuntimeException
 
ARelationDependents getRelationDependents (final int sentenceIdx) throws RuntimeException
 
ATypedDependencies getTypedDependencies (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyProvider, Map< TypedDependencyMode, ATypedDependencies > > getTypedDependencies (final int sentenceIdx) throws RuntimeException
 
ASemanticGraph getSemanticGraph (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph > > getSemanticGraphs (final int sentenceIdx) throws RuntimeException
 
ANamedEntities getNamedEntities (final int sentenceIdx) throws RuntimeException
 
Sentiment getSentiment (final int sentenceIdx)
 
List< EntailmentgetEntailments (final int sentenceIdx)
 
List< TriplegetTriples (final int sentenceIdx)
 
ACoreferences getCoreferences () throws RuntimeException
 
ATextAnalysis getTextAnalysis (final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
AAnalysis getAnalysis (final int sentenceIdx) throws RuntimeException
 
String[] getReports (final int sentenceIdx, final boolean xMLFlag) throws RuntimeException
 
String getReport (final int sentenceIdx, final boolean xMLFlag) throws RuntimeException
 
String getTextReport (final TypedDependencyProvider provider, final TypedDependencyMode mode, final boolean xMLModeFlag) throws RuntimeException
 
String[] getTextReports (final TypedDependencyProvider provider, final TypedDependencyMode mode, final boolean xMLModeFlag) throws RuntimeException
 
abstract String processText (final String text) throws Exception
 
 AbstractDocumentFactory ()
 
boolean init (final String text)
 
TypedDependencyProvider[] getSupportedProviders () throws RuntimeException
 
TypedDependencyMode[] getSupportedModes () throws RuntimeException
 
String getText () throws RuntimeException
 
List< SentenceSegmentgetSentences () throws RuntimeException
 
int getSentenceCount () throws RuntimeException
 
List< WordSegmentgetWords () throws RuntimeException
 
List< TokengetTokens (final int sentenceIdx) throws RuntimeException
 
AParseTree getParseTree (final int sentenceIdx) throws RuntimeException
 
APartsOfSpeech getPoses (final int sentenceIdx) throws RuntimeException
 
AGrammaticalStructure getGrammaticalStructure (final int sentenceIdx) throws RuntimeException
 
ARelationDependents getRelationDependents (final int sentenceIdx) throws RuntimeException
 
ATypedDependencies getTypedDependencies (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyProvider, Map< TypedDependencyMode, ATypedDependencies > > getTypedDependencies (final int sentenceIdx) throws RuntimeException
 
ASemanticGraph getSemanticGraph (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph > > getSemanticGraphs (final int sentenceIdx) throws RuntimeException
 
ANamedEntities getNamedEntities (final int sentenceIdx) throws RuntimeException
 
Sentiment getSentiment (final int sentenceIdx)
 
List< EntailmentgetEntailments (final int sentenceIdx)
 
List< TriplegetTriples (final int sentenceIdx)
 
ACoreferences getCoreferences () throws RuntimeException
 
ATextAnalysis getTextAnalysis (final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
AAnalysis getAnalysis (final int sentenceIdx) throws RuntimeException
 
String[] getReports (final int sentenceIdx, final boolean xMLFlag) throws RuntimeException
 
String getReport (final int sentenceIdx, final boolean xMLFlag) throws RuntimeException
 
String getTextReport (final TypedDependencyProvider provider, final TypedDependencyMode mode, final boolean xMLModeFlag) throws RuntimeException
 
String[] getTextReports (final TypedDependencyProvider provider, final TypedDependencyMode mode, final boolean xMLModeFlag) throws RuntimeException
 
abstract String processText (final String text) throws Exception
 

Protected Member Functions

ATextAnalysis getTextAnalysis ()
 
Segmentation getArtifactSegmentation () throws RuntimeException
 
AParseTree getArtifactParseTree (final int sentenceIdx) throws RuntimeException
 
AGrammaticalStructure getArtifactGrammaticalStructure (final int sentenceIdx) throws RuntimeException
 
ATypedDependencies getArtifactTypedDependencies (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyMode, ATypedDependenciesgetArtifactTypedDependencies (final int sentenceIdx, final TypedDependencyProvider provider) throws RuntimeException
 
ASemanticGraph getArtifactSemanticGraph (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph > > getArtifactSemanticGraphs (final int sentenceIdx) throws RuntimeException
 
ANamedEntities getArtifactNamedEntities (final int sentenceIdx) throws RuntimeException
 
Sentiment getArtifactSentiment (final int sentenceIdx) throws RuntimeException
 
List< EntailmentgetArtifactEntailments (final int sentenceIdx)
 
List< TriplegetArtifactTriples (final int sentenceIdx)
 
ACoreferences getArtifactCoreferences () throws RuntimeException
 
ATextAnalysis getTextAnalysis ()
 
Segmentation getArtifactSegmentation () throws RuntimeException
 
AParseTree getArtifactParseTree (final int sentenceIdx) throws RuntimeException
 
AGrammaticalStructure getArtifactGrammaticalStructure (final int sentenceIdx) throws RuntimeException
 
ATypedDependencies getArtifactTypedDependencies (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
ASemanticGraph getArtifactSemanticGraph (final int sentenceIdx, final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException
 
Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph > > getArtifactSemanticGraphs (final int sentenceIdx) throws RuntimeException
 
ANamedEntities getArtifactNamedEntities (final int sentenceIdx) throws RuntimeException
 
Sentiment getArtifactSentiment (final int sentenceIdx) throws RuntimeException
 
List< EntailmentgetArtifactEntailments (final int sentenceIdx)
 
List< TriplegetArtifactTriples (final int sentenceIdx)
 
ACoreferences getArtifactCoreferences () throws RuntimeException
 

Protected Attributes

ATextAnalysis textAnalysis
 
String text
 

Static Package Attributes

static XMLPrinter xMLPrinter = new XMLPrinterGrammarScope()
 

Static Private Member Functions

static List< SentenceSegmentgroupToSentence (final List< List< WordSegment >> sentenceWordSegments)
 
static List< WordSegmentflatten (final List< List< WordSegment >> sentenceWordSegments)
 
static Segment getSpan (final List<? extends Segment > segments)
 
static String tokensToString (final List< Token > tokens, final boolean isXml)
 
static String treeToString (final AParseTree parseTree, final boolean isXml)
 
static String grammaticalStructureToString (final AGrammaticalStructure grammaticalStructure, final boolean isXml)
 
static String typedDependenciesToString (final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >> semanticGraphs, final boolean isXml)
 
static String semanticGraphsToString (final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >> semanticGraphs, final boolean isXml)
 
static String namedEntitiesToString (final ANamedEntities namedEntities, final boolean isXml)
 
static String sentimentToString (final Sentiment sentiment, final boolean isXml)
 
static String entailmentsToString (final List< Entailment > entailments, final boolean isXml)
 
static String triplesToString (final List< Triple > triples, final boolean isXml)
 
static String coreferencesToString (final ACoreferences coreferences, final boolean isXml)
 
static List< SentenceSegmentgroupToSentence (final List< List< WordSegment >> sentenceWordSegments)
 
static List< WordSegmentflatten (final List< List< WordSegment >> sentenceWordSegments)
 
static Segment getSpan (final List<? extends Segment > segments)
 
static String tokensToString (final List< Token > tokens, final boolean isXml)
 
static String treeToString (final AParseTree parseTree, final boolean isXml)
 
static String grammaticalStructureToString (final AGrammaticalStructure grammaticalStructure, final boolean isXml)
 
static String typedDependenciesToString (final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >> semanticGraphs, final boolean isXml)
 
static String semanticGraphsToString (final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >> semanticGraphs, final boolean isXml)
 
static String namedEntitiesToString (final ANamedEntities namedEntities, final boolean isXml)
 
static String sentimentToString (final Sentiment sentiment, final boolean isXml)
 
static String entailmentsToString (final List< Entailment > entailments, final boolean isXml)
 
static String triplesToString (final List< Triple > triples, final boolean isXml)
 
static String coreferencesToString (final ACoreferences coreferences, final boolean isXml)
 

Private Attributes

List< WordSegmentwordSegments
 
List< SentenceSegmentsentenceSegments
 

Constructor & Destructor Documentation

◆ AbstractDocumentFactory() [1/2]

grammarscope.artifacts.AbstractDocumentFactory.AbstractDocumentFactory ( )

Constructor

◆ AbstractDocumentFactory() [2/2]

grammarscope.artifacts.AbstractDocumentFactory.AbstractDocumentFactory ( )

Constructor

Member Function Documentation

◆ coreferencesToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.coreferencesToString ( final ACoreferences  coreferences,
final boolean  isXml 
)
staticprivate

Coreferences to string

Parameters
coreferencescoreferences
isXmlxml format
Returns
string

◆ coreferencesToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.coreferencesToString ( final ACoreferences  coreferences,
final boolean  isXml 
)
staticprivate

Coreferences to string

Parameters
coreferencescoreferences
isXmlxml format
Returns
string

◆ entailmentsToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.entailmentsToString ( final List< Entailment entailments,
final boolean  isXml 
)
staticprivate

Entailments to string

Parameters
entailmentsentailments
isXmlxml format
Returns
string

◆ entailmentsToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.entailmentsToString ( final List< Entailment entailments,
final boolean  isXml 
)
staticprivate

Entailments to string

Parameters
entailmentsentailments
isXmlxml format
Returns
string

◆ flatten() [1/2]

static List<WordSegment> grammarscope.artifacts.AbstractDocumentFactory.flatten ( final List< List< WordSegment >>  sentenceWordSegments)
staticprivate

Flatten hierarchical list of per-sentence word segments

Parameters
sentenceWordSegmentshierarchical list of per-sentence word segments
Returns
flat word segment list

◆ flatten() [2/2]

static List<WordSegment> grammarscope.artifacts.AbstractDocumentFactory.flatten ( final List< List< WordSegment >>  sentenceWordSegments)
staticprivate

Flatten hierarchical list of per-sentence word segments

Parameters
sentenceWordSegmentshierarchical list of per-sentence word segments
Returns
flat word segment list

◆ getAnalysis() [1/2]

AAnalysis grammarscope.artifacts.AbstractDocumentFactory.getAnalysis ( final int  sentenceIdx) throws RuntimeException

Get (sentence) analysis artifact

Parameters
sentenceIdxsentence index
Returns
analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getAnalysis() [2/2]

AAnalysis grammarscope.artifacts.AbstractDocumentFactory.getAnalysis ( final int  sentenceIdx) throws RuntimeException

Get (sentence) analysis artifact

Parameters
sentenceIdxsentence index
Returns
analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getArtifactCoreferences() [1/2]

ACoreferences grammarscope.artifacts.AbstractDocumentFactory.getArtifactCoreferences ( ) throws RuntimeException
protected

Get coreferences

Returns
coreference data if successful

◆ getArtifactCoreferences() [2/2]

ACoreferences grammarscope.artifacts.AbstractDocumentFactory.getArtifactCoreferences ( ) throws RuntimeException
protected

Get coreferences

Returns
coreference data if successful

◆ getArtifactEntailments() [1/2]

List<Entailment> grammarscope.artifacts.AbstractDocumentFactory.getArtifactEntailments ( final int  sentenceIdx)
protected

Get entailments

Parameters
sentenceIdxsentence index
Returns
entailments
Exceptions
RuntimeExceptionexception

◆ getArtifactEntailments() [2/2]

List<Entailment> grammarscope.artifacts.AbstractDocumentFactory.getArtifactEntailments ( final int  sentenceIdx)
protected

Get entailments

Parameters
sentenceIdxsentence index
Returns
entailments
Exceptions
RuntimeExceptionexception

◆ getArtifactGrammaticalStructure() [1/2]

AGrammaticalStructure grammarscope.artifacts.AbstractDocumentFactory.getArtifactGrammaticalStructure ( final int  sentenceIdx) throws RuntimeException
protected

Get grammatical structure

Parameters
sentenceIdxsentence
Returns
grammatical structure if successful

◆ getArtifactGrammaticalStructure() [2/2]

AGrammaticalStructure grammarscope.artifacts.AbstractDocumentFactory.getArtifactGrammaticalStructure ( final int  sentenceIdx) throws RuntimeException
protected

Get grammatical structure

Parameters
sentenceIdxsentence
Returns
grammatical structure if successful

◆ getArtifactNamedEntities() [1/2]

ANamedEntities grammarscope.artifacts.AbstractDocumentFactory.getArtifactNamedEntities ( final int  sentenceIdx) throws RuntimeException
protected

Get named entities

Parameters
sentenceIdxsentence index
Returns
list of named entities
Exceptions
RuntimeExceptionexception

◆ getArtifactNamedEntities() [2/2]

ANamedEntities grammarscope.artifacts.AbstractDocumentFactory.getArtifactNamedEntities ( final int  sentenceIdx) throws RuntimeException
protected

Get named entities

Parameters
sentenceIdxsentence index
Returns
list of named entities
Exceptions
RuntimeExceptionexception

◆ getArtifactParseTree() [1/2]

AParseTree grammarscope.artifacts.AbstractDocumentFactory.getArtifactParseTree ( final int  sentenceIdx) throws RuntimeException
protected

Get parse tree

Parameters
sentenceIdxword list sentence
Returns
parse tree if successful
Exceptions
RuntimeExceptionexception

◆ getArtifactParseTree() [2/2]

AParseTree grammarscope.artifacts.AbstractDocumentFactory.getArtifactParseTree ( final int  sentenceIdx) throws RuntimeException
protected

Get parse tree

Parameters
sentenceIdxword list sentence
Returns
parse tree if successful
Exceptions
RuntimeExceptionexception

◆ getArtifactSegmentation() [1/2]

Segmentation grammarscope.artifacts.AbstractDocumentFactory.getArtifactSegmentation ( ) throws RuntimeException
protected

Get segmentation

Returns
segmentation
Exceptions
RuntimeExceptionexception

◆ getArtifactSegmentation() [2/2]

Segmentation grammarscope.artifacts.AbstractDocumentFactory.getArtifactSegmentation ( ) throws RuntimeException
protected

Get segmentation

Returns
segmentation
Exceptions
RuntimeExceptionexception

◆ getArtifactSemanticGraph() [1/2]

ASemanticGraph grammarscope.artifacts.AbstractDocumentFactory.getArtifactSemanticGraph ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException
protected

Get semantic graph

Parameters
sentenceIdxsentence
providertyped dependency provider
modetyped dependency mode
Returns
semantic graph if successful

◆ getArtifactSemanticGraph() [2/2]

ASemanticGraph grammarscope.artifacts.AbstractDocumentFactory.getArtifactSemanticGraph ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException
protected

Get semantic graph

Parameters
sentenceIdxsentence
providertyped dependency provider
modetyped dependency mode
Returns
semantic graph if successful

◆ getArtifactSemanticGraphs() [1/2]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ASemanticGraph> > grammarscope.artifacts.AbstractDocumentFactory.getArtifactSemanticGraphs ( final int  sentenceIdx) throws RuntimeException
protected

Get semantic graphs

Parameters
sentenceIdxsentence
Returns
semantic graphs if successful

◆ getArtifactSemanticGraphs() [2/2]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ASemanticGraph> > grammarscope.artifacts.AbstractDocumentFactory.getArtifactSemanticGraphs ( final int  sentenceIdx) throws RuntimeException
protected

Get semantic graphs

Parameters
sentenceIdxsentence
Returns
semantic graphs if successful

◆ getArtifactSentiment() [1/2]

Sentiment grammarscope.artifacts.AbstractDocumentFactory.getArtifactSentiment ( final int  sentenceIdx) throws RuntimeException
protected

Get sentiment

Parameters
sentenceIdxsentence index
Returns
sentiment
Exceptions
RuntimeExceptionexception

◆ getArtifactSentiment() [2/2]

Sentiment grammarscope.artifacts.AbstractDocumentFactory.getArtifactSentiment ( final int  sentenceIdx) throws RuntimeException
protected

Get sentiment

Parameters
sentenceIdxsentence index
Returns
sentiment
Exceptions
RuntimeExceptionexception

◆ getArtifactTriples() [1/2]

List<Triple> grammarscope.artifacts.AbstractDocumentFactory.getArtifactTriples ( final int  sentenceIdx)
protected

Get triples

Parameters
sentenceIdxsentence index
Returns
triples
Exceptions
RuntimeExceptionexception

◆ getArtifactTriples() [2/2]

List<Triple> grammarscope.artifacts.AbstractDocumentFactory.getArtifactTriples ( final int  sentenceIdx)
protected

Get triples

Parameters
sentenceIdxsentence index
Returns
triples
Exceptions
RuntimeExceptionexception

◆ getArtifactTypedDependencies() [1/3]

Map<TypedDependencyMode, ATypedDependencies> grammarscope.artifacts.AbstractDocumentFactory.getArtifactTypedDependencies ( final int  sentenceIdx,
final TypedDependencyProvider  provider 
) throws RuntimeException
protected

Get typed dependencies

Parameters
sentenceIdxsentence
providertyped dependency provider
Returns
typed dependencies if successful
Exceptions
RuntimeExceptionexception

◆ getArtifactTypedDependencies() [2/3]

ATypedDependencies grammarscope.artifacts.AbstractDocumentFactory.getArtifactTypedDependencies ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException
protected

Get typed dependencies

Parameters
sentenceIdxsentence
providertyped dependency provider
modetyped dependency mode
Returns
typed dependencies if successful
Exceptions
RuntimeExceptionexception

◆ getArtifactTypedDependencies() [3/3]

ATypedDependencies grammarscope.artifacts.AbstractDocumentFactory.getArtifactTypedDependencies ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException
protected

Get typed dependencies

Parameters
sentenceIdxsentence
providertyped dependency provider
modetyped dependency mode
Returns
typed dependencies if successful
Exceptions
RuntimeExceptionexception

◆ getCoreferences() [1/2]

ACoreferences grammarscope.artifacts.AbstractDocumentFactory.getCoreferences ( ) throws RuntimeException

Get coreferences artifact

Returns
coreferences artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getCoreferences() [2/2]

ACoreferences grammarscope.artifacts.AbstractDocumentFactory.getCoreferences ( ) throws RuntimeException

Get coreferences artifact

Returns
coreferences artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getEntailments() [1/2]

List<Entailment> grammarscope.artifacts.AbstractDocumentFactory.getEntailments ( final int  sentenceIdx)

Get entailments

Parameters
sentenceIdxsentence index
Returns
entailments if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getEntailments() [2/2]

List<Entailment> grammarscope.artifacts.AbstractDocumentFactory.getEntailments ( final int  sentenceIdx)

Get entailments

Parameters
sentenceIdxsentence index
Returns
entailments if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getGrammaticalStructure() [1/2]

AGrammaticalStructure grammarscope.artifacts.AbstractDocumentFactory.getGrammaticalStructure ( final int  sentenceIdx) throws RuntimeException

Get grammatical structure artifact

Parameters
sentenceIdxsentence index
Returns
grammatical structure artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getGrammaticalStructure() [2/2]

AGrammaticalStructure grammarscope.artifacts.AbstractDocumentFactory.getGrammaticalStructure ( final int  sentenceIdx) throws RuntimeException

Get grammatical structure artifact

Parameters
sentenceIdxsentence index
Returns
grammatical structure artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getNamedEntities() [1/2]

ANamedEntities grammarscope.artifacts.AbstractDocumentFactory.getNamedEntities ( final int  sentenceIdx) throws RuntimeException

Get named entities artifact

Parameters
sentenceIdxsentence index
Returns
named entities artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getNamedEntities() [2/2]

ANamedEntities grammarscope.artifacts.AbstractDocumentFactory.getNamedEntities ( final int  sentenceIdx) throws RuntimeException

Get named entities artifact

Parameters
sentenceIdxsentence index
Returns
named entities artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getParseTree() [1/2]

AParseTree grammarscope.artifacts.AbstractDocumentFactory.getParseTree ( final int  sentenceIdx) throws RuntimeException

Get parse artifact

Parameters
sentenceIdxsentence index
Returns
parse tree artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getParseTree() [2/2]

AParseTree grammarscope.artifacts.AbstractDocumentFactory.getParseTree ( final int  sentenceIdx) throws RuntimeException

Get parse artifact

Parameters
sentenceIdxsentence index
Returns
parse tree artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getPoses() [1/2]

APartsOfSpeech grammarscope.artifacts.AbstractDocumentFactory.getPoses ( final int  sentenceIdx) throws RuntimeException

Get parts-of-speech artifact

Parameters
sentenceIdxsentence index
Returns
parts-of-speech artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getPoses() [2/2]

APartsOfSpeech grammarscope.artifacts.AbstractDocumentFactory.getPoses ( final int  sentenceIdx) throws RuntimeException

Get parts-of-speech artifact

Parameters
sentenceIdxsentence index
Returns
parts-of-speech artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getRelationDependents() [1/2]

ARelationDependents grammarscope.artifacts.AbstractDocumentFactory.getRelationDependents ( final int  sentenceIdx) throws RuntimeException

Get relation dependents artifact

Parameters
sentenceIdxsentence index
Returns
relation dependents artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getRelationDependents() [2/2]

ARelationDependents grammarscope.artifacts.AbstractDocumentFactory.getRelationDependents ( final int  sentenceIdx) throws RuntimeException

Get relation dependents artifact

Parameters
sentenceIdxsentence index
Returns
relation dependents artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReport() [1/2]

String grammarscope.artifacts.AbstractDocumentFactory.getReport ( final int  sentenceIdx,
final boolean  xmlFlag 
) throws RuntimeException

Get (sentence) analysis string

Parameters
sentenceIdxsentence index
xmlFlagXML format requested
Returns
string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReport() [2/2]

String grammarscope.artifacts.AbstractDocumentFactory.getReport ( final int  sentenceIdx,
final boolean  xmlFlag 
) throws RuntimeException

Get (sentence) analysis string

Parameters
sentenceIdxsentence index
xmlFlagXML format requested
Returns
string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReports() [1/2]

String [] grammarscope.artifacts.AbstractDocumentFactory.getReports ( final int  sentenceIdx,
final boolean  xmlFlag 
) throws RuntimeException

Get (sentence) analysis strings

Parameters
sentenceIdxsentence index
xmlFlagXML format requested
Returns
array of strings [0] text, [1] parse tree, [2] grammatical structure, [3] typed dependencies, [4] semantic graph if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReports() [2/2]

String [] grammarscope.artifacts.AbstractDocumentFactory.getReports ( final int  sentenceIdx,
final boolean  xmlFlag 
) throws RuntimeException

Get (sentence) analysis strings

Parameters
sentenceIdxsentence index
xmlFlagXML format requested
Returns
array of strings [0] text, [1] parse tree, [2] grammatical structure, [3] typed dependencies, [4] semantic graph if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSemanticGraph() [1/2]

ASemanticGraph grammarscope.artifacts.AbstractDocumentFactory.getSemanticGraph ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException

Get semantic graph artifact

Parameters
sentenceIdxsentence index
providertyped dependency provider
modetyped dependency mode
Returns
semantic graph artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSemanticGraph() [2/2]

ASemanticGraph grammarscope.artifacts.AbstractDocumentFactory.getSemanticGraph ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException

Get semantic graph artifact

Parameters
sentenceIdxsentence index
providertyped dependency provider
modetyped dependency mode
Returns
semantic graph artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSemanticGraphs() [1/2]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ASemanticGraph> > grammarscope.artifacts.AbstractDocumentFactory.getSemanticGraphs ( final int  sentenceIdx) throws RuntimeException

Get semantic graph artifacts

Parameters
sentenceIdxsentence index
Returns
typed dependency mode-indexed semantic graph artifacts if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSemanticGraphs() [2/2]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ASemanticGraph> > grammarscope.artifacts.AbstractDocumentFactory.getSemanticGraphs ( final int  sentenceIdx) throws RuntimeException

Get semantic graph artifacts

Parameters
sentenceIdxsentence index
Returns
typed dependency mode-indexed semantic graph artifacts if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentenceCount() [1/2]

int grammarscope.artifacts.AbstractDocumentFactory.getSentenceCount ( ) throws RuntimeException

Get sentence count

Returns
sentence count

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentenceCount() [2/2]

int grammarscope.artifacts.AbstractDocumentFactory.getSentenceCount ( ) throws RuntimeException

Get sentence count

Returns
sentence count

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentences() [1/2]

List<SentenceSegment> grammarscope.artifacts.AbstractDocumentFactory.getSentences ( ) throws RuntimeException

Get sentences

Returns
list of sentence segments

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentences() [2/2]

List<SentenceSegment> grammarscope.artifacts.AbstractDocumentFactory.getSentences ( ) throws RuntimeException

Get sentences

Returns
list of sentence segments

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentiment() [1/2]

Sentiment grammarscope.artifacts.AbstractDocumentFactory.getSentiment ( final int  sentenceIdx)

Get sentiment

Parameters
sentenceIdxsentence index
Returns
sentiment if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentiment() [2/2]

Sentiment grammarscope.artifacts.AbstractDocumentFactory.getSentiment ( final int  sentenceIdx)

Get sentiment

Parameters
sentenceIdxsentence index
Returns
sentiment if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSpan() [1/2]

static Segment grammarscope.artifacts.AbstractDocumentFactory.getSpan ( final List<? extends Segment segments)
staticprivate

Span

Parameters
segmentssegments
Returns
merged segment

◆ getSpan() [2/2]

static Segment grammarscope.artifacts.AbstractDocumentFactory.getSpan ( final List<? extends Segment segments)
staticprivate

Span

Parameters
segmentssegments
Returns
merged segment

◆ getSupportedModes() [1/2]

TypedDependencyMode [] grammarscope.artifacts.AbstractDocumentFactory.getSupportedModes ( ) throws RuntimeException

◆ getSupportedModes() [2/2]

TypedDependencyMode [] grammarscope.artifacts.AbstractDocumentFactory.getSupportedModes ( ) throws RuntimeException

◆ getSupportedProviders() [1/2]

TypedDependencyProvider [] grammarscope.artifacts.AbstractDocumentFactory.getSupportedProviders ( ) throws RuntimeException

Get supported typed dependency providers

Returns
array of supported typed dependency providers

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSupportedProviders() [2/2]

TypedDependencyProvider [] grammarscope.artifacts.AbstractDocumentFactory.getSupportedProviders ( ) throws RuntimeException

Get supported typed dependency providers

Returns
array of supported typed dependency providers

Implements grammarscope.iface.IDocumentFactoryService.

◆ getText() [1/2]

String grammarscope.artifacts.AbstractDocumentFactory.getText ( ) throws RuntimeException

Get text

Returns
(original or reconstructed) text

Implements grammarscope.iface.IDocumentFactoryService.

◆ getText() [2/2]

String grammarscope.artifacts.AbstractDocumentFactory.getText ( ) throws RuntimeException

Get text

Returns
(original or reconstructed) text

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextAnalysis() [1/4]

ATextAnalysis grammarscope.artifacts.AbstractDocumentFactory.getTextAnalysis ( )
protected

◆ getTextAnalysis() [2/4]

ATextAnalysis grammarscope.artifacts.AbstractDocumentFactory.getTextAnalysis ( )
protected

◆ getTextAnalysis() [3/4]

ATextAnalysis grammarscope.artifacts.AbstractDocumentFactory.getTextAnalysis ( final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException

Get text analysis

Parameters
providerprovider
modemode
Returns
text analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextAnalysis() [4/4]

ATextAnalysis grammarscope.artifacts.AbstractDocumentFactory.getTextAnalysis ( final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException

Get text analysis

Parameters
providerprovider
modemode
Returns
text analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextReport() [1/2]

String grammarscope.artifacts.AbstractDocumentFactory.getTextReport ( final TypedDependencyProvider  provider,
final TypedDependencyMode  mode,
final boolean  xmlFlag 
) throws RuntimeException

Get (text) analysis string

Parameters
providerprovider
modemode
xmlFlagXML format requested
Returns
string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextReport() [2/2]

String grammarscope.artifacts.AbstractDocumentFactory.getTextReport ( final TypedDependencyProvider  provider,
final TypedDependencyMode  mode,
final boolean  xmlFlag 
) throws RuntimeException

Get (text) analysis string

Parameters
providerprovider
modemode
xmlFlagXML format requested
Returns
string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextReports() [1/2]

String [] grammarscope.artifacts.AbstractDocumentFactory.getTextReports ( final TypedDependencyProvider  provider,
final TypedDependencyMode  mode,
final boolean  xmlFlag 
) throws RuntimeException

Get (text) analysis strings

Parameters
providerprovider
modemode
xmlFlagXML format requested
Returns
array of strings [0] text, [1] coreference, [2] sentence1, [3] sentence2, ...

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextReports() [2/2]

String [] grammarscope.artifacts.AbstractDocumentFactory.getTextReports ( final TypedDependencyProvider  provider,
final TypedDependencyMode  mode,
final boolean  xmlFlag 
) throws RuntimeException

Get (text) analysis strings

Parameters
providerprovider
modemode
xmlFlagXML format requested
Returns
array of strings [0] text, [1] coreference, [2] sentence1, [3] sentence2, ...

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTokens() [1/2]

List<Token> grammarscope.artifacts.AbstractDocumentFactory.getTokens ( final int  sentenceIdx) throws RuntimeException

Get tokens

Parameters
sentenceIdxsentence index
Returns
tokens
Exceptions
RuntimeExceptionruntime exception

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTokens() [2/2]

List<Token> grammarscope.artifacts.AbstractDocumentFactory.getTokens ( final int  sentenceIdx) throws RuntimeException

Get tokens

Parameters
sentenceIdxsentence index
Returns
tokens
Exceptions
RuntimeExceptionruntime exception

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTriples() [1/2]

List<Triple> grammarscope.artifacts.AbstractDocumentFactory.getTriples ( final int  sentenceIdx)

Get triples

Parameters
sentenceIdxsentence index
Returns
triples if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTriples() [2/2]

List<Triple> grammarscope.artifacts.AbstractDocumentFactory.getTriples ( final int  sentenceIdx)

Get triples

Parameters
sentenceIdxsentence index
Returns
triples if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [1/4]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ATypedDependencies> > grammarscope.artifacts.AbstractDocumentFactory.getTypedDependencies ( final int  sentenceIdx) throws RuntimeException

Get typed dependencies artifact

Parameters
sentenceIdxsentence index
Returns
typed dependency mode-indexed typed dependencies artifacts if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [2/4]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ATypedDependencies> > grammarscope.artifacts.AbstractDocumentFactory.getTypedDependencies ( final int  sentenceIdx) throws RuntimeException

Get typed dependencies artifact

Parameters
sentenceIdxsentence index
Returns
typed dependency mode-indexed typed dependencies artifacts if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [3/4]

ATypedDependencies grammarscope.artifacts.AbstractDocumentFactory.getTypedDependencies ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException

Get typed dependencies artifact

Parameters
sentenceIdxsentence index
providertyped dependency provider
modetyped dependency mode
Returns
typed dependencies artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [4/4]

ATypedDependencies grammarscope.artifacts.AbstractDocumentFactory.getTypedDependencies ( final int  sentenceIdx,
final TypedDependencyProvider  provider,
final TypedDependencyMode  mode 
) throws RuntimeException

Get typed dependencies artifact

Parameters
sentenceIdxsentence index
providertyped dependency provider
modetyped dependency mode
Returns
typed dependencies artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getWords() [1/2]

List<WordSegment> grammarscope.artifacts.AbstractDocumentFactory.getWords ( ) throws RuntimeException

Get words

Returns
list of word segments

Implements grammarscope.iface.IDocumentFactoryService.

◆ getWords() [2/2]

List<WordSegment> grammarscope.artifacts.AbstractDocumentFactory.getWords ( ) throws RuntimeException

Get words

Returns
list of word segments

Implements grammarscope.iface.IDocumentFactoryService.

◆ grammaticalStructureToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.grammaticalStructureToString ( final AGrammaticalStructure  grammaticalStructure,
final boolean  isXml 
)
staticprivate

Grammatical structure to string

Parameters
grammaticalStructuregrammatical structure
isXmlxml format
Returns
string

◆ grammaticalStructureToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.grammaticalStructureToString ( final AGrammaticalStructure  grammaticalStructure,
final boolean  isXml 
)
staticprivate

Grammatical structure to string

Parameters
grammaticalStructuregrammatical structure
isXmlxml format
Returns
string

◆ groupToSentence() [1/2]

static List<SentenceSegment> grammarscope.artifacts.AbstractDocumentFactory.groupToSentence ( final List< List< WordSegment >>  sentenceWordSegments)
staticprivate

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

Parameters
sentenceWordSegmentslist of sentences
Returns
list of segments

◆ groupToSentence() [2/2]

static List<SentenceSegment> grammarscope.artifacts.AbstractDocumentFactory.groupToSentence ( final List< List< WordSegment >>  sentenceWordSegments)
staticprivate

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

Parameters
sentenceWordSegmentslist of sentences
Returns
list of segments

◆ init() [1/2]

boolean grammarscope.artifacts.AbstractDocumentFactory.init ( final String  text)

◆ init() [2/2]

boolean grammarscope.artifacts.AbstractDocumentFactory.init ( final String  text)

◆ namedEntitiesToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.namedEntitiesToString ( final ANamedEntities  namedEntities,
final boolean  isXml 
)
staticprivate

Named entities to string

Parameters
namedEntitiesnamed entities
isXmlxml format
Returns
string

◆ namedEntitiesToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.namedEntitiesToString ( final ANamedEntities  namedEntities,
final boolean  isXml 
)
staticprivate

Named entities to string

Parameters
namedEntitiesnamed entities
isXmlxml format
Returns
string

◆ processText() [1/2]

abstract String grammarscope.artifacts.AbstractDocumentFactory.processText ( final String  text) throws Exception
abstract

◆ processText() [2/2]

abstract String grammarscope.artifacts.AbstractDocumentFactory.processText ( final String  text) throws Exception
abstract

◆ semanticGraphsToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.semanticGraphsToString ( final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >>  semanticGraphs,
final boolean  isXml 
)
staticprivate

Semantic graph to string

Parameters
semanticGraphssemantic graphs
isXmlxml format
Returns
string

◆ semanticGraphsToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.semanticGraphsToString ( final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >>  semanticGraphs,
final boolean  isXml 
)
staticprivate

Semantic graph to string

Parameters
semanticGraphssemantic graphs
isXmlxml format
Returns
string

◆ sentimentToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.sentimentToString ( final Sentiment  sentiment,
final boolean  isXml 
)
staticprivate

Sentiment to string

Parameters
sentimentsentiment
isXmlxml format
Returns
string

◆ sentimentToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.sentimentToString ( final Sentiment  sentiment,
final boolean  isXml 
)
staticprivate

Sentiment to string

Parameters
sentimentsentiment
isXmlxml format
Returns
string

◆ tokensToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.tokensToString ( final List< Token tokens,
final boolean  isXml 
)
staticprivate

Tokens to string

Parameters
tokenstokens
isXmlxml format
Returns
string

◆ tokensToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.tokensToString ( final List< Token tokens,
final boolean  isXml 
)
staticprivate

Tokens to string

Parameters
tokenstokens
isXmlxml format
Returns
string

◆ treeToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.treeToString ( final AParseTree  parseTree,
final boolean  isXml 
)
staticprivate

Parse tree to string

Parameters
parseTreeparse tree
isXmlxml format
Returns
string

◆ treeToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.treeToString ( final AParseTree  parseTree,
final boolean  isXml 
)
staticprivate

Parse tree to string

Parameters
parseTreeparse tree
isXmlxml format
Returns
string

◆ triplesToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.triplesToString ( final List< Triple triples,
final boolean  isXml 
)
staticprivate

Triples to string

Parameters
triplestriples
isXmlxml format
Returns
string

◆ triplesToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.triplesToString ( final List< Triple triples,
final boolean  isXml 
)
staticprivate

Triples to string

Parameters
triplestriples
isXmlxml format
Returns
string

◆ typedDependenciesToString() [1/2]

static String grammarscope.artifacts.AbstractDocumentFactory.typedDependenciesToString ( final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >>  semanticGraphs,
final boolean  isXml 
)
staticprivate

Typed dependencies to string

Parameters
semanticGraphssemantic graphs
isXmlxml format
Returns
string

◆ typedDependenciesToString() [2/2]

static String grammarscope.artifacts.AbstractDocumentFactory.typedDependenciesToString ( final Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph >>  semanticGraphs,
final boolean  isXml 
)
staticprivate

Typed dependencies to string

Parameters
semanticGraphssemantic graphs
isXmlxml format
Returns
string

Member Data Documentation

◆ sentenceSegments

List< SentenceSegment > grammarscope.artifacts.AbstractDocumentFactory.sentenceSegments
private

Sentence segments

◆ text

String grammarscope.artifacts.AbstractDocumentFactory.text
protected

Text

◆ textAnalysis

ATextAnalysis grammarscope.artifacts.AbstractDocumentFactory.textAnalysis
protected

Analysis

◆ wordSegments

List< WordSegment > grammarscope.artifacts.AbstractDocumentFactory.wordSegments
private

Word segments

◆ xMLPrinter

static XMLPrinter grammarscope.artifacts.AbstractDocumentFactory.xMLPrinter = new XMLPrinterGrammarScope()
staticpackage

XML Printer


The documentation for this class was generated from the following file: