Package org.anchoranalysis.plugin.image.task.bean.labeller

Class ImageLabellerStringMap<T>

Object

AnchorBean<ImageLabeller<ImageLabellerStringMapInitialization<T>>>

ImageLabeller<ImageLabellerStringMapInitialization<T>>

ImageLabellerStringMap<T>

Type Parameters:

T - the init-param-type of filter that is the delegate

public class ImageLabellerStringMap<T>
extends ImageLabeller<ImageLabellerStringMapInitialization<T>>

Maps one set of labels to another

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ImageLabellerStringMap()

Method Summary

Modifier and Type	Method	Description
Set<String>	allLabels(ImageLabellerStringMapInitialization<T> initialization)	Returns a set of identifiers for all groups that can be outputted by the labeller.
ImageLabeller<T>	getFilter()
StringMap	getMap()
ImageLabellerStringMapInitialization<T>	initialize(Path pathForBinding)	Initializes the labeller.
String	labelFor(ImageLabellerStringMapInitialization<T> sharedState, ProvidesStackInput input, InputOutputContext context)	Determines a particular group-identifier (label) for an input.
void	setFilter(ImageLabeller<T> filter)
void	setMap(StringMap map)

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ImageLabellerStringMap

public ImageLabellerStringMap()

Method Details

initialize

public ImageLabellerStringMapInitialization<T> initialize(Path pathForBinding)
                                                   throws InitializeException

Description copied from class: ImageLabeller

Initializes the labeller. Should be called once before calling any other methods.

Specified by:

initialize in class ImageLabeller<ImageLabellerStringMapInitialization<T>>

Parameters:

pathForBinding - a Path that can be used by the labeller to make file path decisions

Returns:

the initialized shared-state of type T

Throws:

InitializeException - if initialization fails

allLabels

public Set<String> allLabels(ImageLabellerStringMapInitialization<T> initialization)

Description copied from class: ImageLabeller

Returns a set of identifiers for all groups that can be outputted by the labeller.

This method should be callable at any time.

Specified by:

allLabels in class ImageLabeller<ImageLabellerStringMapInitialization<T>>

Parameters:

initialization - the initialized shared-state returned by ImageLabeller.initialize(Path)

Returns:

a Set of String labels

labelFor

public String labelFor(ImageLabellerStringMapInitialization<T> sharedState,
 ProvidesStackInput input,
 InputOutputContext context)
                throws OperationFailedException

Description copied from class: ImageLabeller

Determines a particular group-identifier (label) for an input.

Specified by:

labelFor in class ImageLabeller<ImageLabellerStringMapInitialization<T>>

Parameters:

sharedState - the shared-state returned by ImageLabeller.initialize(Path)

input - the ProvidesStackInput to be labelled

context - the InputOutputContext for the operation

Returns:

the label as a String

Throws:

OperationFailedException - if the labelling operation fails

getFilter

public ImageLabeller<T> getFilter()

setFilter

public void setFilter(ImageLabeller<T> filter)

getMap

public StringMap getMap()

setMap

public void setMap(StringMap map)