Class DefineOutputterWithEnergy

Object

AnchorBean<DefineOutputter>

DefineOutputter

DefineOutputterWithEnergy

public class DefineOutputterWithEnergy
extends DefineOutputter

Like a Define but outputs also an energy-stack.

The following outputs are produced:

Output Name	Default?	Description
outputs from EnergyStackWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefineOutputterWithEnergy.ProcessWithEnergyStack<T,S>	Functional interface for processing with an energy stack.

Nested classes/interfaces inherited from class org.anchoranalysis.plugin.mpp.bean.define.DefineOutputter

DefineOutputter.Processor<T>

Constructor Summary

Constructors

Constructor	Description
DefineOutputterWithEnergy()

Method Summary

Modifier and Type	Method	Description
DictionaryProvider	getDictionary()	An optional dictionary provider.
StackProvider	getStackEnergy()	The stack provider for the energy stack.
<S> S	processInput(InitializationContext context, SharedObjects sharedObjects, Optional<Dictionary> dictionary, DefineOutputterWithEnergy.ProcessWithEnergyStack<ImageInitialization, S> operation)	Processes the input with an energy stack and shared objects.
<S> void	processInput(ExportSharedObjects input, InitializationContext context, DefineOutputterWithEnergy.ProcessWithEnergyStack<ImageInitialization, S> operation)	Processes the input with an energy stack.
void	setDictionary(DictionaryProvider dictionary)	An optional dictionary provider.
void	setStackEnergy(StackProvider stackEnergy)	The stack provider for the energy stack.

Methods inherited from class org.anchoranalysis.plugin.mpp.bean.define.DefineOutputter

addAllOutputNamesTo, createInitialization, createInitialization, getDefine, isSuppressSubfolders, outputSharedObjects, process, setDefine, setSuppressSubfolders

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DefineOutputterWithEnergy

public DefineOutputterWithEnergy()

Method Details

processInput

public <S> void processInput(ExportSharedObjects input,
 InitializationContext context,
 DefineOutputterWithEnergy.ProcessWithEnergyStack<ImageInitialization, S> operation)
                      throws OperationFailedException

Processes the input with an energy stack.

Type Parameters:

S - return-type

Parameters:

input - the input to process

context - the initialization context

operation - the operation to perform

Throws:

OperationFailedException - if the operation fails

processInput

public <S> S processInput(InitializationContext context,
 SharedObjects sharedObjects,
 Optional<Dictionary> dictionary,
 DefineOutputterWithEnergy.ProcessWithEnergyStack<ImageInitialization, S> operation)
                   throws OperationFailedException

Processes the input with an energy stack and shared objects.

Type Parameters:

S - return-type

Parameters:

context - the initialization context

sharedObjects - the shared objects

dictionary - an optional dictionary

operation - the operation to perform

Returns:

the result of the processing

Throws:

OperationFailedException - if the operation fails

getStackEnergy

public StackProvider getStackEnergy()

The stack provider for the energy stack.

setStackEnergy

public void setStackEnergy(StackProvider stackEnergy)

The stack provider for the energy stack.

getDictionary

public DictionaryProvider getDictionary()

An optional dictionary provider.

setDictionary

public void setDictionary(DictionaryProvider dictionary)

An optional dictionary provider.