rowid (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.rowid

All Implemented Interfaces:

Undoable, java.io.Externalizable, java.io.Serializable, java.lang.Comparable
```
public class rowid
extends BaseDataType
```
A class that represents a Progress 4GL compatible rowid data type. Internally, the row identifier is stored as a 64-bit integer.

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 static java.util.regex.Pattern`	`RowIdPattern` Rowid valid string representation regex pattern.
`private java.lang.Long`	`value` Stores the integral row identifier, unique within a database

Constructor Summary

Constructors
Constructor and Description
`rowid()` Default constructor, creates an instance that represents the unknown value.
`rowid(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.
`rowid(character val)` Constructs an instance given a character encoding (hex string in the format 0xhhhhhhhhhhhhhhhh, where each h is an lower-case, hexadecimal digit, limited to maximum 16 digits because that actual internal implementation uses a java 64-bit Long).
`rowid(java.lang.Long value)` Constructs an instance given a 64-bit integer value.
`rowid(rowid value)` Constructs an instance based upon an existing instance.
`rowid(java.lang.String val)` Constructs an instance given a character encoding (hex string in the format 0xhhhhhhhhhhhhhhhh, where each h is an lower-case, hexadecimal digit, limited to maximum 16 digits because that actual internal implementation uses a java 64-bit Long).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assign(BaseDataType value)` Sets the data of this instance based on the given instance.
`void`	`assign(rowid value)` Sets the data of this instance based on the given instance.
`void`	`assign(Text value)` Sets the data of this instance based on the given instance.
`void`	`assign(Undoable 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.
`rowid`	`duplicate()` Does the same as standard `clone()` method but returns an instance of `BaseDataType` and doesn't throw the `CloneNotSupportedException`.
`boolean`	`equals(java.lang.Object o)` An equality test which handles the most common cases with the least amount of overhead.
`int`	`formatLength(java.lang.String fmt)` Calculate the length of a formatted value (the text form of the value) using this format string.
`int`	`getSize()` Obtain the length (in bytes) of this BDT will use when serialized.
`BaseDataType.Type`	`getType()` Get the type
`java.lang.Long`	`getValue()` Returns the value of this instance as an `Long`.
`int`	`hashCode()` Hash code implementation which is consistent with `BaseDataType.equals(java.lang.Object)`.
`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 boolean`	`isIncompatibleTypesOnConversion(BaseDataType value)` Returns true if dynamic data type conversion should not be attempted, it can also throws in case of incompatible types for a POLY conversion.
`boolean`	`isUnknown()` Determines if this instance represents the `unknown value`.
`static java.lang.Long`	`parseRowidString(java.lang.String value)` Worker method that parses and validates a `java.lang.String` according to rowid Progress data type constraints: must start with "0x" prefix must only contain lower-case hexadecimal digits the number of digits must be more than 2 and even the parsed value must fit into a 64-bit unsigned integer (this is the FWD limitation, Progress accepts any number of digits.)
`void`	`readExternal(java.io.ObjectInput in)` Replacement for the default object reading method.
`void`	`setUnknown()` Sets this instance to represent the unknown value.
`java.lang.String`	`toString()` Creates a string representation of the instance data as a hex string with a leading "0x" prefix.
`java.lang.String`	`toString(java.lang.String fmt)` Creates a string representation of the instance data as a hex string with a leading "0x" prefix.
`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`	`writeExternal(java.io.ObjectOutput out)` Replacement for the default object writing method.

Methods inherited from class com.goldencode.p2j.util.BaseDataType
assign, assign, calcFormatLength, createProxy, createProxy, deepCopy, elementsOfType, fallback, fromTypeName, generateDefault, generateUnknown, getAssigner, getTypeName, incompatibleTypesOnConversion, initialize, initializeDefaultExtent, instantiateDefaultExtent, 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, wait, wait, wait

- Field Detail
  - value
```
private java.lang.Long value
```
    Stores the integral row identifier, unique within a database
  - RowIdPattern
```
private static final java.util.regex.Pattern RowIdPattern
```
    Rowid valid string representation regex pattern.
- Constructor Detail
  - rowid
```
public rowid()
```
    Default constructor, creates an instance that represents the unknown value.
  - rowid
```
public rowid(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 (see assign(BaseDataType)).
    
    Parameters:
    
    value - The value to be used for this instance.
  - rowid
```
public rowid(rowid value)
```
    Constructs an instance based upon an existing instance.
    
    Parameters:
    
    value - The instance to copy.
  - rowid
```
public rowid(java.lang.Long value)
```
    Constructs an instance given a 64-bit integer value.
    
    Parameters:
    
    value - 64-bit integer value; should be unique across all records in a database. May be null to indicate unknown value.
  - rowid
```
public rowid(character val)
```
    Constructs an instance given a character encoding (hex string in the format 0xhhhhhhhhhhhhhhhh, where each h is an lower-case, hexadecimal digit, limited to maximum 16 digits because that actual internal implementation uses a java 64-bit Long).
    
    Parameters:
    
    val - A hex string in the format 0xhhhhhhhhhhhhhhhh. Any other string will, including null will indicate the unknown value.
  - rowid
```
public rowid(java.lang.String val)
```
    Constructs an instance given a character encoding (hex string in the format 0xhhhhhhhhhhhhhhhh, where each h is an lower-case, hexadecimal digit, limited to maximum 16 digits because that actual internal implementation uses a java 64-bit Long).
    
    Parameters:
    
    val - A hex string in the format 0xhhhhhhhhhhhhhhhh. Any other string will, including null will indicate the unknown value.
- Method Detail
  - parseRowidString
```
public static java.lang.Long parseRowidString(java.lang.String value)
```
    Worker method that parses and validates a java.lang.String according to rowid Progress data type constraints:
    - must start with "0x" prefix
    - must only contain lower-case hexadecimal digits
    - the number of digits must be more than 2 and even
    - the parsed value must fit into a 64-bit unsigned integer (this is the FWD limitation, Progress accepts any number of digits.)
    Parameters:
    
    value - A hex string matching the conditions above. Any other string, including null, will indicate the unknown value.
    
    Returns:
    
    A Long representing the internal value for a rowid or null if parsing fails.
  - 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.
  - duplicate
```
public rowid 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.
  - getType
```
public BaseDataType.Type getType()
```
    Get the type
    
    Specified by:
    
    getType in class BaseDataType
    
    Returns:
    
    type
  - equals
```
public boolean equals(java.lang.Object o)
```
    An equality test which handles the most common cases with the least amount of overhead. The superclass implementation is invoked otherwise.
    This implementation is consistent with hashCode().
    
    Overrides:
    
    equals in class BaseDataType
    
    Parameters:
    
    o - The instance to compare against.
    
    Returns:
    
    true if the objects compare equivalently; false if they do not, or if the parameter is not a BaseDataType instance.
    
    See Also:
    
    BaseDataType.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Hash code implementation which is consistent with BaseDataType.equals(java.lang.Object).
    
    Specified by:
    
    hashCode in class BaseDataType
    
    Returns:
    
    Hash code value for this object instance. All instances of this class return the same hash code value, since all instances are inherently equal.
  - getValue
```
public java.lang.Long getValue()
```
    Returns the value of this instance as an Long.
    If this instance represents the unknown value, a null will be returned.
    
    Returns:
    
    The value as a Long or null if this is unknown.
  - isUnknown
```
public boolean isUnknown()
```
    Determines if this instance represents the unknown value.
    
    Specified by:
    
    isUnknown in class BaseDataType
    
    Returns:
    
    true if this instance is set to the unknown value.
  - setUnknown
```
public void setUnknown()
```
    Sets this instance to represent the unknown value.
    Any existing value is discarded.
    
    Specified by:
    
    setUnknown in class BaseDataType
  - assign
```
public void assign(BaseDataType value)
```
    Sets the data of this instance based on the given instance.
    If the value is not of type rowid, the following automatic type conversion will occur:
```
 This type support only rowid and unknown types (including unknown literal).
 
```
    This variant is meant to handle the cases of built-in functions and methods in the 4GL which have polymorphic return types (e.g. DYNAMIC-FUNCTION()). This should NOT be used for non-polymorphic assignments.
    Specified by:
    
    assign in class BaseDataType
    
    Parameters:
    
    value - The instance from which to copy state.
    
    Throws:
    
    java.lang.ClassCastException - if value is not an instance of this class.
  - assign
```
public void assign(rowid value)
```
    Sets the data of this instance based on the given instance.
    
    Parameters:
    
    value - The instance from which to copy state.
  - assign
```
public void assign(Text value)
```
    Sets the data of this instance based on the given instance.
    
    Parameters:
    
    value - The instance from which to copy state.
  - assign
```
public void assign(Undoable value)
```
    Sets the state (data and unknown value) of this instance based on the state of the passed instance.
    
    Parameters:
    
    value - The instance from which to copy state.
  - 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.
    The rowids' internal, 64-bit integer values are compared.
    
    Parameters:
    
    obj - The instance to compare against.
    
    Returns:
    
    0 or 1 depending on if the passed instance is or is not unknown.
  - toString
```
public java.lang.String toString()
```
    Creates a string representation of the instance data as a hex string with a leading "0x" prefix.
    If the instance represents the unknown value, a '?' will be returned.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The formatted string.
  - toString
```
public java.lang.String toString(java.lang.String fmt)
```
    Creates a string representation of the instance data as a hex string with a leading "0x" prefix.
    If the instance represents the unknown value, a '?' will be returned.
    
    Specified by:
    
    toString in class BaseDataType
    
    Parameters:
    
    fmt - The Progress 4GL format string or null if the default format is to be used. This parameter is not validated and is ignored.
    
    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. If the instance represents the unknown value, a '?' will be returned.
    
    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.
  - defaultFormatString
```
public java.lang.String defaultFormatString()
```
    Return the default display format string for this type. This implementation returns null, because there is no formatted representation of a rowid: it must be converted to a string first using the Progress STRING() function.
    
    Specified by:
    
    defaultFormatString in class BaseDataType
    
    Returns:
    
    null.
  - formatLength
```
public int formatLength(java.lang.String fmt)
```
    Calculate the length of a formatted value (the text form of the value) using this format string.
    
    Overrides:
    
    formatLength in class BaseDataType
    
    Parameters:
    
    fmt - The format string.
    
    Returns:
    
    The length in characters of the any resulting formatted value.
  - 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.
  - 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.
    
    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.
    
    java.io.NotSerializableException - always.
  - 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.
    
    Parameters:
    
    out - The output destination to which fields will be saved.
    
    Throws:
    
    java.io.IOException - in case of I/O errors.
    
    java.io.NotSerializableException - always.
  - isIncompatibleTypesOnConversion
```
protected boolean isIncompatibleTypesOnConversion(BaseDataType value)
```
    Description copied from class: BaseDataType
    
    Returns true if dynamic data type conversion should not be attempted, it can also throws in case of incompatible types for a POLY conversion. (e.g. DYNAMIC-FUNCTION()).
    
    Overrides:
    
    isIncompatibleTypesOnConversion in class BaseDataType

Class rowid

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

Field Detail

value

RowIdPattern

Constructor Detail

rowid

rowid

rowid

rowid

rowid

rowid

Method Detail

parseRowidString

instantiateUnknown

instantiateDefault

duplicate

getType

equals

hashCode

getValue

isUnknown

setUnknown

assign

assign

assign

assign

compareTo

toString

toString

toStringMessage

toStringExport

defaultFormatString

formatLength

getSize

readExternal

writeExternal

isIncompatibleTypesOnConversion