org.apache.ctakes.core.pipeline

Enum CuiCollector

java.lang.Object

java.lang.Enum<CuiCollector>

org.apache.ctakes.core.pipeline.CuiCollector

All Implemented Interfaces:

Serializable, Comparable<CuiCollector>

public enum CuiCollector
extends Enum<CuiCollector>

Stores a collection of Cuis from a run, along with their associated Document Ids

Since:

10/9/2016

Version:

%I%

Author:

SPF , chip-nlp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CuiCollector.CuiCollectorEngine 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
Map<String,Long>	getCuiCounts()
Map<String,Long>	getCuiCounts(String documentId)
Collection<String>	getCuis()
Collection<String>	getCuis(String documentId)
Collection<String>	getDocumentIds()
static CuiCollector	getInstance()
String	toString()
static CuiCollector	valueOf(String name) Returns the enum constant of this type with the specified name.
static CuiCollector[]	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 CuiCollector INSTANCE

Method Detail

values

public static CuiCollector[] 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 (CuiCollector c : CuiCollector.values())
    System.out.println(c);

Returns:

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

valueOf

public static CuiCollector 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 CuiCollector getInstance()

getDocumentIds

public Collection<String> getDocumentIds()

Returns:

Ids for documents that have Cuis stored in the CuiCollector

getCuis

public Collection<String> getCuis(String documentId)

Parameters:

documentId - id for some document

Returns:

cuis discovered in the document

getCuiCounts

public Map<String,Long> getCuiCounts(String documentId)

Parameters:

documentId - id for some document

Returns:

map of cuis discovered in the document and how many times they were discovered

getCuis

public Collection<String> getCuis()

Returns:

all cuis found in all documents in the run

getCuiCounts

public Map<String,Long> getCuiCounts()

Returns:

map of cuis discovered in all documents in the run and how many times they were discovered

toString

public String toString()

Overrides:

toString in class Enum<CuiCollector>

Returns:

table of document ids and cui counts