org.icij.datashare.text.nlp

Class AbstractPipeline

java.lang.Object

org.icij.datashare.text.nlp.AbstractPipeline

All Implemented Interfaces:

Pipeline

public abstract class AbstractPipeline
extends Object
implements Pipeline

Nested Class Summary

Nested classes/interfaces inherited from interface org.icij.datashare.text.nlp.Pipeline

Pipeline.Property, Pipeline.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	caching
protected Charset	encoding
protected org.slf4j.Logger	LOGGER
static String	NLP_STAGES_PROP
protected Map<NlpStage,List<NlpStage>>	stageDependencies
protected List<NlpStage>	stages
protected List<NamedEntity.Category>	targetEntities
protected List<NlpStage>	targetStages

Fields inherited from interface org.icij.datashare.text.nlp.Pipeline

DEFAULT_CACHING, DEFAULT_ENCODING, DEFAULT_ENTITIES, DEFAULT_TARGET_STAGES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPipeline(Properties properties)

Method Summary

Modifier and Type	Method and Description
static AbstractPipeline	create(String pipelineName, PropertiesProvider propertiesProvider)
Charset	getEncoding()
List<NlpStage>	getStages()
List<NamedEntity.Category>	getTargetEntities()
Pipeline.Type	getType()
boolean	initialize(Language language) Prepare pipeline run Check language support for implied stages.
boolean	isCaching()
abstract Annotations	process(String content, String docId, Language language) Apply all specified stages/annotators on input
List<NamedEntity>	processHeaders(Document doc)
abstract Map<Language,Set<NlpStage>>	supportedStages()
boolean	supports(NlpStage stage, Language language) Is stage supported for language?
void	terminate(Language language) Post-processing operations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.icij.datashare.text.nlp.Pipeline

getPosTagSet, set

Field Detail

NLP_STAGES_PROP

public static final String NLP_STAGES_PROP

See Also:

Constant Field Values

LOGGER

protected final org.slf4j.Logger LOGGER

encoding

protected final Charset encoding

stageDependencies

protected final Map<NlpStage,List<NlpStage>> stageDependencies

targetStages

protected final List<NlpStage> targetStages

targetEntities

protected final List<NamedEntity.Category> targetEntities

caching

protected final boolean caching

stages

protected List<NlpStage> stages

Constructor Detail

AbstractPipeline

protected AbstractPipeline(Properties properties)

Method Detail

getType

public Pipeline.Type getType()

Specified by:

getType in interface Pipeline

getTargetEntities

public List<NamedEntity.Category> getTargetEntities()

Specified by:

getTargetEntities in interface Pipeline

Returns:

the list of all targeted named entity categories

getStages

public List<NlpStage> getStages()

Specified by:

getStages in interface Pipeline

Returns:

the list of all involved stages

isCaching

public boolean isCaching()

Specified by:

isCaching in interface Pipeline

Returns:

true if pipeline is caching annotators; false otherwise

getEncoding

public Charset getEncoding()

Specified by:

getEncoding in interface Pipeline

Returns:

the list of all involved stages

create

public static AbstractPipeline create(String pipelineName,
                                      PropertiesProvider propertiesProvider)
                               throws NoSuchMethodException,
                                      IllegalAccessException,
                                      InvocationTargetException,
                                      InstantiationException,
                                      ClassNotFoundException

Throws:

NoSuchMethodException

IllegalAccessException

InvocationTargetException

InstantiationException

ClassNotFoundException

initialize

public boolean initialize(Language language)
                   throws InterruptedException

Prepare pipeline run Check language support for implied stages.

Specified by:

initialize in interface Pipeline

Returns:

false if any stage is not supported in language; true otherwise

Throws:

InterruptedException

process

public abstract Annotations process(String content,
                                    String docId,
                                    Language language)
                             throws InterruptedException

Apply all specified stages/annotators on input

Specified by:

process in interface Pipeline

Parameters:

content - is the source String to process

docId - the input hash code

Throws:

InterruptedException

processHeaders

public List<NamedEntity> processHeaders(Document doc)

terminate

public void terminate(Language language)
               throws InterruptedException

Post-processing operations

Specified by:

terminate in interface Pipeline

Throws:

InterruptedException

supportedStages

public abstract Map<Language,Set<NlpStage>> supportedStages()

Returns:

Language . NlpStage support matrix

supports

public boolean supports(NlpStage stage,
                        Language language)

Is stage supported for language?

Specified by:

supports in interface Pipeline

Parameters:

stage - the stage to test for support

language - the language on which stage is tested

Returns:

true if stage supports language; false otherwise