Package org.anchoranalysis.feature.initialization

Class FeatureInitialization

Object

FeatureInitialization

All Implemented Interfaces:

BeanInitialization

public final class FeatureInitialization
extends Object
implements BeanInitialization

Parameters used to initialize a Feature before any calculation occurs.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureInitialization()	Create without any dictionary, energy-stack or shared-objects.
FeatureInitialization(Optional<Dictionary> dictionary, Optional<EnergyStackWithoutParameters> energyStack, Optional<SharedObjects> sharedObjects)	Creates a new FeatureInitialization instance.
FeatureInitialization(SharedObjects sharedObjects)	Create only with shared-objects.
FeatureInitialization(Dictionary dictionary)	Create only with a dictionary.
FeatureInitialization(EnergyStack energyStack)	Create only with an energy-stack.

Method Summary

Modifier and Type	Method	Description
FeatureInitialization	duplicateShallow()	A shallow-copy of the current initialization.
boolean	equals(Object o)
Optional<Dictionary>	getDictionary()	A dictionary of key-value pairs.
Optional<EnergyStackWithoutParameters>	getEnergyStack()	An energy-stack, which may form an input to the feature for calculation.
Optional<SharedObjects>	getSharedObjects()	Shared-objects, which can be referenced by the feature to influence calculation.
int	hashCode()
SharedObjects	sharedObjectsRequired()	Retrieves the shared-objects associated with the initialization, or throws an an exception if they do not exist.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FeatureInitialization

public FeatureInitialization()

Create without any dictionary, energy-stack or shared-objects.

FeatureInitialization

public FeatureInitialization(SharedObjects sharedObjects)

Create only with shared-objects.

Parameters:

sharedObjects - the shared objects.

FeatureInitialization

public FeatureInitialization(Dictionary dictionary)

Create only with a dictionary.

Parameters:

dictionary - the dictionary.

FeatureInitialization

public FeatureInitialization(EnergyStack energyStack)

Create only with an energy-stack.

Parameters:

energyStack - the energy-stack.

FeatureInitialization

public FeatureInitialization(Optional<Dictionary> dictionary,
 Optional<EnergyStackWithoutParameters> energyStack,
 Optional<SharedObjects> sharedObjects)

Creates a new FeatureInitialization instance.

Parameters:

dictionary - A dictionary of key-value pairs.

energyStack - An energy-stack, which may form an input to the feature for calculation.

sharedObjects - Shared-objects, which can be referenced by the feature to influence calculation.

Method Details

duplicateShallow

public FeatureInitialization duplicateShallow()

A shallow-copy of the current initialization.

Returns:

a new FeatureInitialization which reuses the existing state.

sharedObjectsRequired

public SharedObjects sharedObjectsRequired()
                                    throws InitializeException

Retrieves the shared-objects associated with the initialization, or throws an an exception if they do not exist.

Returns:

the shared-objects.

Throws:

InitializeException - if no shared-objects exist.

getDictionary

public Optional<Dictionary> getDictionary()

A dictionary of key-value pairs.

getEnergyStack

public Optional<EnergyStackWithoutParameters> getEnergyStack()

An energy-stack, which may form an input to the feature for calculation.

getSharedObjects

public Optional<SharedObjects> getSharedObjects()

Shared-objects, which can be referenced by the feature to influence calculation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object