Package org.anchoranalysis.mpp.io.input

Class StackWithMap

Object

StackWithMap

All Implemented Interfaces:

MultiInputSubMap<TimeSeries>

public class StackWithMap
extends Object
implements MultiInputSubMap<TimeSeries>

Combines a Stack with a map of other stacks.

Constructor Summary

Constructors

Constructor	Description
StackWithMap(String mainObjectName, ProvidesStackInput mainInputObject)	Creates a new StackWithMap instance.

Method Summary

Modifier and Type	Method	Description
void	add(String name, StoreSupplier<TimeSeries> op)	Adds an entry to the map.
void	addToStore(NamedProviderStore<TimeSeries> stackCollection, int seriesNum, Logger logger)	Adds the main stack and other stacks to the store.
void	addToStore(NamedProviderStore<TimeSeries> stackCollection, Logger logger)	Copies all the existing entries into a NamedProviderStore.
void	close(ErrorReporter errorReporter)	Closes resources and cleans up.
StoreSupplier<TimeSeries>	get(String name)	Retrieves an entry from the map.
String	getMainObjectName()	Gets the name of the main object.
String	inputName()	Gets the input name.
int	numFrames()	Gets the number of frames.
Optional<Path>	pathForBinding()	Gets the path for binding.

Methods inherited from class java.lang.Object

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

Constructor Details

StackWithMap

public StackWithMap(String mainObjectName,
 ProvidesStackInput mainInputObject)

Creates a new StackWithMap instance.

Parameters:

mainObjectName - Needed for getting main-stack.

mainInputObject - The main input object that provides the stack.

Method Details

addToStore

public void addToStore(NamedProviderStore<TimeSeries> stackCollection,
 Logger logger)
                throws OperationFailedException

Description copied from interface: MultiInputSubMap

Copies all the existing entries into a NamedProviderStore.

Specified by:

addToStore in interface MultiInputSubMap<TimeSeries>

Parameters:

stackCollection - the store to copy the entries into

logger - a logger for any non-fatal errors

Throws:

OperationFailedException - if a fatal error occurs during the copy process

addToStore

public void addToStore(NamedProviderStore<TimeSeries> stackCollection,
 int seriesNum,
 Logger logger)
                throws OperationFailedException

Adds the main stack and other stacks to the store.

Parameters:

stackCollection - the store to add the stacks to

seriesNum - the series number

logger - the logger for reporting errors

Throws:

OperationFailedException - if adding to the store fails

add

public void add(String name,
 StoreSupplier<TimeSeries> op)

Description copied from interface: MultiInputSubMap

Adds an entry to the map.

Specified by:

add in interface MultiInputSubMap<TimeSeries>

Parameters:

name - the name of the entry

op - the supplier for the entry's value

close

public void close(ErrorReporter errorReporter)

Closes resources and cleans up.

Parameters:

errorReporter - for reporting any errors during closure

getMainObjectName

public String getMainObjectName()

Gets the name of the main object.

Returns:

the name of the main object

inputName

public String inputName()

Gets the input name.

Returns:

the input name

pathForBinding

public Optional<Path> pathForBinding()

Gets the path for binding.

Returns:

an Optional containing the path for binding, if available

numFrames

public int numFrames()
              throws OperationFailedException

Gets the number of frames.

Returns:

the number of frames

Throws:

OperationFailedException - if retrieving the number of frames fails

get

public StoreSupplier<TimeSeries> get(String name)
                              throws OperationFailedException

Description copied from interface: MultiInputSubMap

Retrieves an entry from the map.

Specified by:

get in interface MultiInputSubMap<TimeSeries>

Parameters:

name - the name of the entry to retrieve

Returns:

the StoreSupplier for the entry, or null if the entry doesn't exist

Throws:

OperationFailedException - if an error occurs while retrieving the entry