org.apache.ctakes.core.pipeline

Enum EntityCollector

java.lang.Object

java.lang.Enum<EntityCollector>

org.apache.ctakes.core.pipeline.EntityCollector

All Implemented Interfaces:

Serializable, Comparable<EntityCollector>

public enum EntityCollector
extends Enum<EntityCollector>

Stores a collection of simple entity information from a run, along with their associated Document Ids

Since:

10/10/2016

Version:

%I%

Author:

SPF , chip-nlp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityCollector.Entity Holds basic information from an IdentifiedAnnotation.
static class	EntityCollector.EntityCollectorEngine Analysis Engine that stores collections of cuis by document id in the CuiCollector

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
Collection<String>	getDocumentIds()
Collection<EntityCollector.Entity>	getEntities(String documentId)
static EntityCollector	getInstance()
String	toString()
static EntityCollector	valueOf(String name) Returns the enum constant of this type with the specified name.
static EntityCollector[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final EntityCollector INSTANCE

Method Detail

values

public static EntityCollector[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EntityCollector c : EntityCollector.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EntityCollector valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getInstance

public static EntityCollector getInstance()

getDocumentIds

public Collection<String> getDocumentIds()

Returns:

Ids for documents that have entity information stored in the EntityCollector

getEntities

public Collection<EntityCollector.Entity> getEntities(String documentId)

Parameters:

documentId - id for some document

Returns:

simple entity objects for the document

toString

public String toString()

Overrides:

toString in class Enum<EntityCollector>

Returns:

staggered list of document ids, entities and entity properties