Inheritance diagram for grammarscope.server.NullDocumentFactory:

Collaboration diagram for grammarscope.server.NullDocumentFactory:

Public Member Functions
boolean	init (final String text)

String	getText () throws RuntimeException

List< WordSegment >	getWords () throws RuntimeException

List< SentenceSegment >	getSentences () throws RuntimeException

int	getSentenceCount () throws RuntimeException

List< Token >	getTokens (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) throws RuntimeException

List< Entailment >	getEntailments (final int sentenceIdx) throws RuntimeException

List< Triple >	getTriples (final int sentenceIdx) throws RuntimeException

ACoreferences	getCoreferences () throws RuntimeException

AAnalysis	getAnalysis (final int sentenceIdx) throws RuntimeException

ATextAnalysis	getTextAnalysis (final TypedDependencyProvider provider, final TypedDependencyMode mode) throws RuntimeException

String	getReport (final int sentenceIdx, final boolean xmlFlag) throws RuntimeException

String[]	getReports (final int sentenceIdx, final boolean xmlFlag) throws RuntimeException

String	getTextReport (final TypedDependencyProvider provider, final TypedDependencyMode mode, final boolean xmlFlag) throws RuntimeException

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

TypedDependencyProvider[]	getSupportedProviders ()

TypedDependencyMode[]	getSupportedModes ()

Private Attributes
String	text

Member Function Documentation

◆ getAnalysis()

AAnalysis grammarscope.server.NullDocumentFactory.getAnalysis ( final int sentenceIdx ) throws RuntimeException

Get (sentence) analysis artifact

Parameters

sentenceIdx sentence index

Returns: analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getCoreferences()

ACoreferences grammarscope.server.NullDocumentFactory.getCoreferences ( ) throws RuntimeException

Get coreferences artifact

Returns: coreferences artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getEntailments()

List<Entailment> grammarscope.server.NullDocumentFactory.getEntailments ( final int sentenceIdx ) throws RuntimeException

Get entailments

Parameters

sentenceIdx sentence index

Returns: entailments if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getGrammaticalStructure()

AGrammaticalStructure grammarscope.server.NullDocumentFactory.getGrammaticalStructure ( final int sentenceIdx ) throws RuntimeException

Get grammatical structure artifact

Parameters

sentenceIdx sentence index

Returns: grammatical structure artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getNamedEntities()

ANamedEntities grammarscope.server.NullDocumentFactory.getNamedEntities ( final int sentenceIdx ) throws RuntimeException

Get named entities artifact

Parameters

sentenceIdx sentence index

Returns: named entities artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getParseTree()

AParseTree grammarscope.server.NullDocumentFactory.getParseTree ( final int sentenceIdx ) throws RuntimeException

Get parse artifact

Parameters

sentenceIdx sentence index

Returns: parse tree artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getPoses()

APartsOfSpeech grammarscope.server.NullDocumentFactory.getPoses ( final int sentenceIdx ) throws RuntimeException

Get parts-of-speech artifact

Parameters

sentenceIdx sentence index

Returns: parts-of-speech artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getRelationDependents()

ARelationDependents grammarscope.server.NullDocumentFactory.getRelationDependents ( final int sentenceIdx ) throws RuntimeException

Get relation dependents artifact

Parameters

sentenceIdx sentence index

Returns: relation dependents artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReport()

String grammarscope.server.NullDocumentFactory.getReport	(	final int	sentenceIdx,
		final boolean	xmlFlag
	)		throws RuntimeException

Get (sentence) analysis string

Parameters

sentenceIdx	sentence index
xmlFlag	XML format requested

Returns: string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReports()

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

Get (sentence) analysis strings

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

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSemanticGraph()

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

Get semantic graph artifact

Parameters

sentenceIdx	sentence index
provider	typed dependency provider
mode	typed dependency mode

Returns: semantic graph artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSemanticGraphs()

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

Get semantic graph artifacts

Parameters

sentenceIdx sentence index

Returns: typed dependency mode-indexed semantic graph artifacts if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentenceCount()

int grammarscope.server.NullDocumentFactory.getSentenceCount ( ) throws RuntimeException

Get sentence count

Returns: sentence count

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentences()

List<SentenceSegment> grammarscope.server.NullDocumentFactory.getSentences ( ) throws RuntimeException

Get sentences

Returns: list of sentence segments

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSentiment()

Sentiment grammarscope.server.NullDocumentFactory.getSentiment ( final int sentenceIdx ) throws RuntimeException

Get sentiment

Parameters

sentenceIdx sentence index

Returns: sentiment if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSupportedModes()

TypedDependencyMode [] grammarscope.server.NullDocumentFactory.getSupportedModes ( )

Get supported typed dependency modes

Returns: array of supported typed dependency modes

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSupportedProviders()

TypedDependencyProvider [] grammarscope.server.NullDocumentFactory.getSupportedProviders ( )

Get supported typed dependency providers

Returns: array of supported typed dependency providers

Implements grammarscope.iface.IDocumentFactoryService.

◆ getText()

String grammarscope.server.NullDocumentFactory.getText ( ) throws RuntimeException

Get text

Returns: (original or reconstructed) text

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextAnalysis()

ATextAnalysis grammarscope.server.NullDocumentFactory.getTextAnalysis	(	final TypedDependencyProvider	provider,
		final TypedDependencyMode	mode
	)		throws RuntimeException

Get text analysis

Parameters

provider	provider
mode	mode

Returns: text analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextReport()

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

Get (text) analysis string

Parameters

provider	provider
mode	mode
xmlFlag	XML format requested

Returns: string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextReports()

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

Get (text) analysis strings

Parameters

provider	provider
mode	mode
xmlFlag	XML format requested

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

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTokens()

List<Token> grammarscope.server.NullDocumentFactory.getTokens ( final int sentenceIdx ) throws RuntimeException

Get tokens

Parameters

sentenceIdx sentence index

Returns: tokens

Exceptions

RuntimeException runtime exception

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTriples()

List<Triple> grammarscope.server.NullDocumentFactory.getTriples ( final int sentenceIdx ) throws RuntimeException

Get triples

Parameters

sentenceIdx sentence index

Returns: triples if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [1/2]

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

Get typed dependencies artifact

Parameters

sentenceIdx sentence index

Returns: typed dependency mode-indexed typed dependencies artifacts if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [2/2]

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

Get typed dependencies artifact

Parameters

sentenceIdx	sentence index
provider	typed dependency provider
mode	typed dependency mode

Returns: typed dependencies artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getWords()

List<WordSegment> grammarscope.server.NullDocumentFactory.getWords ( ) throws RuntimeException

Get words

Returns: list of word segments

Implements grammarscope.iface.IDocumentFactoryService.

◆ init()

boolean grammarscope.server.NullDocumentFactory.init ( final String text )

Init processing

Parameters

text	input text

Returns: true if successful

Implements grammarscope.iface.IDocumentFactory.

Member Data Documentation

◆ text

String grammarscope.server.NullDocumentFactory.text

private

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

grammarscope/library/src/main/java/grammarscope/server/NullDocumentFactory.java

Public Member Functions

Private Attributes

Member Function Documentation

◆ getAnalysis()

◆ getCoreferences()

◆ getEntailments()

◆ getGrammaticalStructure()

◆ getNamedEntities()

◆ getParseTree()

◆ getPoses()

◆ getRelationDependents()

◆ getReport()

◆ getReports()

◆ getSemanticGraph()

◆ getSemanticGraphs()

◆ getSentenceCount()

◆ getSentences()

◆ getSentiment()

◆ getSupportedModes()

◆ getSupportedProviders()

◆ getText()

◆ getTextAnalysis()

◆ getTextReport()

◆ getTextReports()

◆ getTokens()

◆ getTriples()

◆ getTypedDependencies() [1/2]

◆ getTypedDependencies() [2/2]

◆ getWords()

◆ init()

Member Data Documentation

◆ text