longchar (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.LazyUndoable
- - com.goldencode.p2j.util.BaseDataType
  - - com.goldencode.p2j.util.Text
    - - com.goldencode.p2j.util.longchar

All Implemented Interfaces:

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

Direct Known Subclasses:

clob
```
public class longchar
extends Text
implements LargeObject
```
A class that represents a Progress 4GL compatible longchar object whose data is mutable.
Although Progress documentation states that the default value of any longchar variable is the unknown value, the real behavior is that it gets initialized to the empty string, same as character variables get initialized.

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 java.lang.String`	`codePage` Variable to store code page value set by FIX-CODEPAGE statement.
`private boolean`	`fixedCodepage` Variable to store if code page value was set by FIX-CODEPAGE statement.
`private int`	`overrideLength` The override value for variable length.

Fields inherited from class com.goldencode.p2j.util.Text
caseSens, override, unknown, value

Constructor Summary

Constructors
Constructor and Description
`longchar()` Default constructor, creates an instance that represents the unknown value.
`longchar(BaseDataType value)` This is a special c'tor which should be used only when converting the value returned by a function or method with polymorphic return type into the expected type (i.e.
`longchar(char ch)` Constructs an instance that has a `char` value passed in and which does not represent the `unknown value`.
`longchar(java.lang.String value)` Constructs an instance that has the `String` value passed in and which does not represent the `unknown value`, unless the `value` argument is `null`.
`longchar(java.lang.String value, boolean caseSens)` Constructs an instance that has the `String` value passed in and which does not represent the `unknown value` unless the `value` argument is `null`.
`longchar(Text value)` Create a new instance, by copying the state of the passed `Text`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`_getCodePage()` Returns the code page of a the current longchar variable.
`byte[]`	`asByteArray(long pos, long len)` Return the entire contents of the current buffer as an array.
`void`	`assign(longchar value)` Assigns the value represented by `value` to this object.
`void`	`assign(Text value)` Sets the state (data and unknown value) of this instance based on the state of the passed instance.
`int`	`compareTo(java.lang.Object obj)` Compares this instance with the specified instance and returns a -1 if this instance is less than the specified, 0 if the two instances are equal and 1 if this instance is greater than the specified instance.
`java.lang.String`	`defaultFormatString()` Return the default display format string for this type.
`longchar`	`duplicate()` Does the same as standard `clone()` method but returns an instance of `BaseDataType` and doesn't throw the `CloneNotSupportedException`.
`static void`	`fixCodePage(BaseDataType value, BaseDataType cpToUse)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`static void`	`fixCodePage(BaseDataType value, java.lang.String cpToUse)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`void`	`fixCodePage(character cpToUse)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`static longchar`	`fixCodePage(longchar longcharRef, java.lang.String cpToUse)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`static longchar`	`fixCodePage(longchar longcharRef, java.lang.String cpToUse, boolean prepareClob)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`static void`	`fixCodePage(longchar longcharRef, Text cpToUse)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`void`	`fixCodePage(java.lang.String cpToUse)` Implements Progress 4GL feature for FIX-CODEPAGE statement.
`static character`	`forceCharacterType(longchar val)` Force the longchar value as a character type, without limit length enforcement.
`character`	`getCodePage()` Returns the code page of a the current longchar variable.
`static character`	`getCodePage(BaseDataType value)` Returns the code page of a the specified longchar variable.
`static character`	`getCodePage(longchar value)` Returns the code page of a the specified longchar variable.
`int`	`getSize()` Obtain the length (in bytes) of this BDT will use when serialized.
`BaseDataType.Type`	`getType()` Get the type
`BaseDataType`	`instantiateDefault()` Creates a new instance of the same type that represents the default initialized value.
`protected BaseDataType`	`instantiateDefaultExtent()` Get the default initialization for an extent variable of this type.
`BaseDataType`	`instantiateUnknown()` Creates a new instance of the same type that represents the `unknown value`.
`boolean`	`isCharacterData()` Indicate whether this object manages character data (as opposed to binary data).
`boolean`	`isCodePageFixed()` Return the value codepage fixed status.
`static logical`	`isCodePageFixed(longchar value)` Return `true` if the codepage of the given longchar variable is fixed.
`boolean`	`isEmbeddedNullAllowed()` Report if existing instances that have embedded null characters are allowed to be assigned to this instance.
`protected boolean`	`isIncompatibleTypesOnConversion(BaseDataType value)` Assigns the value represented by `value` to this object.
`protected int`	`lengthInt()` Returns the length of the current Text object instance in chars.
`long`	`lengthOf()` The length of the data managed by this object.
`protected void`	`setOverrideLength(int newOverrideLength)` Sets new value for longchar overridden length.
`java.lang.String`	`toString(java.lang.String fmt)` Creates a string representation of the instance data using the user- specified Progress 4GL format string.
`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.
`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.

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, readExternal, 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, writeExternal

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, getFieldReference, isUnknown, readBytes, readChars, setFieldReference, write

- Field Detail
  - codePage
```
private java.lang.String codePage
```
    Variable to store code page value set by FIX-CODEPAGE statement.
  - fixedCodepage
```
private boolean fixedCodepage
```
    Variable to store if code page value was set by FIX-CODEPAGE statement. IS-CODEPAGE-FIXED will relay on this
  - overrideLength
```
private int overrideLength
```
    The override value for variable length. Can be changed in copy-lob operration if target is longchar and source is memptr.
- Constructor Detail
  - longchar
```
public longchar()
```
    Default constructor, creates an instance that represents the unknown value.
  - longchar
```
public longchar(BaseDataType value)
```
    This is a special c'tor which should be used only when converting the value returned by a function or method with polymorphic return type into the expected type (i.e. DYNAMIC-FUNCTION()). In such cases, the 4GL does some automatic type conversion (this is delegated to the superclass' constructor).
    Only Text (character or longchar) BDT's can be converted to longchar.
    
    Parameters:
    
    value - The value to be used for this instance.
  - longchar
```
public longchar(java.lang.String value)
```
    Constructs an instance that has the String value passed in and which does not represent the unknown value, unless the value argument is null. If value is not "" then codepage is cpinternal
    
    Parameters:
    
    value - The character value of the resulting instance.
  - longchar
```
public longchar(java.lang.String value,
                boolean caseSens)
```
    Constructs an instance that has the String value passed in and which does not represent the unknown value unless the value argument is null.
    
    Parameters:
    
    value - The character value of the resulting instance.
    
    caseSens - Specifies whether this instance should use case sensitive comparisons.
  - longchar
```
public longchar(char ch)
```
    Constructs an instance that has a char value passed in and which does not represent the unknown value.
    
    Parameters:
    
    ch - The character value of the resulting instance.
  - longchar
```
public longchar(Text value)
```
    Create a new instance, by copying the state of the passed Text.
    
    Parameters:
    
    value - The value which needs to be copied.
- Method Detail
  - forceCharacterType
```
public static character forceCharacterType(longchar val)
```
    Force the longchar value as a character type, without limit length enforcement.
    
    Parameters:
    
    val - The value to convert.
    
    Returns:
    
    The new character value, with character.forceLengthLimit() disabled.
  - getType
```
public BaseDataType.Type getType()
```
    Get the type
    
    Specified by:
    
    getType in class BaseDataType
    
    Returns:
    
    type
  - isEmbeddedNullAllowed
```
public boolean isEmbeddedNullAllowed()
```
    Report if existing instances that have embedded null characters are allowed to be assigned to this instance.
    
    Overrides:
    
    isEmbeddedNullAllowed in class Text
    
    Returns:
    
    Always false.
  - compareTo
```
public int compareTo(java.lang.Object obj)
```
    Compares this instance with the specified instance and returns a -1 if this instance is less than the specified, 0 if the two instances are equal and 1 if this instance is greater than the specified instance. This is the implementation of the Comparable interface.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Overrides:
    
    compareTo in class Text
    
    Parameters:
    
    obj - The instance to compare against.
    
    Returns:
    
    -1, 0 or 1 depending on if this instance is less than, equal to or greater (respectively) than the specified instance obj.
  - getCodePage
```
public static character getCodePage(longchar value)
```
    Returns the code page of a the specified longchar variable. If the specified LONGCHAR is empty and the code page was not fixed using the FIX-CODEPAGE statement, must return the unknown value.
    
    Parameters:
    
    value - The value for which the codepage will be retrieved.
    
    Returns:
    
    See above
  - getCodePage
```
public static character getCodePage(BaseDataType value)
```
    Returns the code page of a the specified longchar variable. If the specified LONGCHAR is empty and the code page was not fixed using the FIX-CODEPAGE statement, must return the unknown value.
    
    Parameters:
    
    value - The value for which the codepage will be retrieved.
    
    Returns:
    
    See above
  - getCodePage
```
public character getCodePage()
```
    Returns the code page of a the current longchar variable. If the LONGCHAR is unknown or empty and the code page was not fixed using the FIX-CODEPAGE statement, the unknown value is returned.
    
    Returns:
    
    See above
  - _getCodePage
```
public java.lang.String _getCodePage()
```
    Returns the code page of a the current longchar variable. If the LONGCHAR is unknown or empty and the code page was not fixed using the FIX-CODEPAGE statement, the unknown value is returned.
    This is the String returning value, the unknown value is represented by null.
    
    Specified by:
    
    _getCodePage in interface LargeObject
    
    Returns:
    
    See above
  - instantiateUnknown
```
public BaseDataType instantiateUnknown()
```
    Creates a new instance of the same type that represents the unknown value.
    
    Overrides:
    
    instantiateUnknown in class Text
    
    Returns:
    
    An instance that represents the unknown value.
  - isCodePageFixed
```
public static logical isCodePageFixed(longchar value)
```
    Return true if the codepage of the given longchar variable is fixed.
    
    Parameters:
    
    value - The value for which the codepage will be retrieved.
    
    Returns:
    
    See above.
  - fixCodePage
```
public static longchar fixCodePage(longchar longcharRef,
                                   java.lang.String cpToUse)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement.
    
    Parameters:
    
    longcharRef - A reference to a longchar variable.
    
    cpToUse - The new value for codepage to be fixed.
    
    Returns:
    
    The longchar reference.
  - fixCodePage
```
public static longchar fixCodePage(longchar longcharRef,
                                   java.lang.String cpToUse,
                                   boolean prepareClob)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement.
    Note: actually this method should be as less visible as possible, preferably private. However, it must be accessed from FieldReference.
    
    Parameters:
    
    longcharRef - A reference to a longchar variable.
    
    cpToUse - The new value for codepage to be fixed. If prepareClob is true, this parameter must NOT be null.
    
    prepareClob - Allow to set a FIXED the CODEPAGE on target longcharRef only if it is a field (hence a clob) only when this parameter is true. Otherwise the procedure is finished. At least this is behaviour in 4GL: ERROR-STATUS:ERROR = YES ERROR-STATUS:GET-NUMBER(1) = 0. ERROR-STATUS:get-message(1) = "".
    
    Returns:
    
    The longchar reference.
  - fixCodePage
```
public static void fixCodePage(longchar longcharRef,
                               Text cpToUse)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement.
    
    Parameters:
    
    longcharRef - A reference to a longchar variable.
    
    cpToUse - The new value for codepage to be fixed.
  - fixCodePage
```
public static void fixCodePage(BaseDataType value,
                               java.lang.String cpToUse)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement. This variant is used when the first argument is obtained by dereferenciation.
    
    Parameters:
    
    value - A reference to a BDT, obtained by dereferenciation.
    
    cpToUse - The new value for codepage to be fixed.
  - fixCodePage
```
public static void fixCodePage(BaseDataType value,
                               BaseDataType cpToUse)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement. This variant is used when either of the arguments or both are obtained by dereferenciation.
    
    Parameters:
    
    value - A reference to a BDT, obtained by dereferenciation.
    
    cpToUse - The new value for codepage to be fixed.
  - fixCodePage
```
public void fixCodePage(java.lang.String cpToUse)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement.
    
    Parameters:
    
    cpToUse - The new value for codepage to be fixed.
  - fixCodePage
```
public void fixCodePage(character cpToUse)
```
    Implements Progress 4GL feature for FIX-CODEPAGE statement.
    
    Parameters:
    
    cpToUse - The new value for codepage to be fixed.
  - isCodePageFixed
```
public boolean isCodePageFixed()
```
    Return the value codepage fixed status.
    
    Returns:
    
    TRUE is codepage was fixed for this variable, FALSE otherwise.
  - defaultFormatString
```
public java.lang.String defaultFormatString()
```
    Return the default display format string for this type.
    
    Specified by:
    
    defaultFormatString in class BaseDataType
    
    Returns:
    
    The default format string.
  - duplicate
```
public longchar duplicate()
```
    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:
    
    A clone of this instance.
  - 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. If the instance represents the unknown value, a '?' will 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. 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.
    
    Specified by:
    
    toStringExport in class BaseDataType
    
    Returns:
    
    The 'export' formatted string.
  - toString
```
public java.lang.String toString(java.lang.String fmt)
```
    Creates a string representation of the instance data using the user- specified Progress 4GL format string. The algorithm to format a longchar is basically the same as for any character.
    
    Specified by:
    
    toString in class BaseDataType
    
    Parameters:
    
    fmt - The Progress 4GL format string for a character data type.
    
    Returns:
    
    The formatted string.
  - isCharacterData
```
public boolean isCharacterData()
```
    Indicate whether this object manages character data (as opposed to binary data).
    
    Specified by:
    
    isCharacterData in interface LargeObject
    
    Returns:
    
    Always true.
  - lengthOf
```
public long lengthOf()
```
    The length of the data managed by this object.
    
    Specified by:
    
    lengthOf in interface LargeObject
    
    Returns:
    
    The length, or 0 if uninitialized/unknown.
  - asByteArray
```
public byte[] asByteArray(long pos,
                          long len)
```
    Return the entire contents of the current buffer as an array. This may be a copy of the data, depending on the subclass' implementation. The byte array is the binary representation of this LOB using the configured codepage. If none was configured the default CPInternal is used.
    
    Specified by:
    
    asByteArray in interface LargeObject
    
    Parameters:
    
    pos - Starting offset position.
    
    len - Length of range to return.
    
    Returns:
    
    The contents of the instance. 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.
  - 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:
    - ignores the trim option (i.e., any existing characters beyond the end of the write are left in place, regardless of the value of trim);
    - 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. Ignored.
  - 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.
  - instantiateDefaultExtent
```
protected BaseDataType instantiateDefaultExtent()
```
    Get the default initialization for an extent variable of this type.
    
    Overrides:
    
    instantiateDefaultExtent in class BaseDataType
    
    Returns:
    
    See above.
  - isIncompatibleTypesOnConversion
```
protected boolean isIncompatibleTypesOnConversion(BaseDataType value)
```
    Assigns the value represented by value to this object. If this longchar does not have a fixed codepage, the default codepage (SESSION:CPINTERNAL) is used. Otherwise a codepage conversion occurs.
    
    Overrides:
    
    isIncompatibleTypesOnConversion in class Text
    
    Parameters:
    
    value - The source Text to be assigned.
  - 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.
  - lengthInt
```
protected int lengthInt()
```
    Returns the length of the current Text object instance in chars. Internal version.
    
    Overrides:
    
    lengthInt in class Text
    
    Returns:
    
    Current text variable char length.
  - assign
```
public void assign(Text value)
```
    Description copied from class: Text
    
    Sets the state (data and unknown value) of this instance based on the state of the passed instance.
    This form of assignment allows embedded null characters to be assigned from one already existing instance to another if the child class allows it.
    
    Overrides:
    
    assign in class Text
    
    Parameters:
    
    value - The instance from which to copy state.
  - assign
```
public void assign(longchar value)
```
    Assigns the value represented by value to this object. If this longchar does not have a fixed codepage, the codepage from the source is copied too. Otherwise a codepage conversion occurs.
    
    Parameters:
    
    value - The source longchar to be assigned.
  - getSize
```
public int getSize()
```
    Obtain the length (in bytes) of this BDT will use when serialized.
    
    Overrides:
    
    getSize in class BaseDataType
    
    Returns:
    
    the length of this BDT will use when serialized.

Class longchar

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

codePage

fixedCodepage

overrideLength

Constructor Detail

longchar

longchar

longchar

longchar

longchar

longchar

Method Detail

forceCharacterType

getType

isEmbeddedNullAllowed

compareTo

getCodePage

getCodePage

getCodePage

_getCodePage

instantiateUnknown

isCodePageFixed

fixCodePage

fixCodePage

fixCodePage

fixCodePage

fixCodePage

fixCodePage

fixCodePage

isCodePageFixed

defaultFormatString

duplicate

toStringMessage

toStringExport

toString

isCharacterData

lengthOf

asByteArray

write

instantiateDefault

instantiateDefaultExtent

isIncompatibleTypesOnConversion

setOverrideLength

lengthInt

assign

assign

getSize