com.goldencode.p2j.persist

Class TargetData

java.lang.Object

com.goldencode.p2j.persist.TargetData

All Implemented Interfaces:

Serializator, java.io.Closeable, java.lang.AutoCloseable

public class TargetData
extends java.lang.Object
implements Serializator

Object which describes an external target into which data is written from a temp-table buffer or data set member buffer.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	fileName The file name if such destination was created.
private boolean	isStream Test whether the target object is a stream or a handle to a stream.
private BaseDataType	origDst The original destination of the operation.
private java.lang.String	origType The type of original destination of the operation.
private java.io.OutputStream	stream Normalized output stream
private static java.util.Map<java.lang.String,java.lang.Integer>	supportedStreams
static java.lang.String	TD_SERIALIZE_ROW Constant used to identify the calls from SERIALIZE-ROW method.
static java.lang.String	TD_WRITE_JSON Constant used to identify the calls from WRITE-JSON method.
static java.lang.String	TD_WRITE_XML Constant used to identify the calls from WRITE-XML method.
static java.lang.String	TD_WRITE_XMLSCHEMA Constant used to identify the calls from WRITE-XMLSCHEMA method.

Fields inherited from interface com.goldencode.p2j.persist.serial.Serializator

SER_FILE, SER_HANDLE, SER_JSON_ARRAY, SER_JSON_OBJECT, SER_LONGCHAR, SER_MEMPTR, SER_STREAM, SER_STREAM_HANDLE, TYPE_FILE, TYPE_HANDLE, TYPE_JSON_ARRAY, TYPE_JSON_OBJECT, TYPE_LONGCHAR, TYPE_MEMPTR, TYPE_STREAM, TYPE_STREAM_HANDLE

Constructor Summary

Constructors

Constructor and Description
TargetData(character type, BaseDataType target) The constructor saves the configured parameters but does not process them in any way.
TargetData(java.lang.String type, BaseDataType target) The constructor saves the configured parameters but does not process them in any way.
TargetData(java.lang.String type, java.lang.String target) The constructor saves the configured parameters but does not process them in any way.

Method Summary

Modifier and Type	Method and Description
void	close() Close the output stream underlying this data source.
boolean	configureSupportedTargets(java.lang.String method, java.lang.String format, java.lang.String widgetType) Configures the supported resource types for the current usage.
java.lang.Object	getDestination() Obtain the original destination of the operation.
java.io.OutputStream	getStream() Get the output stream representing the target resource to which data will be written.
java.lang.String	getType() Obtain the original type of the stream.
boolean	isJson() Checks if the target of this operation is a Json or Json Array object.
boolean	isStream() Checks if the target of this operation is a STREAM-type object.

Methods inherited from class java.lang.Object

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

Field Detail

stream

private java.io.OutputStream stream

Normalized output stream

fileName

private java.lang.String fileName

The file name if such destination was created.

TD_WRITE_XML

public static final java.lang.String TD_WRITE_XML

Constant used to identify the calls from WRITE-XML method. Also used to store the supported stream types for this method.

See Also:

Constant Field Values

TD_WRITE_XMLSCHEMA

public static final java.lang.String TD_WRITE_XMLSCHEMA

Constant used to identify the calls from WRITE-XMLSCHEMA method. Also used to store the supported stream types for this method.

See Also:

Constant Field Values

TD_WRITE_JSON

public static final java.lang.String TD_WRITE_JSON

Constant used to identify the calls from WRITE-JSON method. Also used to store the supported stream types for this method.

See Also:

Constant Field Values

TD_SERIALIZE_ROW

public static final java.lang.String TD_SERIALIZE_ROW

Constant used to identify the calls from SERIALIZE-ROW method. Also used to store the supported stream types for this method.

See Also:

Constant Field Values

supportedStreams

private static final java.util.Map<java.lang.String,java.lang.Integer> supportedStreams

origType

private final java.lang.String origType

The type of original destination of the operation.

origDst

private final BaseDataType origDst

The original destination of the operation.

isStream

private boolean isStream

Test whether the target object is a stream or a handle to a stream. U

Constructor Detail

TargetData

public TargetData(character type,
                  BaseDataType target)

The constructor saves the configured parameters but does not process them in any way. The validation will be executed later, when the calling method is in progress.

Parameters:

type - The source stream type.

target - The reference to resource or the file name.

TargetData

public TargetData(java.lang.String type,
                  BaseDataType target)

The constructor saves the configured parameters but does not process them in any way. The validation will be executed later, when the calling method is in progress.

Parameters:

type - The source stream type.

target - The reference to resource or the file name.

TargetData

public TargetData(java.lang.String type,
                  java.lang.String target)

The constructor saves the configured parameters but does not process them in any way. The validation will be executed later, when the calling method is in progress.

Parameters:

type - The source stream type.

target - The file name.

Method Detail

configureSupportedTargets

public boolean configureSupportedTargets(java.lang.String method,
                                         java.lang.String format,
                                         java.lang.String widgetType)

Configures the supported resource types for the current usage. The caller passes in its name and the method does the selection. It also does the verification whether the already configured parameters (in the constructor) are valid and eventual raise the error condition.

Parameters:

method - The identifier for the method using the source stream. It is used to get the set of acceptable stream types to check against them.

widgetType - The parent widget. Only used for composing the error messages.

Returns:

true if the parameters configured in constructor seems correct. This method does not check the content, only the variable types. If there is not a match with the possible streams supported by the method, false is returned, after eventually raising a specific error condition.

getStream

public java.io.OutputStream getStream()

Get the output stream representing the target resource to which data will be written. This may be a remote or a local resource.

Specified by:

getStream in interface Serializator

Returns:

Output stream.

close

public void close()
           throws java.io.IOException

Close the output stream underlying this data source.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if there is an error closing the stream.

isJson

public boolean isJson()

Checks if the target of this operation is a Json or Json Array object.

Returns:

true if the target of this operation is a Json or Json Array object.

isStream

public boolean isStream()

Checks if the target of this operation is a STREAM-type object.

Returns:

true if the target of this operation is a STREAM-type object.

getDestination

public java.lang.Object getDestination()

Obtain the original destination of the operation.

Returns:

the original destination of the operation.

getType

public java.lang.String getType()

Obtain the original type of the stream.

Returns:

the type of the stream.