Package org.anchoranalysis.image.bean.nonbean.spatial.align

Class PositionChoices

Object

PositionChoices

public class PositionChoices
extends Object

The choices of text that may describe the position of an entity along a particular axis.

All choices are case insensitive.

Constructor Summary

Constructors

Constructor	Description
PositionChoices(String textMin, String textCenter, String textMax)	Creates a new PositionChoices instance.
PositionChoices(String textMin, String textCenter, String textMax, Optional<String> textMinAlternative)	Creates a new PositionChoices instance.

Method Summary

Modifier and Type	Method	Description
AlignmentOnDimension	alignmentForDimension(String fieldName, String fieldValue)	Calculates how to align a particular axis.

Methods inherited from class java.lang.Object

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

Constructor Details

PositionChoices

public PositionChoices(String textMin,
 String textCenter,
 String textMax,
 Optional<String> textMinAlternative)

Creates a new PositionChoices instance.

Parameters:

textMin - The text to describe the minimum position along the axis.

textCenter - The text to describe the center position along the axis.

textMax - The text to describe the maximum position along the axis.

textMinAlternative - An additional alternative text to describe the minimum position along the axis, if one exists.

PositionChoices

public PositionChoices(String textMin,
 String textCenter,
 String textMax)

Creates a new PositionChoices instance.

Parameters:

textMin - The text to describe the minimum position along the axis.

textCenter - The text to describe the center position along the axis.

textMax - The text to describe the maximum position along the axis.

Method Details

alignmentForDimension

public AlignmentOnDimension alignmentForDimension(String fieldName,
 String fieldValue)
                                           throws BeanMisconfiguredException

Calculates how to align a particular axis.

Parameters:

fieldName - the name of the field where the position was specified.

fieldValue - the value of the field.

Returns:

the minimum corner on the particular axis to locate the overlay.

Throws:

BeanMisconfiguredException - if an invalid value for a field was used.