Package com.chemaxon.calculations.cli

Class CalculatorPluginCachedResults

java.lang.Object

com.chemaxon.calculations.cli.CalculatorPluginCachedResults

All Implemented Interfaces:

CalculatorResultAccess

@PublicApi
public class CalculatorPluginCachedResults
extends Object
implements CalculatorResultAccess

Provides plugin cached results.

Since:

Marvin 5.2

Constructor Summary

Constructors

Constructor	Description
CalculatorPluginCachedResults(String header, String resultString, Molecule[] resultMols, Molecule resultMol, String resultMessage, String remark, Throwable throwable, boolean ok)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getHeader()	Returns the table header.
String	getRemark()	Returns the calculation remark.
String	getResult(Molecule target)	Returns the result string for the given molecule.
String	getResultMessage()	Returns the plugin calculation error message, error or warning.
Molecule	getResultMolecule(Molecule target)	Returns the decorated result molecule for the given target molecule.
Molecule[]	getResultMolecules(Molecule target)	Returns the result molecules for the given molecule.
Throwable	getThrowable()	Returns the throwable object.
boolean	isOK()	Returns true if the calculation has run without error.

Methods inherited from class java.lang.Object

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

Constructor Details

CalculatorPluginCachedResults

public CalculatorPluginCachedResults(String header,
 String resultString,
 Molecule[] resultMols,
 Molecule resultMol,
 String resultMessage,
 String remark,
 Throwable throwable,
 boolean ok)

Constructor.

Parameters:

header - the header string

resultString - the result string

resultMols - the result molecule array

resultMol - the result decorated molecule

resultMessage - the result warning or error mesage

throwable - the error

ok - true if the calculation has run without error

Method Details

getHeader

public String getHeader()

Returns the table header.

Specified by:

getHeader in interface CalculatorResultAccess

Returns:

the table header

getResult

public String getResult(Molecule target)
                 throws PluginException

Returns the result string for the given molecule.

Specified by:

getResult in interface CalculatorResultAccess

Parameters:

target - is the target molecule

Returns:

the result row

Throws:

PluginException - on error

getResultMolecules

public Molecule[] getResultMolecules(Molecule target)
                              throws PluginException

Returns the result molecules for the given molecule.

Specified by:

getResultMolecules in interface CalculatorResultAccess

Parameters:

target - is the target molecule

Returns:

the result molecules

Throws:

PluginException - on error

getResultMolecule

public Molecule getResultMolecule(Molecule target)
                           throws PluginException

Returns the decorated result molecule for the given target molecule. Used in case of MRV output (-M, --mrv-output).

Specified by:

getResultMolecule in interface CalculatorResultAccess

Parameters:

target - is the target molecule

Returns:

the result molecule

Throws:

PluginException - if on error

getResultMessage

public String getResultMessage()

Returns the plugin calculation error message, error or warning.

Specified by:

getResultMessage in interface CalculatorResultAccess

Returns:

the plugin calculation error message

getRemark

public String getRemark()

Returns the calculation remark.

Specified by:

getRemark in interface CalculatorResultAccess

Returns:

the calculation remark

getThrowable

public Throwable getThrowable()

Returns the throwable object.

Specified by:

getThrowable in interface CalculatorResultAccess

Returns:

the throwable object

isOK

public boolean isOK()

Returns true if the calculation has run without error.

Specified by:

isOK in interface CalculatorResultAccess

Returns:

true if the calculation has run without error