Package org.anchoranalysis.feature.shared

Class SharedFeatures

Object

org.anchoranalysis.feature.shared.SharedFeatures

All Implemented Interfaces:

Iterable<NameValue<Feature<FeatureInput>>>, NamedProvider<Feature<FeatureInput>>

public class SharedFeatures
extends Object
implements NamedProvider<Feature<FeatureInput>>, Iterable<NameValue<Feature<FeatureInput>>>

A group of features made available to other features to reference.

The features may have heterogeneous feature input-type, and are therefore stored with FeatureInput input-type, as this is the parent type for all feature-inputs.

This is the principle class for storing all available shared-features.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
SharedFeatures()	Create empty, without any features.

Method Summary

Modifier and Type	Method	Description
void	addFromList(FeatureList<FeatureInput> list)	Add features from a feature-list.
void	addFromProviders(NamedProvider<FeatureList<FeatureInput>> provider)	Add features from a NamedProvider of feature-lists.
boolean	contains(Feature<FeatureInput> feature)	Whether a particular feature is contained in this instance.
SharedFeatures	duplicate()	A deep copy of the current instance.
Optional<Feature<FeatureInput>>	getOptional(String key)
Iterator<NameValue<Feature<FeatureInput>>>	iterator()
Set<String>	keys()
void	removeIfExists(FeatureList<FeatureInput> featuresToRemove)	Remove all features, if they currently exist, from features.
<S extends FeatureInput> SharedFeaturesSubset<S>	subsetCompatibleWith(Class<? extends FeatureInput> inputType)	Extracts the subset of inputs that are compatible with a particular input-type.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.anchoranalysis.core.identifier.provider.NamedProvider

getArbitraryElement, getException, isEmpty

Constructor Details

SharedFeatures

public SharedFeatures()

Create empty, without any features.

Method Details

subsetCompatibleWith

public <S extends FeatureInput> SharedFeaturesSubset<S> subsetCompatibleWith(Class<? extends FeatureInput> inputType)

Extracts the subset of inputs that are compatible with a particular input-type.

Parameters:

inputType - the class of input-type which we search for features to be compatible with.

Returns:

a new SharedFeaturesSubset containing only the features considered compatible with inputType.

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(Feature<FeatureInput> feature)

Whether a particular feature is contained in this instance.

This is checked in constant average-case lookup time.

Parameters:

feature - the feature to check.

Returns:

true if the feature is contained, false otherwise.

duplicate

public SharedFeatures duplicate()

A deep copy of the current instance.

Returns:

a deep copy.

addFromProviders

public void addFromProviders(NamedProvider<FeatureList<FeatureInput>> provider)

Add features from a NamedProvider of feature-lists.

Each Feature is added directly (without duplication).

Parameters:

provider - the provider to add features from.

addFromList

public void addFromList(FeatureList<FeatureInput> list)

Add features from a feature-list.

Each Feature is added directly (without duplication).

Parameters:

list - the list to add features from.

removeIfExists

public void removeIfExists(FeatureList<FeatureInput> featuresToRemove)

Remove all features, if they currently exist, from features.

Parameters:

featuresToRemove - a list of features to remove.

iterator

public Iterator<NameValue<Feature<FeatureInput>>> iterator()

Specified by:

iterator in interface Iterable<NameValue<Feature<FeatureInput>>>

getOptional

public Optional<Feature<FeatureInput>> getOptional(String key)

Specified by:

getOptional in interface NamedProvider<Feature<FeatureInput>>

keys

public Set<String> keys()

Specified by:

keys in interface NamedProvider<Feature<FeatureInput>>