com.goldencode.p2j.util

Class clob

java.lang.Object

com.goldencode.p2j.util.LazyUndoable

com.goldencode.p2j.util.BaseDataType

com.goldencode.p2j.util.Text

com.goldencode.p2j.util.longchar

com.goldencode.p2j.util.clob

All Implemented Interfaces:

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

public class clob
extends longchar

Data wrapper type for SQL CLOB data.

See Also:

Serialized Form

Nested Class Summary

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 boolean	customCP Flags this field if it was constructed with a custom CODEPAGE specified in the field definition.
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 java.sql.Clob	sqlClob SQL CLOB object

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

caseSens, override, unknown, value

Constructor Summary

Constructors

Constructor and Description
clob() Default constructor.
clob(BaseDataType value) Constructor which initializes an instance from the given data.
clob(character value) Constructor which initializes an instance from the given data.
clob(clob value) Copy constructor.
clob(java.sql.Clob sqlClob) Constructor which is initialized from a database record.
clob(longchar value) Constructor which initializes an instance from the given data.
clob(java.lang.String value) Constructor which initializes an instance from the given data.
clob(java.lang.String value, java.lang.String codepage) Constructor which initializes an instance from the given data.

Method Summary

Modifier and Type	Method and Description
void	assign(longchar value) Assigns the value represented by value to this object.
void	assign(Text value) Assigns the value represented by value to this object.
clob	duplicate() Does the same as standard clone() method but returns an instance of BaseDataType and doesn't throw the CloneNotSupportedException.
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.
boolean	isCodePageFixed() Return the value codepage fixed status.
static logical	isColumnCodepage(BaseDataType value) Implementation of IS-COLUMN-CODEPAGE ABL function.
void	readData() Read data from the SQL CLOB used to initialize this object.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	setFieldReference(FieldReference fr) Sets the FieldReference reference.
java.lang.String	toStringExport() Creates a string representation of the instance data using the 'export' format.
void	write(boolean overlay, java.lang.String data, int offset, boolean trim) Write the given character data into the data managed by this object, overwriting the data that are at the given location, if any.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

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

_getCodePage, asByteArray, compareTo, defaultFormatString, fixCodePage, fixCodePage, fixCodePage, fixCodePage, fixCodePage, fixCodePage, fixCodePage, forceCharacterType, getCodePage, getCodePage, getCodePage, getSize, instantiateDefaultExtent, isCharacterData, isCodePageFixed, isEmbeddedNullAllowed, isIncompatibleTypesOnConversion, lengthInt, lengthOf, setOverrideLength, toString, toStringMessage

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

assign, assign, assign, assign, assign, caseSensitiveHashCode, deepAssign, equalsCaseSensitively, getValue, hashCode, isCaseSensitive, isUnknown, javaSpacifyNull, javaTruncateNull, maximum, minimum, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, progressSpacifyNull, readChar, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, replaceEntry, setCaseSensitive, setCaseSensitive, setTemporaryCaseSensitive, setUnknown, setValue, toJavaType

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

assign, assign, calcFormatLength, createProxy, createProxy, deepCopy, elementsOfType, equals, fallback, formatLength, fromTypeName, generateDefault, generateUnknown, getAssigner, getTypeName, incompatibleTypesOnConversion, initialize, initializeDefaultExtent, invalidInitializer, isAllKnown, isAllKnown, isAssignDirect, 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

binaryEquals, isUnknown, readBytes, readChars, write

Field Detail

sqlClob

private java.sql.Clob sqlClob

SQL CLOB object

fRef

private FieldReference fRef

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

customCP

private boolean customCP

Flags this field if it was constructed with a custom CODEPAGE specified in the field definition.

fieldName

private java.lang.String fieldName

The field name used with current field reference.

Constructor Detail

clob

public clob()

Default constructor.

clob

public clob(clob value)

Copy constructor.

Parameters:

value - Clob to be copied.

clob

public clob(java.sql.Clob sqlClob)
     throws java.sql.SQLException

Constructor which is initialized from a database record.

Parameters:

sqlClob - SQL CLOB from which data is read.

Throws:

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

clob

public clob(java.lang.String value)

Constructor which initializes an instance from the given data.

Parameters:

value - Data.

clob

public clob(java.lang.String value,
            java.lang.String codepage)

Constructor which initializes an instance from the given data.

Parameters:

value - Data.

codepage - The codepage.

clob

public clob(character value)

Constructor which initializes an instance from the given data.

Parameters:

value - Data.

clob

public clob(longchar value)

Constructor which initializes an instance from the given data.

Parameters:

value - Data.

clob

public clob(BaseDataType value)

Constructor which initializes an instance from the given data.

Parameters:

value - Data.

Method Detail

getType

public BaseDataType.Type getType()

Get the type.

Overrides:

getType in class longchar

Returns:

type.

readData

public void readData()
              throws java.sql.SQLException

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

Throws:

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

isCodePageFixed

public boolean isCodePageFixed()

Return the value codepage fixed status.

Overrides:

isCodePageFixed in class longchar

Returns:

Always true. The codepage for clob-s cannot be changed.

isColumnCodepage

public static logical isColumnCodepage(BaseDataType value)

Implementation of IS-COLUMN-CODEPAGE ABL function.

Parameters:

value - The data to be tested.

Returns:

YES only when value is a CLOB field defined with IS-COLUMN-CODEPAGE attribute.

duplicate

public clob duplicate()

Description copied from class: longchar

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

Overrides:

duplicate in class longchar

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.

Overrides:

instantiateUnknown in class longchar

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.

Overrides:

instantiateDefault in class longchar

Returns:

An instance that represents the default value.

write

public void write(boolean overlay,
                  java.lang.String data,
                  int offset,
                  boolean trim)

Write the given character 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 characters 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

Overrides:

write in class longchar

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. Ignored.

setFieldReference

public void setFieldReference(FieldReference fr)

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

Parameters:

fr - The source of this LOB.

getFieldReference

public FieldReference getFieldReference()

Obtain the FieldReference reference, if any.

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.

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 Text

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 Text

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.

assign

public void assign(Text value)

Assigns the value represented by value to this object. If needed (the source value has a different codepage), a codepage conversion is performed.

Overrides:

assign in class longchar

Parameters:

value - The source Text to be assigned.

assign

public void assign(longchar value)

Assigns the value represented by value to this object. Since all clob fields have a fixed codepage, a codepage conversion will occur.

Overrides:

assign in class longchar

Parameters:

value - The source longchar / clob to be assigned.

toStringExport

public java.lang.String toStringExport()

Creates a string representation of the instance data using the 'export' format. For the character data type the entire string is returned enclosed in a pair of double quotes. If the instance represents the unknown value, a '?' will be returned. Any instances of double quotes inside the string will be doubled up on output.

Overrides:

toStringExport in class longchar

Returns:

The 'export' formatted string.