org.teiid.modeshape.sequencer.internal

Class AbstractExporter.ResultImpl

java.lang.Object

org.teiid.modeshape.sequencer.internal.AbstractExporter.ResultImpl

All Implemented Interfaces:

Iterable<String>, Result

Enclosing class:

AbstractExporter

protected class AbstractExporter.ResultImpl
extends Object
implements Result

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPORTER The data key whose value is the class name of the exporter.
static String	OPTIONS The data key whose value are the options used by the exporter.
static String	OUTCOME The data key whose value is the results of the export.
static String	PATH_EXPORTED_NODE The data key whose value is the absolute path of the node being exported.
static String	TYPE The data key whose value is the type of the results.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResultImpl()
protected	ResultImpl(String pathOfExportedNode, Options options)

Method Summary

Modifier and Type	Method and Description
Object	getData(String key)
Exception	getError() An unsuccessful export may not have a caught exception.
String	getErrorMessage() If the export was not successful the error message will always have a value.
Options	getOptions()
Object	getOutcome()
Class<?>	getType()
Iterator<String>	iterator()
Object	setData(String key, Object value)
void	setError(String message, Exception error)
void	setOutcome(Object outcome, Class<?> outcomeType)
boolean	wasSuccessful()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EXPORTER

public static final String EXPORTER

The data key whose value is the class name of the exporter. Used only be the framework.

See Also:

Constant Field Values

OPTIONS

public static final String OPTIONS

The data key whose value are the options used by the exporter. Used only be the framework.

See Also:

Constant Field Values

OUTCOME

public static final String OUTCOME

The data key whose value is the results of the export. Value must be set by the exporter.

See Also:

setOutcome(Object, Class), Constant Field Values

PATH_EXPORTED_NODE

public static final String PATH_EXPORTED_NODE

The data key whose value is the absolute path of the node being exported. Used only be the framework.

See Also:

Constant Field Values

TYPE

public static final String TYPE

The data key whose value is the type of the results. Must be set by the exporter.

See Also:

Constant Field Values

Constructor Detail

ResultImpl

protected ResultImpl()

ResultImpl

protected ResultImpl(String pathOfExportedNode,
                     Options options)

Method Detail

getData

public Object getData(String key)

Specified by:

getData in interface Result

Parameters:

key - the type of data being requested (cannot be null)

Returns:

the information, with the specified type, relating to the operation results (never null)

See Also:

Result.getData(java.lang.String)

getError

public Exception getError()

An unsuccessful export may not have a caught exception.

Specified by:

getError in interface Result

Returns:

the error caught during the export operation (can be null)

See Also:

Result.getError()

getErrorMessage

public String getErrorMessage()

If the export was not successful the error message will always have a value.

Specified by:

getErrorMessage in interface Result

Returns:

the error message (null when export was successful )

See Also:

Result.getErrorMessage()

getOptions

public Options getOptions()

Specified by:

getOptions in interface Result

Returns:

the options used during the export (never null but can be empty if all default values were used)

See Also:

Result.getOptions()

getOutcome

public Object getOutcome()

Specified by:

getOutcome in interface Result

Returns:

the results returned by the operation (can be null)

See Also:

Result.getOutcome()

getType

public Class<?> getType()

Specified by:

getType in interface Result

Returns:

the type returned by the Result.getOutcome() method (will be null until outcome is set)

See Also:

Result.getType()

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

See Also:

Iterable.iterator()

setData

public Object setData(String key,
                      Object value)

Parameters:

key - the data key (cannot be null or empty)

value - the data value (can be null if removing current data)

Returns:

the previous value (can be null)

setError

public void setError(String message,
                     Exception error)

Parameters:

message - the error message (can be null or empty)

error - the error (can be null)

setOutcome

public void setOutcome(Object outcome,
                       Class<?> outcomeType)

Parameters:

outcome - the outcome of the export (cannot be null)

outcomeType - the type of the outcome (cannot be null)

wasSuccessful

public boolean wasSuccessful()

Specified by:

wasSuccessful in interface Result

Returns:

true if there is no error and no error message

See Also:

Result.wasSuccessful()