org.apache.ctakes.core.pipeline

Annotation Type PipeBitInfo

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Inherited
public @interface PipeBitInfo

Annotation that should be used for Collection Readers, Annotators, and Cas Consumers (Writers). It may be useful for pipeline builder UIs and other human-pipeline interaction.

Since:

12/22/2016

Version:

%I%

Author:

SPF , chip-nlp

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NO_PARAMETERS
static PipeBitInfo.TypeProduct[]	NO_TYPE_PRODUCTS

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
PipeBitInfo.TypeProduct[]	dependencies
String[]	parameters
PipeBitInfo.TypeProduct[]	products
PipeBitInfo.Role	role
PipeBitInfo.TypeProduct[]	usables

Field Detail

NO_PARAMETERS

public static final String NO_PARAMETERS

NO_TYPE_PRODUCTS

public static final PipeBitInfo.TypeProduct[] NO_TYPE_PRODUCTS

Element Detail

name

public abstract String name

Returns:

Human-readable name of the Reader, Annotator, or Writer

description

public abstract String description

Returns:

Human-readable description of the purpose of the Reader, Annotator, or Writer

role

public abstract PipeBitInfo.Role role

Returns:

Role played within a pipeline

Default:

org.apache.ctakes.core.pipeline.PipeBitInfo.Role.ANNOTATOR

parameters

public abstract String[] parameters

Returns:

Human-readable names of Configuration Parameters

Default:

"No Parameters."

dependencies

public abstract PipeBitInfo.TypeProduct[] dependencies

Returns:

array of typesystem type dependencies of the Reader, Annotator, or Writer

Default:

{}

usables

public abstract PipeBitInfo.TypeProduct[] usables

Returns:

array of usable but not required typesystem types of the Reader, Annotator, or Writer

Default:

{}

products

public abstract PipeBitInfo.TypeProduct[] products

Returns:

array of typesystem type products of the Reader, Annotator, or Writer

Default:

{}