Collaboration diagram for grammarscope.server.corenlp.Pipeline:

Classes
interface	IProcessor

Public Member Functions
	Pipeline ()

	Pipeline (final Properties properties0)

boolean	isValid ()

Properties	getPipelineProperties ()

void	reset ()

String	toString (final Annotation document) throws IOException

String	toXMLString (final Annotation document) throws IOException

String	toString (final Annotation document, final boolean xMLFlag) throws IOException

void	print (final Annotation document, final PrintWriter out, final boolean xMLFlag) throws IOException

Annotation	processFile (final String file)

Annotation	processURL (final URL url)

Annotation	process (final String text)

String	getTokenizeModel ()

String	getPosTaggerModel ()

String	getConstituencyParseModel ()

String	getDependencyParseModel ()

String	getGrammaticalRelationModel ()

Static Public Member Functions
static Properties	makePipelineProperties (final Properties properties0)

static Properties	makeDefaultProperties ()

static String	makeText (final List< String > tokens, final List< WordSegment > wordSegments)

static TextBreadthAnalysis	getTextBreadthAnalysis (final Annotation document)

static TextDepthAnalysis	getTextDepthAnalysis (final Annotation document)

static List< BreadthAnalysis >	getBreadthAnalyses (final Annotation document)

static List< DepthAnalysis >	getDepthAnalyses (final Annotation document)

static List< Tree >	getParseTrees (final Annotation document)

static List< Collection< TypedDependency > >	getTypedDependencies (final Annotation document, final TypedDependencyMode mode)

static List< SemanticGraph >	getSemanticGraphs (final Annotation document, final TypedDependencyMode mode)

static List< List< String > >	getWords (final Annotation document)

static List< List< String > >	getPoses (final Annotation document)

static List< List< String > >	getNamedEntities (final Annotation document)

static List< List< Integer > >	getCoreferenceIndices (final Annotation document)

static List< List< Integer > >	getCharBegins (final Annotation document)

static List< List< Integer > >	getCharEnds (final Annotation document)

static Map< Integer, CorefChain >	getCoreferences (final Annotation document)

static long	getCapabilities ()

static void	main (final String[] args) throws IOException

Protected Attributes
StanfordCoreNLP	stanfordPipeline

final Properties	properties

Static Package Functions
static void	makeText (final String substring, final Segment segment, final int from0, final StringBuffer sb)

static void	makeText (final String substring, final Segment segment, final StringBuffer sb)

Static Package Attributes
static final String	PIPELINE_ANNOTATORS = "annotators"

static final String	PIPELINE_TOKENIZE_LANGUAGE = "tokenize.language"

static final String	PIPELINE_POSTAGGER_MODEL = "pos.model"

static final String	PIPELINE_PARSER_MODEL = "parse.model"

static final String	PIPELINE_PARSER_OPTIONS = "parse.flags"

static final String	PIPELINE_DEPPARSER_MODEL = "depparse.model"

static final String	PIPELINE_DEPPARSER_OPTIONS = "depparse.options"

static final String	PIPELINE_LANGUAGE = "language"

Static Private Member Functions
static< T > List< T >	processMaps (final CoreMap map, final Class<? extends CoreAnnotation< List< CoreMap >>> elementAnnotationClass, final IProcessor< T > processor)

static< T > List< T >	processLabels (final CoreMap map, final Class<? extends CoreAnnotation< List< CoreLabel >>> elementAnnotationClass, final IProcessor< T > processor)

static< T > List< List< T > >	processSub (final CoreMap map, @SuppressWarnings("SameParameterValue") final Class<? extends CoreAnnotation< List< CoreMap >>> elementAnnotationClass, @SuppressWarnings("SameParameterValue") final Class<? extends CoreAnnotation< List< CoreLabel >>> subElementAnnotationClass, final IProcessor< T > processor)

static< T > List< T >	getAnnotations (final CoreMap map, @SuppressWarnings("SameParameterValue") final Class<? extends CoreAnnotation< List< CoreLabel >>> class1, final Class<? extends CoreAnnotation< T >> class2)

static< T > List< List< T > >	getTokenAnnotations (final CoreMap map, final Class<? extends CoreAnnotation< T >> clazz)

static Class<? extends TypedDependenciesAnnotation >	typedDependencyModeToAnnotationClass (final TypedDependencyMode mode)

static Class<? extends TypedDependenciesAnnotation >	typedDependencyModeToAnnotation2Class (final TypedDependencyMode mode)

static Class<? extends SemanticGraphAnnotation >	semanticGraphModeToAnnotationClass (final TypedDependencyMode mode)

static Class<? extends SemanticGraphAnnotation >	semanticGraphModeToAnnotation2Class (final TypedDependencyMode mode)

static List< WordSegment >	makeWordSegments (final List< Integer > begins, final List< Integer > ends)

static List< NamedEntity >	makeNamedEntities (final CoreMap map)

Detailed Description

Pipeline

Author: Bernard Bou

Constructor & Destructor Documentation

◆ Pipeline() [1/2]

grammarscope.server.corenlp.Pipeline.Pipeline ( )

Default constructor

◆ Pipeline() [2/2]

grammarscope.server.corenlp.Pipeline.Pipeline ( final Properties properties0 )

Constructor

Parameters

properties0 pipeline properties

Member Function Documentation

◆ getAnnotations()

static <T> List<T> grammarscope.server.corenlp.Pipeline.getAnnotations	(	final CoreMap	map,
		@SuppressWarnings("SameParameterValue") final Class<? extends CoreAnnotation< List< CoreLabel >>>	class1,
		final Class<? extends CoreAnnotation< T >>	class2
	)

staticprivate

Get annotations

Parameters

map	annotation map
class1	selector class at first level
class2	selector class at second level
<T>	type of returned list element

Returns: list of annotation values

◆ getBreadthAnalyses()

static List<BreadthAnalysis> grammarscope.server.corenlp.Pipeline.getBreadthAnalyses ( final Annotation document )

static

Analysis

Parameters

document document

Returns: list of breadth analyses

◆ getCapabilities()

static long grammarscope.server.corenlp.Pipeline.getCapabilities ( )

static

Capabilities

Returns: capabilities

◆ getCharBegins()

static List<List<Integer> > grammarscope.server.corenlp.Pipeline.getCharBegins ( final Annotation document )

static

Get character offset begins

Parameters

document document

Returns: list of list of character offset begins

◆ getCharEnds()

static List<List<Integer> > grammarscope.server.corenlp.Pipeline.getCharEnds ( final Annotation document )

static

Get character offset ends

Parameters

document document

Returns: list of list of character offset begins

◆ getConstituencyParseModel()

String grammarscope.server.corenlp.Pipeline.getConstituencyParseModel ( )

◆ getCoreferenceIndices()

static List<List<Integer> > grammarscope.server.corenlp.Pipeline.getCoreferenceIndices ( final Annotation document )

static

Get coreference cluster indices

Parameters

document document

Returns: list of list of coreference cluster indices

◆ getCoreferences()

static Map<Integer, CorefChain> grammarscope.server.corenlp.Pipeline.getCoreferences ( final Annotation document )

static

Get coreferences. This is the coreference link graph. Each chain stores a set of mentions that link to each other, along with a method for getting the most representative mention. Both sentence and token offsets start at 1!

Parameters

document document

Returns: indexed coreference chains

◆ getDependencyParseModel()

String grammarscope.server.corenlp.Pipeline.getDependencyParseModel ( )

◆ getDepthAnalyses()

static List<DepthAnalysis> grammarscope.server.corenlp.Pipeline.getDepthAnalyses ( final Annotation document )

static

Analysis

Parameters

document document

Returns: list of depth analyses

◆ getGrammaticalRelationModel()

String grammarscope.server.corenlp.Pipeline.getGrammaticalRelationModel ( )

◆ getNamedEntities()

static List<List<String> > grammarscope.server.corenlp.Pipeline.getNamedEntities ( final Annotation document )

static

Get named entities

Parameters

document document

Returns: list of list of named entities

◆ getParseTrees()

static List<Tree> grammarscope.server.corenlp.Pipeline.getParseTrees ( final Annotation document )

static

Parse

Parameters

document document

Returns: list of parse trees

◆ getPipelineProperties()

Properties grammarscope.server.corenlp.Pipeline.getPipelineProperties ( )

Get pipeline properties

Returns: pipeline properties

◆ getPoses()

static List<List<String> > grammarscope.server.corenlp.Pipeline.getPoses ( final Annotation document )

static

Get parts-of-speech

Parameters

document document

Returns: list of list of parts-of-speech

◆ getPosTaggerModel()

String grammarscope.server.corenlp.Pipeline.getPosTaggerModel ( )

◆ getSemanticGraphs()

static List<SemanticGraph> grammarscope.server.corenlp.Pipeline.getSemanticGraphs	(	final Annotation	document,
		final TypedDependencyMode	mode
	)

static

Semantic graphs

Parameters

document	document
mode	typed dependency mode

Returns: list of semantic graphs

◆ getTextBreadthAnalysis()

static TextBreadthAnalysis grammarscope.server.corenlp.Pipeline.getTextBreadthAnalysis ( final Annotation document )

static

Text Analysis

Parameters

document document

Returns: text breadth analysis

◆ getTextDepthAnalysis()

static TextDepthAnalysis grammarscope.server.corenlp.Pipeline.getTextDepthAnalysis ( final Annotation document )

static

Text Analysis

Parameters

document document

Returns: text depth analysis

◆ getTokenAnnotations()

static <T> List<List<T> > grammarscope.server.corenlp.Pipeline.getTokenAnnotations	(	final CoreMap	map,
		final Class<? extends CoreAnnotation< T >>	clazz
	)

staticprivate

Get token annotations

Parameters

map	annotation map (document level)
clazz	selector class at Token level
<T>	type of returned list element

Returns: list of list of annotation values

◆ getTokenizeModel()

String grammarscope.server.corenlp.Pipeline.getTokenizeModel ( )

◆ getTypedDependencies()

static List<Collection<TypedDependency> > grammarscope.server.corenlp.Pipeline.getTypedDependencies	(	final Annotation	document,
		final TypedDependencyMode	mode
	)

static

Typed Dependencies

Parameters

document	document
mode	typed dependency mode

Returns: list of typed dependencies

◆ getWords()

static List<List<String> > grammarscope.server.corenlp.Pipeline.getWords ( final Annotation document )

static

Get words

Parameters

document document

Returns: list of list of words

◆ isValid()

boolean grammarscope.server.corenlp.Pipeline.isValid ( )

Whether pipeline is valid

Returns: whether pipeline is valid

◆ main()

static void grammarscope.server.corenlp.Pipeline.main ( final String[] args ) throws IOException

static

Main

Parameters

args arguments

Exceptions

IOException exception

◆ makeDefaultProperties()

static Properties grammarscope.server.corenlp.Pipeline.makeDefaultProperties ( )

static

Make default pipeline properties

Returns: default pipeline properties

◆ makeNamedEntities()

static List<NamedEntity> grammarscope.server.corenlp.Pipeline.makeNamedEntities ( final CoreMap map )

staticprivate

Make named entities

Parameters

map	sentence annotation map

Returns: named entities

◆ makePipelineProperties()

static Properties grammarscope.server.corenlp.Pipeline.makePipelineProperties ( final Properties properties0 )

static

Make pipeline properties

Parameters

properties0 properties to read values from

Returns: pipeline properties

◆ makeText() [1/3]

static String grammarscope.server.corenlp.Pipeline.makeText	(	final List< String >	tokens,
		final List< WordSegment >	wordSegments
	)

static

Make text from tokens and segments

Parameters

tokens	tokens
wordSegments	word segments

Returns: text

◆ makeText() [2/3]

static void grammarscope.server.corenlp.Pipeline.makeText	(	final String	substring,
		final Segment	segment,
		final int	from0,
		final StringBuffer	sb
	)

staticpackage

Make text from string, its start and segment

Parameters

substring	text fragment
segment	fragment's segment
from0	fragment's start
sb	string sb

◆ makeText() [3/3]

static void grammarscope.server.corenlp.Pipeline.makeText	(	final String	substring,
		final Segment	segment,
		final StringBuffer	sb
	)

staticpackage

Make text from string and its segment

Parameters

substring	substring
segment	its segment
sb	string sb

◆ makeWordSegments()

static List<WordSegment> grammarscope.server.corenlp.Pipeline.makeWordSegments	(	final List< Integer >	begins,
		final List< Integer >	ends
	)

staticprivate

Make word segments from positions

Parameters

begins	segment begins
ends	segment ends

Returns: word segments

◆ print()

void grammarscope.server.corenlp.Pipeline.print	(	final Annotation	document,
		final PrintWriter	out,
		final boolean	xMLFlag
	)		throws IOException

Print document

Parameters

document	document
out	print writer
xMLFlag	whether to output in XML format

Exceptions

IOException exception

◆ process()

Annotation grammarscope.server.corenlp.Pipeline.process ( final String text )

Pipeline-process text

Parameters

text text

Returns: document

◆ processFile()

Annotation grammarscope.server.corenlp.Pipeline.processFile ( final String file )

Pipeline-process file (path)

Parameters

file	input file path

Returns: document

◆ processLabels()

static <T> List<T> grammarscope.server.corenlp.Pipeline.processLabels	(	final CoreMap	map,
		final Class<? extends CoreAnnotation< List< CoreLabel >>>	elementAnnotationClass,
		final IProcessor< T >	processor
	)

staticprivate

Process this annotation map

Parameters

map	annotation map
elementAnnotationClass	element selector class
processor	processor
<T>	type of returned list element

Returns: list of processed elements

◆ processMaps()

static <T> List<T> grammarscope.server.corenlp.Pipeline.processMaps	(	final CoreMap	map,
		final Class<? extends CoreAnnotation< List< CoreMap >>>	elementAnnotationClass,
		final IProcessor< T >	processor
	)

staticprivate

Process this annotation map

Parameters

map	annotation map
elementAnnotationClass	element selector class
processor	processor
<T>	type of returned list element

Returns: list of processed elements

◆ processSub()

static <T> List<List<T> > grammarscope.server.corenlp.Pipeline.processSub	(	final CoreMap	map,
		@SuppressWarnings("SameParameterValue") final Class<? extends CoreAnnotation< List< CoreMap >>>	elementAnnotationClass,
		@SuppressWarnings("SameParameterValue") final Class<? extends CoreAnnotation< List< CoreLabel >>>	subElementAnnotationClass,
		final IProcessor< T >	processor
	)

staticprivate

Process this annotation map

Parameters

map	annotation map
elementAnnotationClass	element selector class
subElementAnnotationClass	subelement selector class
processor	processor
<T>	type of returned list element

Returns: list of list processed sub elements

◆ processURL()

Annotation grammarscope.server.corenlp.Pipeline.processURL ( final URL url )

Pipeline-process file (url)

Parameters

url url

Returns: document

◆ reset()

void grammarscope.server.corenlp.Pipeline.reset ( )

Reset

◆ semanticGraphModeToAnnotation2Class()

static Class<? extends SemanticGraphAnnotation> grammarscope.server.corenlp.Pipeline.semanticGraphModeToAnnotation2Class ( final TypedDependencyMode mode )

staticprivate

Semantic graph mode to Annotation class

Parameters

mode	typed dependency mode

Returns: matching annotation class

◆ semanticGraphModeToAnnotationClass()

static Class<? extends SemanticGraphAnnotation> grammarscope.server.corenlp.Pipeline.semanticGraphModeToAnnotationClass ( final TypedDependencyMode mode )

staticprivate

Semantic graph mode to Annotation class

Parameters

mode	typed dependency mode

Returns: matching annotation class

◆ toString() [1/2]

String grammarscope.server.corenlp.Pipeline.toString ( final Annotation document ) throws IOException

Document to string

Parameters

document document

Returns: string

Exceptions

IOException exception

◆ toString() [2/2]

String grammarscope.server.corenlp.Pipeline.toString	(	final Annotation	document,
		final boolean	xMLFlag
	)		throws IOException

Document to string

Parameters

document	document
xMLFlag	whether output is in XML format

Returns: document string

Exceptions

IOException exception

◆ toXMLString()

String grammarscope.server.corenlp.Pipeline.toXMLString ( final Annotation document ) throws IOException

Document to XML string

Parameters

document document

Returns: string in XML format

Exceptions

IOException exception

◆ typedDependencyModeToAnnotation2Class()

static Class<? extends TypedDependenciesAnnotation> grammarscope.server.corenlp.Pipeline.typedDependencyModeToAnnotation2Class ( final TypedDependencyMode mode )

staticprivate

◆ typedDependencyModeToAnnotationClass()

static Class<? extends TypedDependenciesAnnotation> grammarscope.server.corenlp.Pipeline.typedDependencyModeToAnnotationClass ( final TypedDependencyMode mode )

staticprivate

Typed dependencies mode to Annotation class

Parameters

mode	typed dependency mode

Returns: matching annotation class

Member Data Documentation

◆ PIPELINE_ANNOTATORS

final String grammarscope.server.corenlp.Pipeline.PIPELINE_ANNOTATORS = "annotators"

staticpackage

◆ PIPELINE_DEPPARSER_MODEL

final String grammarscope.server.corenlp.Pipeline.PIPELINE_DEPPARSER_MODEL = "depparse.model"

staticpackage

◆ PIPELINE_DEPPARSER_OPTIONS

final String grammarscope.server.corenlp.Pipeline.PIPELINE_DEPPARSER_OPTIONS = "depparse.options"

staticpackage

◆ PIPELINE_LANGUAGE

final String grammarscope.server.corenlp.Pipeline.PIPELINE_LANGUAGE = "language"

staticpackage

◆ PIPELINE_PARSER_MODEL

final String grammarscope.server.corenlp.Pipeline.PIPELINE_PARSER_MODEL = "parse.model"

staticpackage

◆ PIPELINE_PARSER_OPTIONS

final String grammarscope.server.corenlp.Pipeline.PIPELINE_PARSER_OPTIONS = "parse.flags"

staticpackage

◆ PIPELINE_POSTAGGER_MODEL

final String grammarscope.server.corenlp.Pipeline.PIPELINE_POSTAGGER_MODEL = "pos.model"

staticpackage

◆ PIPELINE_TOKENIZE_LANGUAGE

final String grammarscope.server.corenlp.Pipeline.PIPELINE_TOKENIZE_LANGUAGE = "tokenize.language"

staticpackage

◆ properties

final Properties grammarscope.server.corenlp.Pipeline.properties

protected

Properties (raw)

◆ stanfordPipeline

StanfordCoreNLP grammarscope.server.corenlp.Pipeline.stanfordPipeline

protected

Stanford Pipeline

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

grammarscope/server/src/main/java/grammarscope/server/corenlp/Pipeline.java

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Package Functions

Static Package Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Pipeline() [1/2]

◆ Pipeline() [2/2]

Member Function Documentation

◆ getAnnotations()

◆ getBreadthAnalyses()

◆ getCapabilities()

◆ getCharBegins()

◆ getCharEnds()

◆ getConstituencyParseModel()

◆ getCoreferenceIndices()

◆ getCoreferences()

◆ getDependencyParseModel()

◆ getDepthAnalyses()

◆ getGrammaticalRelationModel()

◆ getNamedEntities()

◆ getParseTrees()

◆ getPipelineProperties()

◆ getPoses()

◆ getPosTaggerModel()

◆ getSemanticGraphs()

◆ getTextBreadthAnalysis()

◆ getTextDepthAnalysis()

◆ getTokenAnnotations()

◆ getTokenizeModel()

◆ getTypedDependencies()

◆ getWords()

◆ isValid()

◆ main()

◆ makeDefaultProperties()

◆ makeNamedEntities()

◆ makePipelineProperties()

◆ makeText() [1/3]

◆ makeText() [2/3]

◆ makeText() [3/3]

◆ makeWordSegments()

◆ print()

◆ process()

◆ processFile()

◆ processLabels()

◆ processMaps()

◆ processSub()

◆ processURL()

◆ reset()

◆ semanticGraphModeToAnnotation2Class()

◆ semanticGraphModeToAnnotationClass()

◆ toString() [1/2]

◆ toString() [2/2]

◆ toXMLString()

◆ typedDependencyModeToAnnotation2Class()

◆ typedDependencyModeToAnnotationClass()

Member Data Documentation

◆ PIPELINE_ANNOTATORS

◆ PIPELINE_DEPPARSER_MODEL

◆ PIPELINE_DEPPARSER_OPTIONS

◆ PIPELINE_LANGUAGE

◆ PIPELINE_PARSER_MODEL

◆ PIPELINE_PARSER_OPTIONS

◆ PIPELINE_POSTAGGER_MODEL

◆ PIPELINE_TOKENIZE_LANGUAGE

◆ properties

◆ stanfordPipeline