Package org.anchoranalysis.plugin.image.feature.bean.list.permute

Class PermuteFeatureSequenceInteger<T extends FeatureInputDictionary>

Object

AnchorBean<FeatureListProvider<T>>

InitializableBean<FeatureListProvider<T>,FeatureRelatedInitialization>

FeatureRelatedBean<FeatureListProvider<T>>

FeatureProviderBean<FeatureListProvider<T>,FeatureList<T>>

FeatureListProvider<T>

PermuteFeatureBase<T>

PermuteFeatureSequenceInteger<T>

Type Parameters:

T - feature-input type

All Implemented Interfaces:

Provider<FeatureList<T>>

Direct Known Subclasses:

PermuteDivideByParam, PermuteFirstSecondOrder

public abstract class PermuteFeatureSequenceInteger<T extends FeatureInputDictionary>
extends PermuteFeatureBase<T>

Permutes a property on a feature with a sequence of integers.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
PermuteFeatureSequenceInteger()

Method Summary

Modifier and Type	Method	Description
void	checkMisconfigured(BeanInstanceMap defaultInstances)	Checks that a bean's properties conform to expectations.
protected abstract PermutePropertySequenceInteger	configurePermuteProperty(PermutePropertySequenceInteger permuteProperty)	Configures the PermutePropertySequenceInteger for this permutation.
protected abstract PermuteFeature<Integer,T>	createDelegate(Feature<T> feature)	Creates a delegate PermuteFeature for the given feature.
protected Feature<T>	createParam(String suffix, boolean appendNumber)	Creates a parameter feature for the permutation.
protected FeatureList<T>	createPermutedFeaturesFor(Feature<T> feature)	Creates permuted features for the given feature.
String	getParamPrefix()	Prefix for the parameter key.
PermutePropertySequenceInteger	getPermuteProperty()	Defines how to permute the property with a sequence of integers.
void	setParamPrefix(String paramPrefix)	Prefix for the parameter key.
void	setPermuteProperty(PermutePropertySequenceInteger permuteProperty)	Defines how to permute the property with a sequence of integers.

Methods inherited from class org.anchoranalysis.plugin.image.feature.bean.list.permute.PermuteFeatureBase

get, getFeature, setFeature

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

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

PermuteFeatureSequenceInteger

public PermuteFeatureSequenceInteger()

Method Details

checkMisconfigured

public void checkMisconfigured(BeanInstanceMap defaultInstances)
                        throws BeanMisconfiguredException

Description copied from class: AnchorBean

Checks that a bean's properties conform to expectations.

Overrides:

checkMisconfigured in class AnchorBean<FeatureListProvider<T extends FeatureInputDictionary>>

Parameters:

defaultInstances - all available default instances if the DefaultInstance annotation is used

Throws:

BeanMisconfiguredException - if the bean has not been configured properly as XML

createPermutedFeaturesFor

protected FeatureList<T> createPermutedFeaturesFor(Feature<T> feature)
                                            throws ProvisionFailedException

Description copied from class: PermuteFeatureBase

Creates permuted features for the given feature.

Specified by:

createPermutedFeaturesFor in class PermuteFeatureBase<T extends FeatureInputDictionary>

Parameters:

feature - the feature to permute

Returns:

a FeatureList containing the permuted features

Throws:

ProvisionFailedException - if the permuted features cannot be created

createDelegate

protected abstract PermuteFeature<Integer,T> createDelegate(Feature<T> feature)
                                                     throws ProvisionFailedException

Creates a delegate PermuteFeature for the given feature.

Parameters:

feature - the feature to permute

Returns:

a new PermuteFeature instance

Throws:

ProvisionFailedException - if the delegate cannot be created

configurePermuteProperty

protected abstract PermutePropertySequenceInteger configurePermuteProperty(PermutePropertySequenceInteger permuteProperty)

Configures the PermutePropertySequenceInteger for this permutation.

Parameters:

permuteProperty - the property to configure

Returns:

the configured PermutePropertySequenceInteger

createParam

protected Feature<T> createParam(String suffix,
 boolean appendNumber)

Creates a parameter feature for the permutation.

Parameters:

suffix - the suffix for the parameter key

appendNumber - whether to append a number to the key

Returns:

a new Feature instance

getParamPrefix

public String getParamPrefix()

Prefix for the parameter key.

setParamPrefix

public void setParamPrefix(String paramPrefix)

Prefix for the parameter key.

getPermuteProperty

public PermutePropertySequenceInteger getPermuteProperty()

Defines how to permute the property with a sequence of integers.

setPermuteProperty

public void setPermuteProperty(PermutePropertySequenceInteger permuteProperty)

Defines how to permute the property with a sequence of integers.