grammarscope.document

Class Document

java.lang.Object

grammarscope.document.SegmentedDocument

grammarscope.document.Document

All Implemented Interfaces:

IDocument, IDocumentFactoryService

public class Document
extends SegmentedDocument
implements IDocument

Document (to hold processed data)

Author:

Bernard Bou

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.Cache<T> One-object cache
static class	Document.MapCache<K,T> Key-indexed objects cache
static class	Document.MapCache2<K,K2 extends java.lang.Enum<K2>,T> Two-tier key-indexed objects cache
static class	Document.MapCache3<K,K2 extends java.lang.Enum<K2>,K3 extends java.lang.Enum<K3>,T> Two-tier key-indexed objects cache

Field Summary

Fields

Modifier and Type	Field and Description
private Document.Cache<ACoreferences>	coreferences Coreference cache
protected IDocumentFactory	documentFactory Document factory
private Document.MapCache<java.lang.Integer,java.util.List<Entailment>>	entailments Entailments
private Document.MapCache<java.lang.Integer,AGrammaticalStructure>	grammaticalStructures Grammatical structure cache
private Document.MapCache<java.lang.Integer,ANamedEntities>	namedEntities Named Entities cache
private Document.MapCache<java.lang.Integer,AParseTree>	parseTrees Parse tree cache
private Document.MapCache<java.lang.Integer,APartsOfSpeech>	poses Parts-of-speech cache
private Document.MapCache<java.lang.Integer,ARelationDependents>	relationDependents Relation dependents cache
private static boolean	REMOVE_NEW_LINES
java.lang.String	report Status string
private Document.MapCache3<java.lang.Integer,TypedDependencyProvider,TypedDependencyMode,ASemanticGraph>	semanticGraphs Semantic graph cache
private Document.MapCache<java.lang.Integer,Sentiment>	sentiments Sentiment
Status	status Status per sentence
private Document.MapCache<java.lang.Integer,java.util.List<Token>>	tokens
private Document.MapCache<java.lang.Integer,java.util.List<Triple>>	triples Triples
private IView	view

Fields inherited from class grammarscope.document.SegmentedDocument

isSegmented, text, url

Constructor Summary

Constructors

Modifier	Constructor and Description
	Document(IDocumentFactory documentFactory, java.lang.String text) Constructor (do not call DocumentFactory yet, not assumed to be ready to provide service)
	Document(IDocumentFactory documentFactory, java.net.URL url) Constructor (do not call DocumentFactory yet, not assumed to be ready to provide service)
private	Document(IDocumentFactory documentFactory, java.net.URL url, java.lang.String text) Private constructor (do not call DocumentFactory yet, not assumed to be ready to provide service)

Method Summary

Modifier and Type	Method and Description
void	analyze(int sentenceIdx) Analyze sentence
void	clear() Clear cached data
AAnalysis	getAnalysis(int sentenceIdx) Get (sentence) analysis artifact
ACoreferences	getCoreferences() Get coreferences artifact
ATypedDependencies	getDerivedTypedDependencies(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get typed dependencies derived from semantic graph
java.util.List<Entailment>	getEntailments(int sentenceIdx) Get entailments
AGrammaticalStructure	getGrammaticalStructure(int sentenceIdx) Get grammatical structure artifact
Graph<GraphNode,GraphEdge>	getGraph(int sentenceIdx, TypedDependencyProvider provider, TypedDependencyMode mode) Get graph to be displayed (default is semantic graph)
ANamedEntities	getNamedEntities(int sentenceIdx) Get named entities artifact
AParseTree	getParseTree(int sentenceIdx) Get parse artifact
java.lang.String	getPos(int sentenceIdx, Segment wordSegment) Get pos
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
Sentiment	getSentiment(int sentenceIdx) Get sentiment
TypedDependencyMode[]	getSupportedModes() Get supported typed dependency modes
TypedDependencyProvider[]	getSupportedProviders() Get supported typed dependency providers
ATextAnalysis	getTextAnalysis(TypedDependencyProvider provider, TypedDependencyMode mode) Get text analysis
java.lang.String	getTextReport(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xMLModeFlag) Get (text) analysis string
java.lang.String[]	getTextReports(TypedDependencyProvider provider, TypedDependencyMode mode, boolean xMLModeFlag) 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
IView	getView() Get view
private static void	handleException(java.lang.Exception e) Handle exception
boolean	isReady() Is ready
void	make() Make document (this calls DocumentFactory, now assumed to be ready to provide service called after lock on server is acquired)
void	parse(int sentenceIdx) Parse sentence
private static java.lang.String	preprocess(java.lang.String text0) Preprocess
void	processText() Process text level information (like coreference)
static java.lang.String	read(java.net.URL url) Create document from URL
void	recognize(int sentenceIdx) Recognize sentence (parts-of-speech, named entities, sentiment)
void	setView(IView view) Set view

Methods inherited from class grammarscope.document.SegmentedDocument

getCurrentSentenceIdx, getCurrentSentenceSegment, getPath, getSentenceCount, getSentences, getSentenceSegment, getString, getText, getWords, merge, merge, nextSentence, previousSentence, segment, sentenceToString, setSentenceIdx, split, split, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface grammarscope.iface.IDocumentFactoryService

getSentenceCount, getSentences, getText, getWords

Field Detail

REMOVE_NEW_LINES

private static final boolean REMOVE_NEW_LINES

See Also:

Constant Field Values

status

public Status status

Status per sentence

report

public java.lang.String report

Status string

tokens

private final Document.MapCache<java.lang.Integer,java.util.List<Token>> tokens

poses

private final Document.MapCache<java.lang.Integer,APartsOfSpeech> poses

Parts-of-speech cache

parseTrees

private final Document.MapCache<java.lang.Integer,AParseTree> parseTrees

Parse tree cache

grammaticalStructures

private final Document.MapCache<java.lang.Integer,AGrammaticalStructure> grammaticalStructures

Grammatical structure cache

semanticGraphs

private final Document.MapCache3<java.lang.Integer,TypedDependencyProvider,TypedDependencyMode,ASemanticGraph> semanticGraphs

Semantic graph cache

relationDependents

private final Document.MapCache<java.lang.Integer,ARelationDependents> relationDependents

Relation dependents cache

namedEntities

private final Document.MapCache<java.lang.Integer,ANamedEntities> namedEntities

Named Entities cache

sentiments

private final Document.MapCache<java.lang.Integer,Sentiment> sentiments

Sentiment

entailments

private final Document.MapCache<java.lang.Integer,java.util.List<Entailment>> entailments

Entailments

triples

private final Document.MapCache<java.lang.Integer,java.util.List<Triple>> triples

Triples

coreferences

private final Document.Cache<ACoreferences> coreferences

Coreference cache

documentFactory

protected final IDocumentFactory documentFactory

Document factory

view

private IView view

Constructor Detail

Document

public Document(IDocumentFactory documentFactory,
                java.lang.String text)

Constructor (do not call DocumentFactory yet, not assumed to be ready to provide service)

Parameters:

documentFactory - document factory

text - document text

Document

public Document(IDocumentFactory documentFactory,
                java.net.URL url)

Constructor (do not call DocumentFactory yet, not assumed to be ready to provide service)

Parameters:

documentFactory - document factory

url - document url

Document

private Document(IDocumentFactory documentFactory,
                 java.net.URL url,
                 java.lang.String text)

Private constructor (do not call DocumentFactory yet, not assumed to be ready to provide service)

Parameters:

documentFactory - document factory

url - document url

text - document text

Method Detail

make

public void make()
          throws java.io.IOException

Make document (this calls DocumentFactory, now assumed to be ready to provide service called after lock on server is acquired)

Throws:

java.io.IOException - exception

preprocess

private static java.lang.String preprocess(java.lang.String text0)

Preprocess

Parameters:

text0 - raw text

Returns:

preprocessed text

read

public static java.lang.String read(java.net.URL url)
                             throws java.io.IOException

Create document from URL

Parameters:

url - source URL

Returns:

document

Throws:

java.io.IOException - exception

clear

public void clear()

Description copied from interface: IDocument

Clear cached data

Specified by:

clear in interface IDocument

isReady

public boolean isReady()

Description copied from interface: IDocument

Is ready

Specified by:

isReady in interface IDocument

Returns:

true if document is ready

recognize

public void recognize(int sentenceIdx)

Description copied from interface: IDocument

Recognize sentence (parts-of-speech, named entities, sentiment)

Specified by:

recognize in interface IDocument

Parameters:

sentenceIdx - sentence index

parse

public void parse(int sentenceIdx)

Description copied from interface: IDocument

Parse sentence

Specified by:

parse in interface IDocument

Parameters:

sentenceIdx - sentence index

analyze

public void analyze(int sentenceIdx)

Description copied from interface: IDocument

Analyze sentence

Specified by:

analyze in interface IDocument

Parameters:

sentenceIdx - sentence index

processText

public void processText()

Description copied from interface: IDocument

Process text level information (like coreference)

Specified by:

processText in interface IDocument

getView

public IView getView()

Get view

Returns:

view

setView

public void setView(IView view)

Set view

Parameters:

view - document's view

getTokens

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

Description copied from interface: IDocumentFactoryService

Get tokens

Specified by:

getTokens in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

tokens

Throws:

java.lang.RuntimeException - runtime exception

getPoses

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

Description copied from interface: IDocumentFactoryService

Get parts-of-speech artifact

Specified by:

getPoses in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

parts-of-speech artifact if successful

Throws:

java.lang.RuntimeException

getPos

public java.lang.String getPos(int sentenceIdx,
                               Segment wordSegment)

Get pos

Parameters:

sentenceIdx - sentence

wordSegment - word

Returns:

pos

getParseTree

public AParseTree getParseTree(int sentenceIdx)

Description copied from interface: IDocumentFactoryService

Get parse artifact

Specified by:

getParseTree in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

parse tree artifact if successful

getGrammaticalStructure

public AGrammaticalStructure getGrammaticalStructure(int sentenceIdx)

Description copied from interface: IDocumentFactoryService

Get grammatical structure artifact

Specified by:

getGrammaticalStructure in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

grammatical structure artifact if successful

getRelationDependents

public ARelationDependents getRelationDependents(int sentenceIdx)

Description copied from interface: IDocumentFactoryService

Get relation dependents artifact

Specified by:

getRelationDependents in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

relation dependents artifact if successful

getTypedDependencies

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

Description copied from interface: IDocumentFactoryService

Get typed dependencies artifact

Specified by:

getTypedDependencies in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

typed dependency mode-indexed typed dependencies artifacts if successful

Throws:

java.lang.RuntimeException

getTypedDependencies

public ATypedDependencies getTypedDependencies(int sentenceIdx,
                                               TypedDependencyProvider provider,
                                               TypedDependencyMode mode)

Description copied from interface: IDocumentFactoryService

Get typed dependencies artifact

Specified by:

getTypedDependencies in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

provider - typed dependency provider

mode - typed dependency mode

Returns:

typed dependencies artifact if successful

getSemanticGraph

public ASemanticGraph getSemanticGraph(int sentenceIdx,
                                       TypedDependencyProvider provider,
                                       TypedDependencyMode mode)

Description copied from interface: IDocumentFactoryService

Get semantic graph artifact

Specified by:

getSemanticGraph in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

provider - typed dependency provider

mode - typed dependency mode

Returns:

semantic graph artifact if successful

getSemanticGraphs

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

Description copied from interface: IDocumentFactoryService

Get semantic graph artifacts

Specified by:

getSemanticGraphs in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

typed dependency mode-indexed semantic graph artifacts if successful

Throws:

java.lang.RuntimeException

getNamedEntities

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

Description copied from interface: IDocumentFactoryService

Get named entities artifact

Specified by:

getNamedEntities in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

named entities artifact if successful

Throws:

java.lang.RuntimeException

getSentiment

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

Description copied from interface: IDocumentFactoryService

Get sentiment

Specified by:

getSentiment in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

sentiment if successful

Throws:

java.lang.RuntimeException

getEntailments

public java.util.List<Entailment> getEntailments(int sentenceIdx)

Description copied from interface: IDocumentFactoryService

Get entailments

Specified by:

getEntailments in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

entailments if successful

getTriples

public java.util.List<Triple> getTriples(int sentenceIdx)

Description copied from interface: IDocumentFactoryService

Get triples

Specified by:

getTriples in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

triples if successful

getCoreferences

public ACoreferences getCoreferences()
                              throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get coreferences artifact

Specified by:

getCoreferences in interface IDocumentFactoryService

Returns:

coreferences artifact if successful

Throws:

java.lang.RuntimeException

getAnalysis

public AAnalysis getAnalysis(int sentenceIdx)

Description copied from interface: IDocumentFactoryService

Get (sentence) analysis artifact

Specified by:

getAnalysis in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

Returns:

analysis if successful

getTextAnalysis

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

Description copied from interface: IDocumentFactoryService

Get text analysis

Specified by:

getTextAnalysis in interface IDocumentFactoryService

Parameters:

provider - provider

mode - mode

Returns:

text analysis if successful

Throws:

java.lang.RuntimeException

getTextReport

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

Description copied from interface: IDocumentFactoryService

Get (text) analysis string

Specified by:

getTextReport in interface IDocumentFactoryService

Parameters:

provider - provider

mode - mode

xMLModeFlag - XML format requested

Returns:

string

Throws:

java.lang.RuntimeException

getTextReports

public java.lang.String[] getTextReports(TypedDependencyProvider provider,
                                         TypedDependencyMode mode,
                                         boolean xMLModeFlag)
                                  throws java.lang.RuntimeException

Description copied from interface: IDocumentFactoryService

Get (text) analysis strings

Specified by:

getTextReports in interface IDocumentFactoryService

Parameters:

provider - provider

mode - mode

xMLModeFlag - XML format requested

Returns:

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

Throws:

java.lang.RuntimeException

getReport

public java.lang.String getReport(int sentenceIdx,
                                  boolean xMLFlag)

Description copied from interface: IDocumentFactoryService

Get (sentence) analysis string

Specified by:

getReport in interface IDocumentFactoryService

Parameters:

sentenceIdx - sentence index

xMLFlag - XML format requested

Returns:

string

getReports

public java.lang.String[] getReports(int sentenceIdx,
                                     boolean xMLFlag)

Description copied from interface: IDocumentFactoryService

Get (sentence) analysis strings

Specified by:

getReports in interface IDocumentFactoryService

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

getGraph

public Graph<GraphNode,GraphEdge> getGraph(int sentenceIdx,
                                           TypedDependencyProvider provider,
                                           TypedDependencyMode mode)

Get graph to be displayed (default is semantic graph)

Parameters:

sentenceIdx - sentence index

provider - typed dependencies provider

mode - typed dependency mode

Returns:

graph

getDerivedTypedDependencies

public ATypedDependencies getDerivedTypedDependencies(int sentenceIdx,
                                                      TypedDependencyProvider provider,
                                                      TypedDependencyMode mode)

Get typed dependencies derived from semantic graph

Parameters:

sentenceIdx - sentence index

provider - typed dependencies provider

mode - typed dependencies mode

Returns:

typed dependencies mode

handleException

private static void handleException(java.lang.Exception e)

Handle exception

Parameters:

e - exception

getSupportedProviders

public TypedDependencyProvider[] getSupportedProviders()

Description copied from interface: IDocumentFactoryService

Get supported typed dependency providers

Specified by:

getSupportedProviders in interface IDocumentFactoryService

Returns:

array of supported typed dependency providers

getSupportedModes

public TypedDependencyMode[] getSupportedModes()

Description copied from interface: IDocumentFactoryService

Get supported typed dependency modes

Specified by:

getSupportedModes in interface IDocumentFactoryService

Returns:

array of supported typed dependency modes