grammarscope.glue.corenlp

Class DocumentFactory

java.lang.Object

grammarscope.glue.AbstractDocumentFactory

grammarscope.glue.corenlp.DocumentFactory

All Implemented Interfaces:

IDocumentFactory, IDocumentFactoryService

public class DocumentFactory
extends AbstractDocumentFactory

Document factory implementation as Stanford CoreNLP client

Author:

Bernard Bou

Nested Class Summary

Nested classes/interfaces inherited from class grammarscope.glue.AbstractDocumentFactory

AbstractDocumentFactory.Cache<T>

Field Summary

Fields

Modifier and Type	Field and Description
private IPipelineAnnotation	annotation Annotation (of text)
private static Pipeline	pipeline Stanford pipeline

Fields inherited from class grammarscope.glue.AbstractDocumentFactory

grammaticalStructures, language, parseTrees, relationDependentsDirectFactory, text, tokens, typedDependencies, typedDependencies2, xMLPrinter

Constructor Summary

Constructors

Constructor and Description
DocumentFactory(Language language) Constructor

Method Summary

Modifier and Type	Method and Description
Segmentation	getSegmentation() Get segmentation
java.util.List<SentenceSegment>	getSentences() Get sentences
protected Coreferences	getStanfordCoreferences() Get coreferences
protected java.util.List<Entailment>	getStanfordEntailments(int sentenceIdx) Get entailments
protected edu.stanford.nlp.trees.GrammaticalStructure	getStanfordGrammaticalStructure(int sentenceIdx) Get grammatical structure
protected java.util.List<NamedEntity>	getStanfordNamedEntities(int sentenceIdx) Get named entities
protected edu.stanford.nlp.trees.Tree	getStanfordParseTree(int sentenceIdx) Get parse tree
protected edu.stanford.nlp.semgraph.SemanticGraph	getStanfordSemanticGraph(int sentenceIdx, TypedDependencyMode mode) Get semantic graph
protected edu.stanford.nlp.semgraph.SemanticGraph	getStanfordSemanticGraph2(int sentenceIdx, TypedDependencyMode mode) Get semantic graph (workflow 2)
protected Sentiment	getStanfordSentiment(int sentenceIdx) Get sentiment
protected java.util.List<Triple>	getStanfordTriples(int sentenceIdx) Get triples
protected java.util.Collection<edu.stanford.nlp.trees.TypedDependency>	getStanfordTypedDependencies(int sentenceIdx, TypedDependencyMode mode) Get typed dependencies
protected java.util.Collection<edu.stanford.nlp.trees.TypedDependency>	getStanfordTypedDependencies2(int sentenceIdx, TypedDependencyMode mode) Get typed dependencies (workflow 2)
TypedDependencyMode[]	getSupportedModes() Get supported typed dependency modes
TypedDependencyProvider[]	getSupportedProviders() Get supported typed dependency providers
java.util.List<Token>	getTokens(int sentenceIdx) Get tokens
java.util.List<WordSegment>	getWords() Get words
boolean	init(java.lang.String text) Init processing
static void	set(Pipeline pipeline) Set pipeline to use

Methods inherited from class grammarscope.glue.AbstractDocumentFactory

getAnalysis, getCoreferences, getEntailments, getGrammaticalStructure, getNamedEntities, getParseTree, getPoses, getRelationDependents, getReport, getReports, getSemanticGraph, getSemanticGraphs, getSentenceCount, getSentiment, getText, getTextAnalysis, getTextReport, getTextReports, getTriples, getTypedDependencies, getTypedDependencies

Methods inherited from class java.lang.Object

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

Field Detail

pipeline

private static Pipeline pipeline

Stanford pipeline

annotation

private IPipelineAnnotation annotation

Annotation (of text)

Constructor Detail

DocumentFactory

public DocumentFactory(Language language)

Constructor

Parameters:

language - language

Method Detail

set

public static void set(Pipeline pipeline)

Set pipeline to use

Parameters:

pipeline - pipeline

init

public boolean init(java.lang.String text)

Description copied from interface: IDocumentFactory

Init processing

Specified by:

init in interface IDocumentFactory

Overrides:

init in class AbstractDocumentFactory

Parameters:

text - input text

Returns:

true if successful

getWords

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

Description copied from interface: IDocumentFactoryService

Get words

Specified by:

getWords in interface IDocumentFactoryService

Overrides:

getWords in class AbstractDocumentFactory

Returns:

list of word segments

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

Overrides:

getSentences in class AbstractDocumentFactory

Returns:

list of sentence segments

Throws:

java.lang.RuntimeException

getSegmentation

public Segmentation getSegmentation()
                             throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get segmentation

Specified by:

getSegmentation in class AbstractDocumentFactory

Returns:

segmentation

Throws:

java.lang.RuntimeException - exception

getTokens

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

Description copied from class: AbstractDocumentFactory

Get tokens

Specified by:

getTokens in interface IDocumentFactoryService

Specified by:

getTokens in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence index

Returns:

tokens

Throws:

java.lang.RuntimeException - exception

getStanfordParseTree

protected edu.stanford.nlp.trees.Tree getStanfordParseTree(int sentenceIdx)
                                                    throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get parse tree

Specified by:

getStanfordParseTree in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence index

Returns:

parse tree if successful

Throws:

java.lang.RuntimeException - exception

getStanfordGrammaticalStructure

protected edu.stanford.nlp.trees.GrammaticalStructure getStanfordGrammaticalStructure(int sentenceIdx)
                                                                               throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get grammatical structure

Specified by:

getStanfordGrammaticalStructure in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence

Returns:

grammatical structure if successful

Throws:

java.lang.RuntimeException

getStanfordTypedDependencies

protected java.util.Collection<edu.stanford.nlp.trees.TypedDependency> getStanfordTypedDependencies(int sentenceIdx,
                                                                                                    TypedDependencyMode mode)
                                                                                             throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get typed dependencies

Specified by:

getStanfordTypedDependencies in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence

mode - typed dependency mode

Returns:

typed dependencies if successful

Throws:

java.lang.RuntimeException - exception

getStanfordTypedDependencies2

protected java.util.Collection<edu.stanford.nlp.trees.TypedDependency> getStanfordTypedDependencies2(int sentenceIdx,
                                                                                                     TypedDependencyMode mode)
                                                                                              throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get typed dependencies (workflow 2)

Specified by:

getStanfordTypedDependencies2 in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence

mode - typed dependency mode

Returns:

typed dependencies if successful

Throws:

java.lang.RuntimeException - exception

getSupportedProviders

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

Description copied from class: AbstractDocumentFactory

Get supported typed dependency providers

Specified by:

getSupportedProviders in interface IDocumentFactoryService

Specified by:

getSupportedProviders in class AbstractDocumentFactory

Returns:

array of supported typed dependency providers

Throws:

java.lang.RuntimeException - exception

getSupportedModes

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

Description copied from class: AbstractDocumentFactory

Get supported typed dependency modes

Specified by:

getSupportedModes in interface IDocumentFactoryService

Specified by:

getSupportedModes in class AbstractDocumentFactory

Returns:

array of supported typed dependency modes

Throws:

java.lang.RuntimeException - exception

getStanfordSemanticGraph

protected edu.stanford.nlp.semgraph.SemanticGraph getStanfordSemanticGraph(int sentenceIdx,
                                                                           TypedDependencyMode mode)
                                                                    throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get semantic graph

Specified by:

getStanfordSemanticGraph in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence

mode - typed dependency mode

Returns:

semantic graph if successful

Throws:

java.lang.RuntimeException

getStanfordSemanticGraph2

protected edu.stanford.nlp.semgraph.SemanticGraph getStanfordSemanticGraph2(int sentenceIdx,
                                                                            TypedDependencyMode mode)
                                                                     throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get semantic graph (workflow 2)

Specified by:

getStanfordSemanticGraph2 in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence

mode - typed dependency mode

Returns:

semantic graph if successful

Throws:

java.lang.RuntimeException

getStanfordNamedEntities

protected java.util.List<NamedEntity> getStanfordNamedEntities(int sentenceIdx)
                                                        throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get named entities

Specified by:

getStanfordNamedEntities in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence index

Returns:

list of named entities

Throws:

java.lang.RuntimeException - exception

getStanfordSentiment

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

Description copied from class: AbstractDocumentFactory

Get sentiment

Specified by:

getStanfordSentiment in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence index

Returns:

sentiment

Throws:

java.lang.RuntimeException

getStanfordEntailments

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

Description copied from class: AbstractDocumentFactory

Get entailments

Specified by:

getStanfordEntailments in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence index

Returns:

entailments

Throws:

java.lang.RuntimeException

getStanfordTriples

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

Description copied from class: AbstractDocumentFactory

Get triples

Specified by:

getStanfordTriples in class AbstractDocumentFactory

Parameters:

sentenceIdx - sentence index

Returns:

triples

Throws:

java.lang.RuntimeException

getStanfordCoreferences

protected Coreferences getStanfordCoreferences()
                                        throws java.lang.RuntimeException

Description copied from class: AbstractDocumentFactory

Get coreferences

Specified by:

getStanfordCoreferences in class AbstractDocumentFactory

Returns:

coreference data if successful

Throws:

java.lang.RuntimeException