com.goldencode.p2j.util

Class blob

java.lang.Object

com.goldencode.p2j.util.LazyUndoable

com.goldencode.p2j.util.BaseDataType

com.goldencode.p2j.util.BinaryData

com.goldencode.p2j.util.blob

All Implemented Interfaces:

LargeObject, Undoable, java.io.Externalizable, java.io.Serializable, java.lang.Comparable

public class blob
extends BinaryData
implements LargeObject

Data wrapper type for SQL BLOB data.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.util.BinaryData

BinaryData.RangeCheck

Nested classes/interfaces inherited from class com.goldencode.p2j.util.BaseDataType

BaseDataType.Type, BaseDataType.WrapperHandler

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	fieldName The field name used with current field reference.
private FieldReference	fRef The parent buffer field where this object was obtained by dereferenciation, if this is the case.
private static int	MAX_SIZE Maximum size of the blob
private java.sql.Blob	sqlBlob SQL BLOB object
private byte[]	value Backing data

Fields inherited from class com.goldencode.p2j.util.BinaryData

unknown

Constructor Summary

Constructors

Constructor and Description
blob() Default constructor.
blob(BaseDataType value) Constructor which initializes an instance from a POLY value.
blob(blob value) Copy constructor.
blob(java.sql.Blob sqlBlob) Constructor which is initialized from a database record.
blob(byte[] value) Constructor which initializes an instance from the given data.
blob(memptr value) Constructor which initializes an instance from a memptr object.
blob(raw value) Constructor which initializes an instance from a raw object.
blob(java.lang.String def) Constructor used for creating initial field from default String.

Method Summary

Modifier and Type	Method and Description
protected byte[]	asByteArray() Return the entire contents of the current buffer as an array.
byte[]	asByteArray(long pos, long len) Return all or some of the contents of the current buffer as an array.
void	assign(blob value) Assigns a blob value.
protected void	deallocate() Release any resources associated with the instance.
blob	duplicate() Does the same as standard clone() method but returns an instance of BaseDataType and doesn't throw the CloneNotSupportedException.
protected void	extendBytes(long len) Helper to create a new byte array with the same contents as the given byte array and the specified length.
protected long	findNextNull(long pos) Returns the next index position into the array which is the null byte, starting at a given index position.
java.lang.String	getFieldName() Gets the filed name associated with current FieldReference reference, if any.
FieldReference	getFieldReference() Obtain the FieldReference reference, if any.
BaseDataType.Type	getType() Get the type
BaseDataType	instantiateDefault() Creates a new instance of the same type that represents the default initialized value.
BaseDataType	instantiateUnknown() Creates a new instance of the same type that represents the unknown value.
protected long	internalLength() The actual size of the buffer (in bytes).
protected boolean	isAutoExtend() Determines if the array of binary data stored in an instance of this class must be automatically extended in length when operations write past the current length.
boolean	isCharacterData() Indicate whether this object manages character data (as opposed to binary data).
protected boolean	isLengthLimited() Determines if the array of binary data stored in an instance of this class must be limited in length.
boolean	isUninitialized() Reports if this instance represents an uninitialized buffer.
protected long	lengthLimit() Determines the maximum length of the array of binary data stored in an instance of this class.
protected byte	readByte(long pos) Read the byte at the given location.
protected byte[]	readByteRange(long pos, long len, boolean endian) Read the bytes at the given location.
void	readData() Read data from the SQL BLOB used to initialize this object.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
protected void	replaceContents(byte[] value) Replace the entire contents of the current buffer with the given array.
void	setFieldReference(FieldReference fr) Sets the FieldReference reference.
BinaryData	setLength(long len) Sets the length of the buffer/array to a given length.
java.lang.String	toString(java.lang.String fmt) The function STRING(blob-value, format) always generates error 11382 in OE.
java.lang.String	toStringExport() Creates a string representation of the instance data using the 'export' format.
java.lang.String	toStringMessage() Creates a string representation of the instance data in a form that is compatible with the MESSAGE language statement.
protected long	visibleLength() The length of the buffer as reported to P4GL application.
void	write(boolean overlay, byte[] data, int offset, boolean trim) Write the given byte data into the data managed by this object, overwriting the data that are at the given location, if any.
protected void	writeByte(byte val, long pos) Write the byte into the given location.
protected void	writeByteRange(byte[] data, long pos, long len, boolean endian) Write the bytes at the given location.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class com.goldencode.p2j.util.BinaryData

assign, assign, assign, assign, clearUnknown, compareTo, defaultFormatString, genIndexError, genLimitedLengthError, genUninitializedError, getByte, getByte, getByteArray, getBytes, getBytes, getBytes, getBytes, getDouble, getDouble, getFloat, getFloat, getInt64, getInt64, getLong, getLong, getShort, getShort, getString, getString, getString, getString, getString, getString, getUnprocessedDouble, getUnsignedLong, getUnsignedLong, getUnsignedShort, getUnsignedShort, hashCode, isUnknown, length, length, lengthOf, reverseBytes, setByte, setByte, setByte, setByte, setBytes, setBytes, setBytes, setDouble, setDouble, setDouble, setDouble, setFloat, setFloat, setFloat, setFloat, setInt64, setInt64, setInt64, setInt64, setLength, setLength, setLong, setLong, setLong, setLong, setShort, setShort, setShort, setShort, setString, setString, setString, setString, setString, setString, setString, setString, setString, setString, setString, setString, setString, setUnknown, setUnsignedLong, setUnsignedLong, setUnsignedLong, setUnsignedLong, setUnsignedShort, setUnsignedShort, setUnsignedShort, setUnsignedShort

Methods inherited from class com.goldencode.p2j.util.BaseDataType

assign, assign, calcFormatLength, createProxy, createProxy, deepCopy, elementsOfType, equals, fallback, formatLength, fromTypeName, generateDefault, generateUnknown, getAssigner, getSize, getTypeName, incompatibleTypesOnConversion, initialize, initializeDefaultExtent, instantiateDefaultExtent, invalidInitializer, isAllKnown, isAllKnown, isAssignDirect, isIncompatibleTypesOnConversion, isProxy, isUnknownValue, maximum, minimum, notUnknownValue, sameType, val, variable

Methods inherited from class com.goldencode.p2j.util.LazyUndoable

changed, checkUndoable, checkUndoable, checkUndoable, getTransLevel, isGlobal, isUndoable, markUndoable, popBlock, rollback, setGlobal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.LargeObject

_getCodePage, binaryEquals, isUnknown, lengthOf, readBytes, readChars, write

Field Detail

MAX_SIZE

private static final int MAX_SIZE

Maximum size of the blob

See Also:

Constant Field Values

value

private byte[] value

Backing data

sqlBlob

private java.sql.Blob sqlBlob

SQL BLOB object

fRef

private FieldReference fRef

The parent buffer field where this object was obtained by dereferenciation, if this is the case.

fieldName

private java.lang.String fieldName

The field name used with current field reference.

Constructor Detail

blob

public blob()

Default constructor.

blob

public blob(java.lang.String def)

Constructor used for creating initial field from default String.

Parameters:

def - default value

blob

public blob(blob value)

Copy constructor.

Parameters:

value - Blob to be copied.

blob

public blob(java.sql.Blob sqlBlob)
     throws java.sql.SQLException

Constructor which is initialized from a database record.

Parameters:

sqlBlob - SQL BLOB from which data is read.

Throws:

java.sql.SQLException - if there is an error reading data.

blob

public blob(byte[] value)

Constructor which initializes an instance from the given data.

Parameters:

value - Data.

blob

public blob(memptr value)

Constructor which initializes an instance from a memptr object.

Parameters:

value - Pointer from which data is copied.

blob

public blob(raw value)

Constructor which initializes an instance from a raw object.

Parameters:

value - Raw object from which data is copied.

blob

public blob(BaseDataType value)

Constructor which initializes an instance from a POLY value.

Parameters:

value - POLY value from which data is copied.

Method Detail

getType

public BaseDataType.Type getType()

Get the type

Specified by:

getType in class BaseDataType

Returns:

type

readData

public void readData()
              throws java.sql.SQLException

Read data from the SQL BLOB used to initialize this object.

Throws:

java.sql.SQLException - if there is an error reading data.

isCharacterData

public boolean isCharacterData()

Indicate whether this object manages character data (as opposed to binary data).

Specified by:

isCharacterData in interface LargeObject

Returns:

false.

setLength

public BinaryData setLength(long len)

Sets the length of the buffer/array to a given length. Depending on the sub-class, this may result in the allocation of memory, or the extending/truncating of the backing array. It is up to the sub-class to determine if an already allocated buffer/array will be resized.

This implementation is a no-op.

Specified by:

setLength in class BinaryData

Parameters:

len - New length of the buffer/array.

Returns:

The current instance is returned.

isUninitialized

public boolean isUninitialized()

Reports if this instance represents an uninitialized buffer. Being uninitialized is not the same as being of zero length. Rather it means that the buffer was never allocated. Being unknown is also different from being uninitialized.

Specified by:

isUninitialized in class BinaryData

Returns:

true if this instance is uninitialized.

duplicate

public blob duplicate()

Description copied from class: BaseDataType

Does the same as standard clone() method but returns an instance of BaseDataType and doesn't throw the CloneNotSupportedException.

Specified by:

duplicate in class BaseDataType

Returns:

This object.

See Also:

This class is not undoable, so return a reference to this object.

instantiateUnknown

public BaseDataType instantiateUnknown()

Creates a new instance of the same type that represents the unknown value.

Specified by:

instantiateUnknown in class BaseDataType

Returns:

An instance that represents the unknown value.

instantiateDefault

public BaseDataType instantiateDefault()

Creates a new instance of the same type that represents the default initialized value.

Specified by:

instantiateDefault in class BaseDataType

Returns:

An instance that represents the default value.

toString

public java.lang.String toString(java.lang.String fmt)

The function STRING(blob-value, format) always generates error 11382 in OE.

Specified by:

toString in class BaseDataType

Parameters:

fmt - The format string to use.

Returns:

The formatted string.

toStringMessage

public java.lang.String toStringMessage()

Creates a string representation of the instance data in a form that is compatible with the MESSAGE language statement. Regardless the instance represents the unknown value or not, a "?" character value will always be returned.

Specified by:

toStringMessage in interface LargeObject

Specified by:

toStringMessage in class BaseDataType

Returns:

The 'message' formatted string.

toStringExport

public java.lang.String toStringExport()

Creates a string representation of the instance data using the 'export' format. If the instance represents the unknown value, a '?' will be returned.

Specified by:

toStringExport in class BaseDataType

Returns:

The 'export' formatted string.

asByteArray

public byte[] asByteArray(long pos,
                          long len)

Return all or some of the contents of the current buffer as an array. This will be a copy of the data if the given parameters indicate a subset of the full data; otherwise, it will be the original, backing buffer.

Specified by:

asByteArray in interface LargeObject

Parameters:

pos - Starting offset position.

len - Length of range to return.

Returns:

The contents of the instance (possibly a copy). If the instance is uninitialized the returned value will be a 0 length array. If the instance is unknown or has an undefined size, then null will be returned.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class BinaryData

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class BinaryData

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

deallocate

protected void deallocate()

Release any resources associated with the instance.

Specified by:

deallocate in class BinaryData

isLengthLimited

protected boolean isLengthLimited()

Determines if the array of binary data stored in an instance of this class must be limited in length.

Specified by:

isLengthLimited in class BinaryData

Returns:

true if the length must be limited.

lengthLimit

protected long lengthLimit()

Determines the maximum length of the array of binary data stored in an instance of this class.

Specified by:

lengthLimit in class BinaryData

Returns:

The length limit for binary data or 0 if this class has no limit.

isAutoExtend

protected boolean isAutoExtend()

Determines if the array of binary data stored in an instance of this class must be automatically extended in length when operations write past the current length. Such extensions will pad with null bytes.

Specified by:

isAutoExtend in class BinaryData

Returns:

true if the length must automatically extended.

extendBytes

protected void extendBytes(long len)

Helper to create a new byte array with the same contents as the given byte array and the specified length. If the given target length is smaller than the source array length, the output array is truncated to the specified size. If the target length is larger than the source array length, the output array is extended to the given size and any additional bytes are initialized to '\0'.

This is safe to use on 0 length arrays.

This implementation is a no-op.

Specified by:

extendBytes in class BinaryData

Parameters:

len - The output array length.

replaceContents

protected void replaceContents(byte[] value)

Replace the entire contents of the current buffer with the given array.

Specified by:

replaceContents in class BinaryData

Parameters:

value - The new contents.

asByteArray

protected byte[] asByteArray()

Return the entire contents of the current buffer as an array. This may be a copy of the data, depending on the subclass' implementation. DO NOT MODIFY the data that is returned, since it is undefined as to whether the changes will or will not be reflected in the actual storage.

Specified by:

asByteArray in class BinaryData

Returns:

The contents of the instance (possibly a copy). If the instance is uninitialized the returned value will be a 0 length array. If the instance is unknown, then null will be returned.

internalLength

protected long internalLength()

The actual size of the buffer (in bytes).

Specified by:

internalLength in class BinaryData

Returns:

The length or 0 if uninitialized.

visibleLength

protected long visibleLength()

The length of the buffer as reported to P4GL application.

Specified by:

visibleLength in class BinaryData

Returns:

The length or 0 if uninitialized.

findNextNull

protected long findNextNull(long pos)

Returns the next index position into the array which is the null byte, starting at a given index position.

This implementation is a no-op.

Specified by:

findNextNull in class BinaryData

Parameters:

pos - The 0-based index into the array at which to start searching.

Returns:

The next index into the array which is the null byte or the length of the array if no null byte exists. This implementation always returns 0.

readByte

protected byte readByte(long pos)

Read the byte at the given location. All boundary checking and error handling must have already been done in the caller such that this is known to be a valid access. Any unexpected failure may cause a platform-specific exception that terminates the process!

Specified by:

readByte in class BinaryData

Parameters:

pos - The 0-based index position at which to read the byte.

Returns:

The byte at that location.

writeByte

protected void writeByte(byte val,
                         long pos)

Write the byte into the given location. All boundary checking and error handling must have already been done in the caller such that this is known to be a valid access. Any unexpected failure may cause a platform-specific exception that terminates the process!

Specified by:

writeByte in class BinaryData

Parameters:

val - The byte to write.

pos - The 0-based index position at which to read the byte.

readByteRange

protected byte[] readByteRange(long pos,
                               long len,
                               boolean endian)

Read the bytes at the given location. All boundary checking and error handling must have already been done in the caller such that this is known to be a valid access. Any unexpected failure may cause a platform-specific exception that terminates the process!

Specified by:

readByteRange in class BinaryData

Parameters:

pos - The 0-based index position at which to read the bytes.

len - The number of bytes to read.

endian - true to force the returned data to be ordered by the endian-ness of the instance.

Returns:

The byte range at that location.

writeByteRange

protected void writeByteRange(byte[] data,
                              long pos,
                              long len,
                              boolean endian)

Write the bytes at the given location. All boundary checking and error handling must have already been done in the caller such that this is known to be a valid access. Any unexpected failure may cause a platform-specific exception that terminates the process!

This implementation is a no-op.

Specified by:

writeByteRange in class BinaryData

Parameters:

data - The bytes to write.

pos - The 0-based index position at which to start writing the bytes.

len - How many bytes should be written. -1 means write everything to the end of the array.

endian - true to honor the endian-ness of the instance. The data array MUST be ordered in little-endian order if the endian flag is on.

write

public void write(boolean overlay,
                  byte[] data,
                  int offset,
                  boolean trim)

Write the given byte data into the data managed by this object, overwriting the data that are at the given location, if any.

This implementation:

• honors the trim option (i.e., any existing bytes beyond the end of the write are left in place if trim is false or truncated if trim is true);
• extends the target size if the write goes past the end of the existing value.

Specified by:

write in interface LargeObject

Parameters:

overlay - Flag indicating if the OVERLAY option is used.

data - Data to be assigned to this object.

offset - Offset position (in characters) in the target large object.

trim - true to truncate any remaining data in the target large object; false to leave remaining data alone.

assign

public void assign(blob value)

Assigns a blob value.

Parameters:

value - Value to assign.

setFieldReference

public void setFieldReference(FieldReference fr)

Sets the FieldReference reference. This is only used when the object is obtained by a dereferenciation (::) operation.

Specified by:

setFieldReference in interface LargeObject

Parameters:

fr - The source of this LOB.

getFieldReference

public FieldReference getFieldReference()

Obtain the FieldReference reference, if any.

Specified by:

getFieldReference in interface LargeObject

Returns:

The parent FieldReference from which this LOB was obtained by dereferenciation.

getFieldName

public java.lang.String getFieldName()

Gets the filed name associated with current FieldReference reference, if any.

Returns:

The field name to be used in LOB file name creation.