grammarscope.iface

Interface IDocumentFactoryService

All Known Subinterfaces:

IDocument, IDocumentFactory

All Known Implementing Classes:

AbstractDocumentFactory, AbstractDocumentFactory, Document, DocumentFactory, DocumentFactory, DocumentFactory, DocumentFactory, DocumentFactoryAsync, DocumentFactoryAsync, DocumentFactorySync, DocumentFactorySync, NullDocumentFactory, XMLDocumentFactory, XMLDocumentFactoryGrammarScope, XMLDocumentFactoryStanford

public interface IDocumentFactoryService

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

Author:

Bernard Bou [1313ou@gmail.com]

Method Summary

Modifier and Type	Method and Description
AAnalysis	getAnalysis(int sentenceIdx) Get (sentence) analysis artifact
ACoreferences	getCoreferences() Get coreferences artifact
java.util.List<Entailment>	getEntailments(int sentenceIdx) Get entailments
AGrammaticalStructure	getGrammaticalStructure(int sentenceIdx) Get grammatical structure artifact
ANamedEntities	getNamedEntities(int sentenceIdx) Get named entities artifact
AParseTree	getParseTree(int sentenceIdx) Get parse artifact
APartsOfSpeech	getPoses(int sentenceIdx) Get parts-of-speech artifact
ARelationDependents	getRelationDependents(int sentenceIdx) Get relation dependents artifact
java.lang.String	getReport(int sentenceIdx, boolean xmlFlag) Get (sentence) analysis string
java.lang.String[]	getReports(int sentenceIdx, boolean xmlFlag) Get (sentence) analysis strings
ASemanticGraph	getSemanticGraph(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get semantic graph artifact
java.util.Map<TypedDependencyProvider,java.util.Map<TypedDependencyMode,ASemanticGraph>>	getSemanticGraphs(int sentenceIdx) Get semantic graph artifacts
int	getSentenceCount() Get sentence count
java.util.List<SentenceSegment>	getSentences() Get sentences
Sentiment	getSentiment(int sentenceIdx) Get sentiment
TypedDependencyMode[]	getSupportedModes() Get supported typed dependency modes
TypedDependencyProvider[]	getSupportedProviders() Get supported typed dependency providers
java.lang.String	getText() Get text
ATextAnalysis	getTextAnalysis(TypedDependencyProvider provider, TypedDependencyMode mode) Get text analysis
java.lang.String	getTextReport(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xmlFlag) Get (text) analysis string
java.lang.String[]	getTextReports(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xmlFlag) 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

Method Detail

getText

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

Get text

Returns:

(original or reconstructed) text

Throws:

java.lang.RuntimeException

getWords

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

Get words

Returns:

list of word segments

Throws:

java.lang.RuntimeException

getSentences

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

Get sentences

Returns:

list of sentence segments

Throws:

java.lang.RuntimeException

getSentenceCount

int getSentenceCount()
              throws java.lang.RuntimeException

Get sentence count

Returns:

sentence count

Throws:

java.lang.RuntimeException

getTokens

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

Get tokens

Parameters:

sentenceIdx - sentence index

Returns:

tokens

Throws:

java.lang.RuntimeException - runtime exception

getParseTree

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

Get parse artifact

Parameters:

sentenceIdx - sentence index

Returns:

parse tree artifact if successful

Throws:

java.lang.RuntimeException

getPoses

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

Get parts-of-speech artifact

Parameters:

sentenceIdx - sentence index

Returns:

parts-of-speech artifact if successful

Throws:

java.lang.RuntimeException

getGrammaticalStructure

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

Get grammatical structure artifact

Parameters:

sentenceIdx - sentence index

Returns:

grammatical structure artifact if successful

Throws:

java.lang.RuntimeException

getRelationDependents

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

Get relation dependents artifact

Parameters:

sentenceIdx - sentence index

Returns:

relation dependents artifact if successful

Throws:

java.lang.RuntimeException

getTypedDependencies

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

Get typed dependencies artifact

Parameters:

sentenceIdx - sentence index

provider - typed dependency provider

mode - typed dependency mode

Returns:

typed dependencies artifact if successful

Throws:

java.lang.RuntimeException

getTypedDependencies

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

Get typed dependencies artifact

Parameters:

sentenceIdx - sentence index

Returns:

typed dependency mode-indexed typed dependencies artifacts if successful

Throws:

java.lang.RuntimeException

getSemanticGraph

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

Get semantic graph artifact

Parameters:

sentenceIdx - sentence index

provider - typed dependency provider

mode - typed dependency mode

Returns:

semantic graph artifact if successful

Throws:

java.lang.RuntimeException

getSemanticGraphs

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

Get semantic graph artifacts

Parameters:

sentenceIdx - sentence index

Returns:

typed dependency mode-indexed semantic graph artifacts if successful

Throws:

java.lang.RuntimeException

getNamedEntities

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

Get named entities artifact

Parameters:

sentenceIdx - sentence index

Returns:

named entities artifact if successful

Throws:

java.lang.RuntimeException

getSentiment

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

Get sentiment

Parameters:

sentenceIdx - sentence index

Returns:

sentiment if successful

Throws:

java.lang.RuntimeException

getEntailments

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

Get entailments

Parameters:

sentenceIdx - sentence index

Returns:

entailments if successful

Throws:

java.lang.RuntimeException

getTriples

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

Get triples

Parameters:

sentenceIdx - sentence index

Returns:

triples if successful

Throws:

java.lang.RuntimeException

getCoreferences

ACoreferences getCoreferences()
                       throws java.lang.RuntimeException

Get coreferences artifact

Returns:

coreferences artifact if successful

Throws:

java.lang.RuntimeException

getAnalysis

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

Get (sentence) analysis artifact

Parameters:

sentenceIdx - sentence index

Returns:

analysis if successful

Throws:

java.lang.RuntimeException

getTextAnalysis

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

Get text analysis

Parameters:

provider - provider

mode - mode

Returns:

text analysis if successful

Throws:

java.lang.RuntimeException

getReport

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

Get (sentence) analysis string

Parameters:

sentenceIdx - sentence index

xmlFlag - XML format requested

Returns:

string

Throws:

java.lang.RuntimeException

getReports

java.lang.String[] getReports(int sentenceIdx,
                              boolean xmlFlag)
                       throws java.lang.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

Throws:

java.lang.RuntimeException

getTextReport

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

Get (text) analysis string

Parameters:

provider - provider

mode - mode

xmlFlag - XML format requested

Returns:

string

Throws:

java.lang.RuntimeException

getTextReports

java.lang.String[] getTextReports(TypedDependencyProvider provider,
                                  TypedDependencyMode mode,
                                  boolean xmlFlag)
                           throws java.lang.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, ...

Throws:

java.lang.RuntimeException

getSupportedProviders

TypedDependencyProvider[] getSupportedProviders()

Get supported typed dependency providers

Returns:

array of supported typed dependency providers

getSupportedModes

TypedDependencyMode[] getSupportedModes()

Get supported typed dependency modes

Returns:

array of supported typed dependency modes