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

Class PermuteFeatureBase<T extends FeatureInput>

Object

AnchorBean<FeatureListProvider<T>>

InitializableBean<FeatureListProvider<T>,FeatureRelatedInitialization>

FeatureRelatedBean<FeatureListProvider<T>>

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

FeatureListProvider<T>

PermuteFeatureBase<T>

Type Parameters:

T - input-type of feature

All Implemented Interfaces:

Provider<FeatureList<T>>

Direct Known Subclasses:

PermuteFeature, PermuteFeatureSequenceInteger

public abstract class PermuteFeatureBase<T extends FeatureInput>
extends FeatureListProvider<T>

Creates permutations of a feature by modifying a particular property of it in different ways.

This class is designed to be an abstract-base-class for different types of permutations on a single feature.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
PermuteFeatureBase()

Method Summary

Modifier and Type	Method	Description
protected abstract FeatureList<T>	createPermutedFeaturesFor(Feature<T> feature)	Creates permuted features for the given feature.
FeatureList<T>	get()	Gets or creates an object of type T.
Feature<T>	getFeature()	The feature to be permuted.
void	setFeature(Feature<T> feature)	The feature to be permuted.

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

PermuteFeatureBase

public PermuteFeatureBase()

Method Details

get

public FeatureList<T> get()
                   throws ProvisionFailedException

Description copied from interface: Provider

Gets or creates an object of type T.

Returns:

the object returned by the provider.

Throws:

ProvisionFailedException - if the object cannot be returned.

createPermutedFeaturesFor

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

Creates permuted features for the given feature.

Parameters:

feature - the feature to permute

Returns:

a FeatureList containing the permuted features

Throws:

ProvisionFailedException - if the permuted features cannot be created

getFeature

public Feature<T> getFeature()

The feature to be permuted.

setFeature

public void setFeature(Feature<T> feature)

The feature to be permuted.