org.apache.ctakes.gui.pipeline.bit.user

Class DefaultUserBit

java.lang.Object

org.apache.ctakes.gui.pipeline.bit.user.DefaultUserBit

All Implemented Interfaces:

ParameterHolder, UserBit

public final class DefaultUserBit
extends Object
implements UserBit

Since:

1/19/2017

Version:

%I%

Author:

SPF , chip-nlp

Constructor Summary

Constructors

Constructor and Description
DefaultUserBit(PipeBitInfo pipeBitInfo, Class<?> pipeBitClass)

Method Summary

Modifier and Type	Method and Description
String	getBitName()
org.apache.uima.fit.descriptor.ConfigurationParameter	getParameter(int index)
String	getParameterClass(int index)
int	getParameterCount()
String	getParameterDescription(int index)
String	getParameterName(int index)
String[]	getParameterValue(int index)
Class<?>	getPipeBitClass()
PipeBitInfo	getPipeBitInfo()
boolean	isParameterMandatory(int index)
void	setBitName(String name)
void	setParameterValue(int index, String... values)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUserBit

public DefaultUserBit(PipeBitInfo pipeBitInfo,
                      Class<?> pipeBitClass)

Method Detail

getBitName

public String getBitName()

Specified by:

getBitName in interface UserBit

Returns:

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

setBitName

public void setBitName(String name)

Specified by:

setBitName in interface UserBit

Parameters:

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

getPipeBitInfo

public PipeBitInfo getPipeBitInfo()

Specified by:

getPipeBitInfo in interface UserBit

Returns:

PipeBitInfo associated with this UserBit

getPipeBitClass

public Class<?> getPipeBitClass()

Specified by:

getPipeBitClass in interface UserBit

Returns:

Reader, AE, Writer associated with this UserBit

getParameterCount

public int getParameterCount()

Specified by:

getParameterCount in interface ParameterHolder

getParameter

public org.apache.uima.fit.descriptor.ConfigurationParameter getParameter(int index)

Specified by:

getParameter in interface ParameterHolder

getParameterClass

public String getParameterClass(int index)

Specified by:

getParameterClass in interface ParameterHolder

getParameterName

public String getParameterName(int index)

Specified by:

getParameterName in interface ParameterHolder

getParameterDescription

public String getParameterDescription(int index)

Specified by:

getParameterDescription in interface ParameterHolder

isParameterMandatory

public boolean isParameterMandatory(int index)

Specified by:

isParameterMandatory in interface ParameterHolder

getParameterValue

public String[] getParameterValue(int index)

Specified by:

getParameterValue in interface ParameterHolder

setParameterValue

public void setParameterValue(int index,
                              String... values)

Specified by:

setParameterValue in interface UserBit

Parameters:

index - -

values - User Values for Configuration parameter at index