grammarscope.iface.IDocumentFactoryService Interface Reference

Inheritance diagram for grammarscope.iface.IDocumentFactoryService:

Public Member Functions
String	getText () throws RuntimeException
List< WordSegment >	getWords () throws RuntimeException
List< SentenceSegment >	getSentences () throws RuntimeException
int	getSentenceCount () throws RuntimeException
List< Token >	getTokens (int sentenceIdx) throws RuntimeException
AParseTree	getParseTree (int sentenceIdx) throws RuntimeException
APartsOfSpeech	getPoses (int sentenceIdx) throws RuntimeException
AGrammaticalStructure	getGrammaticalStructure (int sentenceIdx) throws RuntimeException
ARelationDependents	getRelationDependents (int sentenceIdx) throws RuntimeException
ATypedDependencies	getTypedDependencies (int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) throws RuntimeException
Map< TypedDependencyProvider, Map< TypedDependencyMode, ATypedDependencies > >	getTypedDependencies (int sentenceIdx) throws RuntimeException
ASemanticGraph	getSemanticGraph (int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) throws RuntimeException
Map< TypedDependencyProvider, Map< TypedDependencyMode, ASemanticGraph > >	getSemanticGraphs (int sentenceIdx) throws RuntimeException
ANamedEntities	getNamedEntities (int sentenceIdx) throws RuntimeException
Sentiment	getSentiment (int sentenceIdx) throws RuntimeException
List< Entailment >	getEntailments (int sentenceIdx) throws RuntimeException
List< Triple >	getTriples (int sentenceIdx) throws RuntimeException
ACoreferences	getCoreferences () throws RuntimeException
AAnalysis	getAnalysis (int sentenceIdx) throws RuntimeException
ATextAnalysis	getTextAnalysis (TypedDependencyProvider provider, TypedDependencyMode mode) throws RuntimeException
String	getReport (int sentenceIdx, boolean xmlFlag) throws RuntimeException
String[]	getReports (int sentenceIdx, boolean xmlFlag) throws RuntimeException
String	getTextReport (TypedDependencyProvider provider, TypedDependencyMode mode, boolean xmlFlag) throws RuntimeException
String[]	getTextReports (TypedDependencyProvider provider, TypedDependencyMode mode, boolean xmlFlag) throws RuntimeException
TypedDependencyProvider[]	getSupportedProviders ()
TypedDependencyMode[]	getSupportedModes ()

Detailed Description

Server-side interface used when document is being built. Used in server to client communication

Author

Bernard Bou [1313o.nosp@m.u@gm.nosp@m.ail.c.nosp@m.om]

Member Function Documentation

getAnalysis()

AAnalysis grammarscope.iface.IDocumentFactoryService.getAnalysis

(

int

sentenceIdx

)

throws RuntimeException

Get (sentence) analysis artifact

Parameters

sentenceIdx

sentence index

Returns

analysis if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getCoreferences()

ACoreferences grammarscope.iface.IDocumentFactoryService.getCoreferences

(

)

throws RuntimeException

Get coreferences artifact

Returns

coreferences artifact if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getEntailments()

List<Entailment> grammarscope.iface.IDocumentFactoryService.getEntailments

(

int

sentenceIdx

)

throws RuntimeException

Get entailments

Parameters

sentenceIdx

sentence index

Returns

entailments if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getGrammaticalStructure()

AGrammaticalStructure grammarscope.iface.IDocumentFactoryService.getGrammaticalStructure

(

int

sentenceIdx

)

throws RuntimeException

Get grammatical structure artifact

Parameters

sentenceIdx

sentence index

Returns

grammatical structure artifact if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getNamedEntities()

ANamedEntities grammarscope.iface.IDocumentFactoryService.getNamedEntities

(

int

sentenceIdx

)

throws RuntimeException

Get named entities artifact

Parameters

sentenceIdx

sentence index

Returns

named entities artifact if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getParseTree()

AParseTree grammarscope.iface.IDocumentFactoryService.getParseTree

(

int

sentenceIdx

)

throws RuntimeException

Get parse artifact

Parameters

sentenceIdx

sentence index

Returns

parse tree artifact if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getPoses()

APartsOfSpeech grammarscope.iface.IDocumentFactoryService.getPoses

(

int

sentenceIdx

)

throws RuntimeException

Get parts-of-speech artifact

Parameters

sentenceIdx

sentence index

Returns

parts-of-speech artifact if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getRelationDependents()

ARelationDependents grammarscope.iface.IDocumentFactoryService.getRelationDependents

(

int

sentenceIdx

)

throws RuntimeException

Get relation dependents artifact

Parameters

sentenceIdx

sentence index

Returns

relation dependents artifact if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getReport()

String grammarscope.iface.IDocumentFactoryService.getReport	(	int	sentenceIdx,
		boolean	xmlFlag
	)		throws RuntimeException

Get (sentence) analysis string

Parameters

sentenceIdx	sentence index
xmlFlag	XML format requested

Returns

string

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getReports()

String [] grammarscope.iface.IDocumentFactoryService.getReports	(	int	sentenceIdx,
		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

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getSemanticGraph()

ASemanticGraph grammarscope.iface.IDocumentFactoryService.getSemanticGraph	(	int	sentenceIdx,
		TypedDependencyProvider	provider,
		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

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getSemanticGraphs()

Map<TypedDependencyProvider, Map<TypedDependencyMode, ASemanticGraph> > grammarscope.iface.IDocumentFactoryService.getSemanticGraphs

(

int

sentenceIdx

)

throws RuntimeException

Get semantic graph artifacts

Parameters

sentenceIdx

sentence index

Returns

typed dependency mode-indexed semantic graph artifacts if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getSentenceCount()

int grammarscope.iface.IDocumentFactoryService.getSentenceCount

(

)

throws RuntimeException

Get sentence count

Returns

sentence count

Implemented in grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getSentences()

List<SentenceSegment> grammarscope.iface.IDocumentFactoryService.getSentences

(

)

throws RuntimeException

Get sentences

Returns

list of sentence segments

Implemented in grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.glue.corenlp.DocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getSentiment()

Sentiment grammarscope.iface.IDocumentFactoryService.getSentiment

(

int

sentenceIdx

)

throws RuntimeException

Get sentiment

Parameters

sentenceIdx

sentence index

Returns

sentiment if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getSupportedModes()

TypedDependencyMode [] grammarscope.iface.IDocumentFactoryService.getSupportedModes

(

)

Get supported typed dependency modes

Returns

array of supported typed dependency modes

Implemented in grammarscope.document.Document, grammarscope.io.xml.XMLDocumentFactory, grammarscope.glue.parser.DocumentFactory, grammarscope.glue.AbstractDocumentFactory, grammarscope.glue.corenlp.DocumentFactory, grammarscope.server.NullDocumentFactory, grammarscope.ejb.client.parser.DocumentFactory, grammarscope.ejb.client.corenlp.DocumentFactory, grammarscope.ejb.client.corenlp.DocumentFactory, grammarscope.ejb.client.parser.DocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.ejb.client.corenlp.DocumentFactoryAsync, grammarscope.artifacts.ejb.client.corenlp.DocumentFactorySync, grammarscope.artifacts.ejb.client.parser.DocumentFactoryAsync, grammarscope.artifacts.ejb.client.parser.DocumentFactorySync, grammarscope.artifacts.ejb.client.corenlp.DocumentFactorySync, grammarscope.artifacts.ejb.client.parser.DocumentFactoryAsync, and grammarscope.artifacts.ejb.client.parser.DocumentFactorySync.

getSupportedProviders()

TypedDependencyProvider [] grammarscope.iface.IDocumentFactoryService.getSupportedProviders

(

)

Get supported typed dependency providers

Returns

array of supported typed dependency providers

Implemented in grammarscope.document.Document, grammarscope.io.xml.XMLDocumentFactory, grammarscope.glue.parser.DocumentFactory, grammarscope.glue.AbstractDocumentFactory, grammarscope.ejb.client.parser.DocumentFactory, grammarscope.glue.corenlp.DocumentFactory, grammarscope.server.NullDocumentFactory, grammarscope.ejb.client.parser.DocumentFactory, grammarscope.ejb.client.corenlp.DocumentFactory, grammarscope.ejb.client.corenlp.DocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, and grammarscope.artifacts.AbstractDocumentFactory.

getText()

String grammarscope.iface.IDocumentFactoryService.getText

(

)

throws RuntimeException

Get text

Returns

(original or reconstructed) text

Implemented in grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getTextAnalysis()

ATextAnalysis grammarscope.iface.IDocumentFactoryService.getTextAnalysis	(	TypedDependencyProvider	provider,
		TypedDependencyMode	mode
	)		throws RuntimeException

Get text analysis

Parameters

provider	provider
mode	mode

Returns

text analysis if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getTextReport()

String grammarscope.iface.IDocumentFactoryService.getTextReport	(	TypedDependencyProvider	provider,
		TypedDependencyMode	mode,
		boolean	xmlFlag
	)		throws RuntimeException

Get (text) analysis string

Parameters

provider	provider
mode	mode
xmlFlag	XML format requested

Returns

string

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getTextReports()

String [] grammarscope.iface.IDocumentFactoryService.getTextReports	(	TypedDependencyProvider	provider,
		TypedDependencyMode	mode,
		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, ...

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getTokens()

List<Token> grammarscope.iface.IDocumentFactoryService.getTokens

(

int

sentenceIdx

)

throws RuntimeException

Get tokens

Parameters

sentenceIdx

sentence index

Returns

tokens

Exceptions

RuntimeException

runtime exception

Implemented in grammarscope.document.Document, grammarscope.glue.parser.DocumentFactory, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.glue.corenlp.DocumentFactory, grammarscope.io.xml.XMLDocumentFactory, grammarscope.ejb.client.parser.DocumentFactory, grammarscope.ejb.client.parser.DocumentFactory, grammarscope.ejb.client.corenlp.DocumentFactory, grammarscope.ejb.client.corenlp.DocumentFactory, and grammarscope.server.NullDocumentFactory.

getTriples()

List<Triple> grammarscope.iface.IDocumentFactoryService.getTriples

(

int

sentenceIdx

)

throws RuntimeException

Get triples

Parameters

sentenceIdx

sentence index

Returns

triples if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getTypedDependencies() [1/2]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ATypedDependencies> > grammarscope.iface.IDocumentFactoryService.getTypedDependencies

(

int

sentenceIdx

)

throws RuntimeException

Get typed dependencies artifact

Parameters

sentenceIdx

sentence index

Returns

typed dependency mode-indexed typed dependencies artifacts if successful

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getTypedDependencies() [2/2]

ATypedDependencies grammarscope.iface.IDocumentFactoryService.getTypedDependencies	(	int	sentenceIdx,
		TypedDependencyProvider	provider,
		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

Implemented in grammarscope.document.Document, grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

getWords()

List<WordSegment> grammarscope.iface.IDocumentFactoryService.getWords

(

)

throws RuntimeException

Get words

Returns

list of word segments

Implemented in grammarscope.glue.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.artifacts.AbstractDocumentFactory, grammarscope.glue.corenlp.DocumentFactory, grammarscope.io.xml.XMLDocumentFactory, and grammarscope.server.NullDocumentFactory.

---

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

• grammarscope/glue-iface/src/main/java/grammarscope/iface/IDocumentFactoryService.java