Package org.anchoranalysis.annotation.io.bean

Class AnnotatorStrategy

Object

AnchorBean<AnnotatorStrategy>

AnnotatorStrategy

Direct Known Subclasses:

SinglePathStrategy

public abstract class AnnotatorStrategy
extends AnchorBean<AnnotatorStrategy>

How an input is associated with annotations on the file-system, and how this is presented visually.

This class gives instructions on how to present the annotations process visually.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
AnnotatorStrategy()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	annotationLabelFor(ProvidesStackInput input, OperationContext context)	A human-friendly textual description of the annotation, or Optional.empty() if no label is available.
AnnotationBackground	getBackground()	The visual background to use while annotating.
StackReader	getStackReader()	How to read raster Stacks from the file-system.
abstract Path	pathFor(ProvidesStackInput input)	The path to where an annotation file for a particular input would be located.
void	setBackground(AnnotationBackground background)	The visual background to use while annotating.
void	setStackReader(StackReader stackReader)	How to read raster Stacks from the file-system.
abstract int	weightWidthDescription()	The degree as to how lengthy the labels from annotationLabelFor(ProvidesStackInput, OperationContext) can be.

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

AnnotatorStrategy

public AnnotatorStrategy()

Method Details

pathFor

public abstract Path pathFor(ProvidesStackInput input)
                      throws OperationFailedException

The path to where an annotation file for a particular input would be located.

If the annotation is stored on multiple files, this refers to the principle file that must be unique.

Parameters:

input - the input to find an annotation file for.

Returns:

the path to where the annotation would be expected to be.

Throws:

OperationFailedException - if the path cannot be successfully determined.

annotationLabelFor

public abstract Optional<String> annotationLabelFor(ProvidesStackInput input,
 OperationContext context)
                                             throws OperationFailedException

A human-friendly textual description of the annotation, or Optional.empty() if no label is available.

Parameters:

input - the input to find an annotation label for.

context - the OperationContext for the operation.

Returns:

the label, if available.

Throws:

OperationFailedException - if a label cannot be successfully determined.

weightWidthDescription

public abstract int weightWidthDescription()

The degree as to how lengthy the labels from annotationLabelFor(ProvidesStackInput, OperationContext) can be.

The higher the number, the lengthier annotationLabelFor(ProvidesStackInput, OperationContext) can be.

Returns:

the weight indicating the potential length of the description.

getBackground

public AnnotationBackground getBackground()

The visual background to use while annotating.

setBackground

public void setBackground(AnnotationBackground background)

The visual background to use while annotating.

getStackReader

public StackReader getStackReader()

How to read raster Stacks from the file-system.

setStackReader

public void setStackReader(StackReader stackReader)

How to read raster Stacks from the file-system.