com.goldencode.p2j.util

Class TargetLob

java.lang.Object

com.goldencode.p2j.util.LobCopyOutput

com.goldencode.p2j.util.TargetLob

All Implemented Interfaces:

LobCopyParameter

public class TargetLob
extends LobCopyOutput

Concrete implementation of a converted COPY-LOB target parameter, corresponding with the TO [ OBJECT ] target-lob phrase.

Field Summary

Fields

Modifier and Type	Field and Description
private FieldReference	field Field reference to LOB, if LOB is a record buffer field
private LargeObject	lob Large object which is the target of the copy operation
private NumberType	offset 1-based offset at which data will be written into the target large object
private boolean	trim If true, truncate any data remaining in the target, which was not overwritten

Fields inherited from interface com.goldencode.p2j.util.LobCopyParameter

TYPE_BLOB, TYPE_CHAR_BIT, TYPE_CLOB, TYPE_FIELD_BIT, TYPE_FILE, TYPE_LONGCHAR, TYPE_MEMPTR, TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
TargetLob(FieldReference field) Constructor which takes a field reference which must be a wrapper for a LargeObject.
TargetLob(LargeObject lob) Constructor.
TargetLob(java.lang.Object lob) Constructor which takes an object that is expected to be a LOB.

Method Summary

Modifier and Type	Method and Description
private boolean	checkTargetSize(int offset, int srcLength) Check the target size, and resize if it doesn't fit.
java.lang.String	getCodePage() Get the code page of this parameter, if any.
int	getObjectType() Obtain the type of the object wrapped by this parameter
private int	getOffset() Get the offset at which to overlay data in the target.
boolean	isCharacterData() Indicate whether the large object represented by this parameter natively represents encoded character data, as opposed to binary data.
boolean	isLargeObject() Indicate whether this object is a valid large object data type.
protected boolean	isOverlay() Check if the OVERLAY option is used.
TargetLob	offset(int offset) Set the starting offset at which to write content; corresponds with the OVERLAY AT option.
TargetLob	offset(NumberType offset) Set the starting offset at which to write content; corresponds with the OVERLAY AT option.
protected void	setOverrideLength(int newOverrideLength) Sets new value for longchar overridden length.
TargetLob	trim() Configure the copy operation to trim any data remaining in the target object which was not overwritten by the copy.
boolean	validate(int sourceType) Validate this parameter.
boolean	validateOffset(int sourceType) Checks if the optional offset is valid.
void	write(byte[] data) Write the given array of bytes into the large object.
void	write(java.lang.String data, java.lang.String oecp) Write the given character data into the large object.

Methods inherited from class java.lang.Object

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

Field Detail

lob

private final LargeObject lob

Large object which is the target of the copy operation

field

private final FieldReference field

Field reference to LOB, if LOB is a record buffer field

offset

private NumberType offset

1-based offset at which data will be written into the target large object

trim

private boolean trim

If true, truncate any data remaining in the target, which was not overwritten

Constructor Detail

TargetLob

public TargetLob(LargeObject lob)

Constructor.

Parameters:

lob - Large object which is the target of the copy operation.

TargetLob

public TargetLob(java.lang.Object lob)

Constructor which takes an object that is expected to be a LOB. Intended to handle the converted POLY case.

Parameters:

lob - Large object which is the target of the copy operation.

Throws:

ConditionException - if lob is not an instance of @LargeObject@.

TargetLob

public TargetLob(FieldReference field)

Constructor which takes a field reference which must be a wrapper for a LargeObject.

Parameters:

field - Field reference to a large object which is the source of the copy operation.

Method Detail

offset

public TargetLob offset(NumberType offset)

Set the starting offset at which to write content; corresponds with the OVERLAY AT option.

Parameters:

offset - 1-based starting offset.

Returns:

This object instance, to allow method chaining.

offset

public TargetLob offset(int offset)

Set the starting offset at which to write content; corresponds with the OVERLAY AT option.

Parameters:

offset - 1-based starting offset.

Returns:

This object instance, to allow method chaining.

trim

public TargetLob trim()

Configure the copy operation to trim any data remaining in the target object which was not overwritten by the copy.

Returns:

This object instance, to allow method chaining.

isLargeObject

public boolean isLargeObject()

Indicate whether this object is a valid large object data type. It is possible to pass a POLY which is not a valid LOB type as a COPY-LOB parameter, and this error must be determined at runtime.

Returns:

true if valid, else false. The default implementation assumes validity; implementors which must handle runtime type verification must override this method.

getObjectType

public int getObjectType()

Obtain the type of the object wrapped by this parameter

Returns:

The numerical id of a type declared as one of the TYPE static constants from LobCopyParameter interface.

isCharacterData

public boolean isCharacterData()

Indicate whether the large object represented by this parameter natively represents encoded character data, as opposed to binary data.

Returns:

true if character data; false if binary data.

getCodePage

public java.lang.String getCodePage()

Get the code page of this parameter, if any.

Returns:

4GL code page name or null if parameter represents non-character data.

validateOffset

public boolean validateOffset(int sourceType)

Checks if the optional offset is valid.

Parameters:

sourceType - The type of the source object. The error messages are different in some cases.

Returns:

true if the optional offset is valid.

validate

public boolean validate(int sourceType)

Validate this parameter. The following parameters are checked: offset,

Parameters:

sourceType - The type of the source object. The error messages are different in some cases.

Returns:

true if validation did not encounter any issue and false otherwise, when in NO-ERROR mode and the ErrorConditionException is not thrown.

Throws:

ErrorConditionException - if the parameter fails validation and silent error mode is not active.

write

public void write(byte[] data)

Write the given array of bytes into the large object.

Specified by:

write in class LobCopyOutput

Parameters:

data - Data to be assigned to this object.

write

public void write(java.lang.String data,
                  java.lang.String oecp)

Write the given character data into the large object.

Specified by:

write in class LobCopyOutput

Parameters:

data - Data to be assigned to this object.

oecp - Target OE codepage to be used in write operation. Ignored.

getOffset

private int getOffset()

Get the offset at which to overlay data in the target. If no explicit offset has been specified, return a value of 0.

Returns:

Zero-based target offset.

isOverlay

protected boolean isOverlay()

Check if the OVERLAY option is used.

Returns:

true of offset is non-null.

setOverrideLength

protected void setOverrideLength(int newOverrideLength)

Sets new value for longchar overridden length. Can be more than backend String variable and sets up in copy-lob operation in some conditions.

Parameters:

newOverrideLength - The new value of the internal longchar length.

checkTargetSize

private boolean checkTargetSize(int offset,
                                int srcLength)

Check the target size, and resize if it doesn't fit.

Parameters:

offset - The offset where to write in the target.

srcLength - The source length.

Returns:

true if the target passed validation.