Inheritance diagram for grammarscope.document.Document:

[legend]

Collaboration diagram for grammarscope.document.Document:

[legend]

Classes
class	Cache

class	MapCache

class	MapCache2

class	MapCache3

Public Member Functions
	Document (final IDocumentFactory documentFactory, final String text)

	Document (final IDocumentFactory documentFactory, final URL url)

void	make () throws IOException

void	clear ()

boolean	isReady ()

void	recognize (final int sentenceIdx)

void	parse (final int sentenceIdx)

void	analyze (final int sentenceIdx)

void	processText ()

IView	getView ()

void	setView (final IView view)

List< Token >	getTokens (final int sentenceIdx) throws RuntimeException

APartsOfSpeech	getPoses (final int sentenceIdx) throws RuntimeException

String	getPos (final int sentenceIdx, final Segment wordSegment)

AParseTree	getParseTree (final int sentenceIdx)

AGrammaticalStructure	getGrammaticalStructure (final int sentenceIdx)

ARelationDependents	getRelationDependents (final int sentenceIdx)

Map< TypedDependencyProvider, Map< TypedDependencyMode, ATypedDependencies > >	getTypedDependencies (final int sentenceIdx) throws RuntimeException

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

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

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)

List< Triple >	getTriples (final int sentenceIdx)

ACoreferences	getCoreferences () throws RuntimeException

AAnalysis	getAnalysis (final int sentenceIdx)

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

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

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

String	getReport (final int sentenceIdx, final boolean xMLFlag)

String[]	getReports (final int sentenceIdx, final boolean xMLFlag)

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

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

TypedDependencyProvider[]	getSupportedProviders ()

TypedDependencyMode[]	getSupportedModes ()

Public Member Functions inherited from grammarscope.document.SegmentedDocument
void	segment ()

String	getText ()

int	getSentenceCount ()

List< WordSegment >	getWords ()

List< SentenceSegment >	getSentences ()

List< Segment >	split (final Segment leftSegment, final Segment rightSegment)

List< Segment >	split (final Segment segment)

String	getPath ()

String	getString (final Segment segment)

SentenceSegment	getSentenceSegment (final int sentenceIndex)

int	nextSentence ()

int	previousSentence ()

void	setSentenceIdx (final int sentenceIdx)

int	getCurrentSentenceIdx ()

SentenceSegment	getCurrentSentenceSegment ()

String	toString ()

Public Member Functions inherited from grammarscope.iface.IDocumentFactoryService
String	getText () throws RuntimeException

List< WordSegment >	getWords () throws RuntimeException

List< SentenceSegment >	getSentences () throws RuntimeException

int	getSentenceCount () throws RuntimeException

Static Public Member Functions
static String	read (final URL url) throws IOException

Static Public Member Functions inherited from grammarscope.document.SegmentedDocument
static Segment	merge (final List< Segment > segments)

static Segment	merge (final Segment... segments)

static String	sentenceToString (final List< Segment > sentence, final int lineLen)

Public Attributes
Status	status

String	report

Protected Attributes
final IDocumentFactory	documentFactory

Protected Attributes inherited from grammarscope.document.SegmentedDocument
final URL	url

String	text

boolean	isSegmented

Private Member Functions
	Document (final IDocumentFactory documentFactory, final URL url, final String text)

Static Private Member Functions
static String	preprocess (final String text0)

static void	handleException (final Exception e)

Private Attributes
final MapCache< Integer, List< Token > >	tokens

final MapCache< Integer, APartsOfSpeech >	poses

final MapCache< Integer, AParseTree >	parseTrees

final MapCache< Integer, AGrammaticalStructure >	grammaticalStructures

final MapCache3< Integer, TypedDependencyProvider, TypedDependencyMode, ASemanticGraph >	semanticGraphs

final MapCache< Integer, ARelationDependents >	relationDependents

final MapCache< Integer, ANamedEntities >	namedEntities

final MapCache< Integer, Sentiment >	sentiments

final MapCache< Integer, List< Entailment > >	entailments

final MapCache< Integer, List< Triple > >	triples

final Cache< ACoreferences >	coreferences

IView	view

Static Private Attributes
static final boolean	REMOVE_NEW_LINES = true

Additional Inherited Members
Protected Member Functions inherited from grammarscope.document.SegmentedDocument
	SegmentedDocument (final IDocumentFactory documentFactory, final URL url, final String text)

Detailed Description

Document (to hold processed data)

Author: Bernard Bou

Constructor & Destructor Documentation

◆ Document() [1/3]

grammarscope.document.Document.Document	(	final IDocumentFactory	documentFactory,
		final String	text
	)

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

Parameters

documentFactory	document factory
text	document text

◆ Document() [2/3]

grammarscope.document.Document.Document	(	final IDocumentFactory	documentFactory,
		final URL	url
	)

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

Parameters

documentFactory	document factory
url	document url

◆ Document() [3/3]

grammarscope.document.Document.Document	(	final IDocumentFactory	documentFactory,
		final URL	url,
		final String	text
	)

private

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

Member Function Documentation

◆ analyze()

void grammarscope.document.Document.analyze ( final int sentenceIdx )

Analyze sentence

Parameters

sentenceIdx sentence index

Implements grammarscope.document.IDocument.

◆ clear()

void grammarscope.document.Document.clear ( )

Clear cached data

Implements grammarscope.document.IDocument.

◆ getAnalysis()

AAnalysis grammarscope.document.Document.getAnalysis ( final int sentenceIdx )

Get (sentence) analysis artifact

Parameters

sentenceIdx sentence index

Returns: analysis if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getCoreferences()

ACoreferences grammarscope.document.Document.getCoreferences ( ) throws RuntimeException

Get coreferences artifact

Returns: coreferences artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getDerivedTypedDependencies()

ATypedDependencies grammarscope.document.Document.getDerivedTypedDependencies	(	final int	sentenceIdx,
		final TypedDependencyProvider	provider,
		final 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

◆ getEntailments()

List<Entailment> grammarscope.document.Document.getEntailments ( final int sentenceIdx )

Get entailments

Parameters

sentenceIdx sentence index

Returns: entailments if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getGrammaticalStructure()

AGrammaticalStructure grammarscope.document.Document.getGrammaticalStructure ( final int sentenceIdx )

Get grammatical structure artifact

Parameters

sentenceIdx sentence index

Returns: grammatical structure artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getGraph()

Graph<GraphNode, GraphEdge> grammarscope.document.Document.getGraph	(	final int	sentenceIdx,
		final TypedDependencyProvider	provider,
		final 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

◆ getNamedEntities()

ANamedEntities grammarscope.document.Document.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.document.Document.getParseTree ( final int sentenceIdx )

Get parse artifact

Parameters

sentenceIdx sentence index

Returns: parse tree artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getPos()

String grammarscope.document.Document.getPos	(	final int	sentenceIdx,
		final Segment	wordSegment
	)

Get pos

Parameters

sentenceIdx	sentence
wordSegment	word

Returns: pos

◆ getPoses()

APartsOfSpeech grammarscope.document.Document.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.document.Document.getRelationDependents ( final int sentenceIdx )

Get relation dependents artifact

Parameters

sentenceIdx sentence index

Returns: relation dependents artifact if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReport()

String grammarscope.document.Document.getReport	(	final int	sentenceIdx,
		final boolean	xmlFlag
	)

Get (sentence) analysis string

Parameters

sentenceIdx	sentence index
xmlFlag	XML format requested

Returns: string

Implements grammarscope.iface.IDocumentFactoryService.

◆ getReports()

String [] grammarscope.document.Document.getReports	(	final int	sentenceIdx,
		final boolean	xmlFlag
	)

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.document.Document.getSemanticGraph	(	final int	sentenceIdx,
		final TypedDependencyProvider	provider,
		final TypedDependencyMode	mode
	)

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.document.Document.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.

◆ getSentiment()

Sentiment grammarscope.document.Document.getSentiment ( final int sentenceIdx ) throws RuntimeException

Get sentiment

Parameters

sentenceIdx sentence index

Returns: sentiment if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSupportedModes()

TypedDependencyMode [] grammarscope.document.Document.getSupportedModes ( )

Get supported typed dependency modes

Returns: array of supported typed dependency modes

Implements grammarscope.iface.IDocumentFactoryService.

◆ getSupportedProviders()

TypedDependencyProvider [] grammarscope.document.Document.getSupportedProviders ( )

Get supported typed dependency providers

Returns: array of supported typed dependency providers

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTextAnalysis()

ATextAnalysis grammarscope.document.Document.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.document.Document.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.document.Document.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.document.Document.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.document.Document.getTriples ( final int sentenceIdx )

Get triples

Parameters

sentenceIdx sentence index

Returns: triples if successful

Implements grammarscope.iface.IDocumentFactoryService.

◆ getTypedDependencies() [1/2]

Map<TypedDependencyProvider, Map<TypedDependencyMode, ATypedDependencies> > grammarscope.document.Document.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.document.Document.getTypedDependencies	(	final int	sentenceIdx,
		final TypedDependencyProvider	provider,
		final TypedDependencyMode	mode
	)

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.

◆ getView()

IView grammarscope.document.Document.getView ( )

Get view

Returns: view

◆ handleException()

static void grammarscope.document.Document.handleException ( final Exception e )

staticprivate

Handle exception

Parameters

e exception

◆ isReady()

boolean grammarscope.document.Document.isReady ( )

Is ready

Returns: true if document is ready

Implements grammarscope.document.IDocument.

◆ make()

void grammarscope.document.Document.make ( ) throws IOException

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

Exceptions

IOException exception

◆ parse()

void grammarscope.document.Document.parse ( final int sentenceIdx )

Parse sentence

Parameters

sentenceIdx sentence index

Implements grammarscope.document.IDocument.

◆ preprocess()

static String grammarscope.document.Document.preprocess ( final String text0 )

staticprivate

Preprocess

Parameters

text0 raw text

Returns: preprocessed text

◆ processText()

void grammarscope.document.Document.processText ( )

Process text level information (like coreference)

Implements grammarscope.document.IDocument.

◆ read()

static String grammarscope.document.Document.read ( final URL url ) throws IOException

static

Create document from URL

Parameters

url	source URL

Returns: document

Exceptions

IOException exception

◆ recognize()

void grammarscope.document.Document.recognize ( final int sentenceIdx )

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

Parameters

sentenceIdx sentence index

Implements grammarscope.document.IDocument.

◆ setView()

void grammarscope.document.Document.setView ( final IView view )

Set view

Parameters

view	document's view

Member Data Documentation

◆ coreferences

final Cache<ACoreferences> grammarscope.document.Document.coreferences

private

Coreference cache

◆ documentFactory

final IDocumentFactory grammarscope.document.Document.documentFactory

protected

Document factory

◆ entailments

final MapCache<Integer, List<Entailment> > grammarscope.document.Document.entailments

private

Entailments

◆ grammaticalStructures

final MapCache<Integer, AGrammaticalStructure> grammarscope.document.Document.grammaticalStructures

private

Grammatical structure cache

◆ namedEntities

final MapCache<Integer, ANamedEntities> grammarscope.document.Document.namedEntities

private

Named Entities cache

◆ parseTrees

final MapCache<Integer, AParseTree> grammarscope.document.Document.parseTrees

private

Parse tree cache

◆ poses

final MapCache<Integer, APartsOfSpeech> grammarscope.document.Document.poses

private

Parts-of-speech cache

◆ relationDependents

final MapCache<Integer, ARelationDependents> grammarscope.document.Document.relationDependents

private

Relation dependents cache

◆ REMOVE_NEW_LINES

final boolean grammarscope.document.Document.REMOVE_NEW_LINES = true

staticprivate

◆ report

String grammarscope.document.Document.report

Status string

◆ semanticGraphs

final MapCache3<Integer, TypedDependencyProvider, TypedDependencyMode, ASemanticGraph> grammarscope.document.Document.semanticGraphs

private

Semantic graph cache

◆ sentiments

final MapCache<Integer, Sentiment> grammarscope.document.Document.sentiments

private

Sentiment

◆ status

Status grammarscope.document.Document.status

Status per sentence

◆ tokens

final MapCache<Integer, List<Token> > grammarscope.document.Document.tokens

private

◆ triples

final MapCache<Integer, List<Triple> > grammarscope.document.Document.triples

private

Triples

◆ view

IView grammarscope.document.Document.view

private

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

grammarscope/library/src/main/java/grammarscope/document/Document.java

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Document() [1/3]

◆ Document() [2/3]

◆ Document() [3/3]

Member Function Documentation

◆ analyze()

◆ clear()

◆ getAnalysis()

◆ getCoreferences()

◆ getDerivedTypedDependencies()

◆ getEntailments()

◆ getGrammaticalStructure()

◆ getGraph()

◆ getNamedEntities()

◆ getParseTree()

◆ getPos()

◆ getPoses()

◆ getRelationDependents()

◆ getReport()

◆ getReports()

◆ getSemanticGraph()

◆ getSemanticGraphs()

◆ getSentiment()

◆ getSupportedModes()

◆ getSupportedProviders()

◆ getTextAnalysis()

◆ getTextReport()

◆ getTextReports()

◆ getTokens()

◆ getTriples()

◆ getTypedDependencies() [1/2]

◆ getTypedDependencies() [2/2]

◆ getView()

◆ handleException()

◆ isReady()

◆ make()

◆ parse()

◆ preprocess()

◆ processText()

◆ read()

◆ recognize()

◆ setView()

Member Data Documentation

◆ coreferences

◆ documentFactory

◆ entailments

◆ grammaticalStructures

◆ namedEntities

◆ parseTrees

◆ poses

◆ relationDependents

◆ REMOVE_NEW_LINES

◆ report

◆ semanticGraphs

◆ sentiments

◆ status

◆ tokens

◆ triples

◆ view