Package org.anchoranalysis.image.io.stack.time

Class ExtractFrameStore

Object

ExtractFrameStore

All Implemented Interfaces:

NamedProvider<TimeSeries>, NamedProviderStore<TimeSeries>

public class ExtractFrameStore
extends Object
implements NamedProviderStore<TimeSeries>

Exposes a NamedProviderStore<TimeSeries> as a NamedProviderStore<Stack> by extracting a frame from each series.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ExtractFrameStore(NamedProviderStore<Stack> stacks)	Creates to extract at time-index 0.
ExtractFrameStore(NamedProviderStore<Stack> stacks, int timeIndex)	Creates to extract at time-index timeIndex.

Method Summary

Modifier and Type	Method	Description
void	add(String identifier, StoreSupplier<TimeSeries> supplier)	Adds an element to the store.
Optional<TimeSeries>	getOptional(String key)	Retrieves the item if it exists, or returns Optional.empty() if it doesn't exist.
Set<String>	keys()	Returns a set of keys associated with the provider.

Methods inherited from class java.lang.Object

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

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

getArbitraryElement, getException, isEmpty

Constructor Details

ExtractFrameStore

public ExtractFrameStore(NamedProviderStore<Stack> stacks)

Creates to extract at time-index 0.

Parameters:

stacks - the underlying store of Stacks.

ExtractFrameStore

public ExtractFrameStore(NamedProviderStore<Stack> stacks,
 int timeIndex)

Creates to extract at time-index timeIndex.

Parameters:

stacks - the underlying store of Stacks.

timeIndex - the time-index to extract from each TimeSeries.

Method Details

getOptional

public Optional<TimeSeries> getOptional(String key)
                                 throws NamedProviderGetException

Description copied from interface: NamedProvider

Retrieves the item if it exists, or returns Optional.empty() if it doesn't exist.

Note that a 'key' might still throw an exception for another reason (but never because a particular key is absent).

Specified by:

getOptional in interface NamedProvider<TimeSeries>

Parameters:

key - a unique name for the item.

Returns:

the item, if it exists, otherwise Optional.empty().

Throws:

NamedProviderGetException - if no item exists for identifier.

keys

public Set<String> keys()

Description copied from interface: NamedProvider

Returns a set of keys associated with the provider.

There's no guarantee that it refers to all valid keys.

Specified by:

keys in interface NamedProvider<TimeSeries>

Returns:

a set of all keys associated with the provider.

add

public void add(String identifier,
 StoreSupplier<TimeSeries> supplier)
         throws OperationFailedException

Description copied from interface: NamedProviderStore

Adds an element to the store.

Specified by:

add in interface NamedProviderStore<TimeSeries>

Parameters:

identifier - a unique identifier for the element.

supplier - supplies the element to be added (which may be evaluated immediately, or a later point lazily).

Throws:

OperationFailedException - if the identifier already exists, or otherwise the add operation fails.