Package org.icij.datashare.text.nlp

Interface Pipeline

All Known Implementing Classes:

AbstractPipeline

public interface Pipeline

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Pipeline.Property
static class	Pipeline.Type

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_CACHING
static Charset	DEFAULT_ENCODING
static List<NamedEntity.Category>	DEFAULT_ENTITIES
static List<NlpStage>	DEFAULT_TARGET_STAGES

Method Summary

Modifier and Type	Method	Description
Charset	getEncoding()
Optional<String>	getPosTagSet(Language language)
List<NlpStage>	getStages()
List<NamedEntity.Category>	getTargetEntities()
Pipeline.Type	getType()
boolean	initialize(Language language)
boolean	isCaching()
List<NamedEntity>	process(Document doc)
List<NamedEntity>	process(Document doc, int contentLength, int contentOffset)
static Set<Pipeline.Type>	set(Pipeline.Type... types)
boolean	supports(NlpStage stage, Language language)	Is stage supported for language?
void	terminate(Language language)

Field Detail

DEFAULT_ENCODING

static final Charset DEFAULT_ENCODING

DEFAULT_TARGET_STAGES

static final List<NlpStage> DEFAULT_TARGET_STAGES

DEFAULT_ENTITIES

static final List<NamedEntity.Category> DEFAULT_ENTITIES

DEFAULT_CACHING

static final boolean DEFAULT_CACHING

See Also:

Constant Field Values

Method Detail

set

static Set<Pipeline.Type> set(Pipeline.Type... types)

getType

Pipeline.Type getType()

initialize

boolean initialize(Language language)
            throws InterruptedException

Throws:

InterruptedException

process

List<NamedEntity> process(Document doc)
                   throws InterruptedException

Throws:

InterruptedException

process

List<NamedEntity> process(Document doc,
                          int contentLength,
                          int contentOffset)
                   throws InterruptedException

Throws:

InterruptedException

terminate

void terminate(Language language)
        throws InterruptedException

Throws:

InterruptedException

supports

boolean supports(NlpStage stage,
                 Language language)

Is stage supported for language?

Parameters:

stage - the stage to test for support

language - the language on which stage is tested

Returns:

true if stage supports language; false otherwise

getTargetEntities

List<NamedEntity.Category> getTargetEntities()

Returns:

the list of all targeted named entity categories

getStages

List<NlpStage> getStages()

Returns:

the list of all involved stages

isCaching

boolean isCaching()

Returns:

true if pipeline is caching annotators; false otherwise

getEncoding

Charset getEncoding()

Returns:

the list of all involved stages

getPosTagSet

Optional<String> getPosTagSet(Language language)

Returns:

the tagset used by the part-of-speech tagger