Package org.anchoranalysis.plugin.image.bean.scale

Class ToSuggested

Object

AnchorBean<ScaleCalculator>

InitializableBean<ScaleCalculator,ImageInitialization>

ImageBean<ScaleCalculator>

ScaleCalculator

ToSuggested

public class ToSuggested
extends ScaleCalculator

Scales to the suggested-size if one is provided, otherwise calls fallback.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ToSuggested()
ToSuggested(ScaleCalculator fallback)	Creates a new ToSuggested instance.

Method Summary

Modifier and Type	Method	Description
ScaleFactor	calculate(Optional<Dimensions> dimensionsToBeScaled, Optional<ImageSizeSuggestion> suggestedSize)	Calculates a scaling-factor for a source image/entity of particular dimensions.
ScaleCalculator	getFallback()	Used as a delegate to calculate the scale if suggestedSize is empty when passed to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).
void	setFallback(ScaleCalculator fallback)	Used as a delegate to calculate the scale if suggestedSize is empty when passed to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

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

ToSuggested

public ToSuggested()

ToSuggested

public ToSuggested(ScaleCalculator fallback)

Creates a new ToSuggested instance.

Parameters:

fallback - Used as a delegate to calculate the scale if suggestedSize is empty when passed to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).

Method Details

calculate

public ScaleFactor calculate(Optional<Dimensions> dimensionsToBeScaled,
 Optional<ImageSizeSuggestion> suggestedSize)
                      throws OperationFailedException

Description copied from class: ScaleCalculator

Calculates a scaling-factor for a source image/entity of particular dimensions.

Specified by:

calculate in class ScaleCalculator

Parameters:

dimensionsToBeScaled - dimensions of the source image/entity that will be scaled, if they are known.

suggestedSize - a string suggesting dimensions to resize to or a scaling-factor.

Returns:

the scaling-factor to use.

Throws:

OperationFailedException - if a scale-factor cannot be successfully calculated.

getFallback

public ScaleCalculator getFallback()

Used as a delegate to calculate the scale if suggestedSize is empty when passed to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).

setFallback

public void setFallback(ScaleCalculator fallback)

Used as a delegate to calculate the scale if suggestedSize is empty when passed to calculate(java.util.Optional<org.anchoranalysis.image.core.dimensions.Dimensions>, java.util.Optional<org.anchoranalysis.image.core.dimensions.size.suggestion.ImageSizeSuggestion>).