Package org.anchoranalysis.feature.initialization

Class FeatureRelatedInitialization

Object

org.anchoranalysis.feature.initialization.FeatureRelatedInitialization

All Implemented Interfaces:

BeanInitialization

public class FeatureRelatedInitialization
extends Object
implements BeanInitialization

Parameters for initializing a FeatureRelatedBean.

Author:

Owen Feehan

Method Summary

Modifier and Type	Method	Description
static FeatureRelatedInitialization	create(SharedObjects sharedObjects)	Creates with shared-objects, and otherwise empty initialization.
static FeatureRelatedInitialization	create(Logger logger, Path modelDirectory)	Creates a log and a model-directory, and otherwise empty initialization.
DictionaryInitialization	getDictionary()	The associated initialization for a DictionaryBean.
NamedProviderStore<FeatureList<FeatureInput>>	getFeatureLists()	Gets the underlying NamedProviderStore that provides shared-features.
FilePathInitialization	getFilePaths()	A named-set of file-paths.
SharedFeatures	getSharedFeatures()	Shared features available for reference during calculation.
void	populate(List<NamedBean<FeatureListProvider<FeatureInput>>> namedProviders, Logger logger)	Adds features into the shared-feature storage from a list of named-beans.

Methods inherited from class java.lang.Object

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

Method Details

create

public static FeatureRelatedInitialization create(SharedObjects sharedObjects)

Creates with shared-objects, and otherwise empty initialization.

Parameters:

sharedObjects - the shared-objects.

Returns:

an initialization containing shared-objects, but otherwise unpopulated.

create

public static FeatureRelatedInitialization create(Logger logger, Path modelDirectory)

Creates a log and a model-directory, and otherwise empty initialization.

Parameters:

logger - the logger.

modelDirectory - the path to the directory contains models.

Returns:

an initialization containing the above two aspects, but otherwise unpopulated.

getFeatureLists

public NamedProviderStore<FeatureList<FeatureInput>> getFeatureLists()

Gets the underlying NamedProviderStore that provides shared-features.

Returns:

the underlying store, which if changed, will also change this instance.

populate

public void populate(List<NamedBean<FeatureListProvider<FeatureInput>>> namedProviders, Logger logger) throws OperationFailedException

Adds features into the shared-feature storage from a list of named-beans.

Additionally the features are initialized, with the current instance.

Parameters:

namedProviders - providers of feature-lists, each list with an associated name.

logger - the logger to supply to features to report messages and errors with.

Throws:

OperationFailedException - if any feature provided by the lists fails to initialize.

getDictionary

public DictionaryInitialization getDictionary()

The associated initialization for a DictionaryBean.

getFilePaths

public FilePathInitialization getFilePaths()

A named-set of file-paths.

getSharedFeatures

public SharedFeatures getSharedFeatures()

Shared features available for reference during calculation.