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

java.lang.Object
- com.goldencode.p2j.persist.orm.PropertyMeta

All Implemented Interfaces:

java.lang.Comparable<PropertyMeta>
```
public final class PropertyMeta
extends java.lang.Object
implements java.lang.Comparable<PropertyMeta>
```
Metadata for the field within which a DMO data element is stored. Each datum is stored within a single element of a one-dimensional array. A scalar field takes up one slot in the array; an extent field takes up one slot per extent field element.
To keep the class hierarchy flat and fast, some information which only applies to certain data types (e.g., case-sensitivity) is maintained by this class. Fields are directly accessible to avoid method call overhead.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) int`	`columnCount` The number of columns in the table.
`(package private) int`	`columnIndex` One-based index of column in select clause or insert statement during load or insert.
`private DataHandler`	`dataHandler` The handler for setting this data type as parameter to a `PreparedStatement`.
`(package private) Property`	`dmoProperty` The dmo property which contains the data read from annotation.
`private int`	`extent` Field extent (0 for scalar, including denormalized extent fields)
`(package private) java.lang.String`	`getterName` The getter's name for this property.
`private int`	`id` Property ID
`(package private) java.lang.Object`	`initialValue` Default initial (low-level) data value; will be a (`Supplier`) for a dynamic initializer.
`(package private) int`	`offset` The offset of the property in `data` array.
`(package private) int`	`seriesSize` Number of properties of like extent; non-0 only in first instance in a series
`(package private) java.lang.String`	`setterName` The setter's name for this property.

Constructor Summary

Constructors
Constructor and Description
`PropertyMeta(Property prop, java.lang.String getterName, java.lang.String setterName)` Constructor which accepts a `Property` from DMO interface and the name of the accessor methods associated with the property.
`PropertyMeta(ReservedProperty prop)` Constructor which initializes the instance with the `ReservedProperty` details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PropertyMeta that)` Compare this `PropertyMeta` field to another.
`java.lang.String`	`getColumn()` Retrieve the column name in the SQL table of this property.
`DataHandler`	`getDataHandler()` Obtain the `DataHandler` used for setting a value of this property as a parameter in a prepared query.
`int`	`getDecimals()` Obtain numeric scale (precision in 4GL terms) (applies to `decimal` fields only) ad defined in the field declaration.
`Property`	`getDmoProperty()` Get the `dmoProperty` instance.
`int`	`getExtent()` Retrieve the extent of this property.
`java.lang.String`	`getFormat()` Retrieve the format used by this property.
`int`	`getId()` Obtain the original id of this property from the DMO interface.
`java.lang.Object`	`getInitialValue()` Retrieve the original initial value of this property.
`java.lang.String`	`getLegacyName()` Retrieve the legacy name of this property.
`int`	`getMaxWidth()` Get the maximum acceptable length for this `character` property.
`java.lang.String`	`getName()` Retrieve the name of this property.
`int`	`getOffset()` Obtain the index 0-base of the property in the `data` array of the `BaseRecord`.
`int`	`getOriginalExtent()` Retrieve the original extent of this property, which differs from @extent@ only for denormalized extent fields.
`java.lang.String`	`getOriginalName()` Retrieve the original name of this property, for extent fields which were denormalized.
`java.lang.Class<? extends BaseDataType>`	`getType()` Obtain the FWD type of the field.
`boolean`	`isCaseSensitive()` Test whether this property is case sensitive.
`(package private) boolean`	`isCharacter()` Check whether this property has `character` type.
`(package private) boolean`	`isDateTimeTz()` Check whether this property has `datetime-tz` type.
`boolean`	`isMandatory()` Test whether this is a mandatory property.
`boolean`	`isReserved()` Check if this property meta is for a reserved property.
`java.lang.String`	`toString()` Returns a short text describing this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - dmoProperty
```
final Property dmoProperty
```
    The dmo property which contains the data read from annotation.
  - initialValue
```
final java.lang.Object initialValue
```
    Default initial (low-level) data value; will be a (Supplier) for a dynamic initializer.
  - id
```
private final int id
```
    Property ID
  - extent
```
private final int extent
```
    Field extent (0 for scalar, including denormalized extent fields)
  - dataHandler
```
private final DataHandler dataHandler
```
    The handler for setting this data type as parameter to a PreparedStatement.
  - seriesSize
```
int seriesSize
```
    Number of properties of like extent; non-0 only in first instance in a series
  - columnIndex
```
int columnIndex
```
    One-based index of column in select clause or insert statement during load or insert.
    In case of multi-column properties, this is the index of the first column. The other(s) come in sequence.
  - columnCount
```
int columnCount
```
    The number of columns in the table. When the object is read from database all columnCount columns are used to rehydrate the restore the object's internal data.
  - offset
```
int offset
```
    The offset of the property in data array. For extent fields, this is the offset of the first element.
  - setterName
```
final java.lang.String setterName
```
    The setter's name for this property. Its name be used by DmoClass to assemble the setter implementations on-the-fly.
  - getterName
```
final java.lang.String getterName
```
    The getter's name for this property. Its name be used by DmoClass to assemble the getter implementations on-the-fly.
- Constructor Detail
  - PropertyMeta
```
PropertyMeta(ReservedProperty prop)
```
    Constructor which initializes the instance with the ReservedProperty details.
    
    Parameters:
    
    prop - The property details.
  - PropertyMeta
```
PropertyMeta(Property prop,
             java.lang.String getterName,
             java.lang.String setterName)
```
    Constructor which accepts a Property from DMO interface and the name of the accessor methods associated with the property.
    
    Parameters:
    
    prop - The Property annotation to be analyzed for object attributes.
    
    getterName - The name of the getter for this property.
    
    setterName - The name of the setter for this property.
- Method Detail
  - compareTo
```
public int compareTo(PropertyMeta that)
```
    Compare this PropertyMeta field to another. This method defines the natural sort of this object, which is first in ascending order by extent (0 for scalar fields, thus, they sort first). Fields of the same extent are sorted in ascending order by ID.
    This sort does not match the legacy order of the fields, but is instead organized for the case where the fields are used within SQL statements, in which case they need to be in a well-known order.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<PropertyMeta>
    
    Parameters:
    
    that - PropertyMeta object with which to compare.
    
    Returns:
    
    Negative value if this instance should sort before that instance; 0 if they should sort equally; positive value if this instance should sort after that instance.
  - getId
```
public int getId()
```
    Obtain the original id of this property from the DMO interface.
    
    Returns:
    
    the original id of this property from the DMO interface.
  - getOffset
```
public int getOffset()
```
    Obtain the index 0-base of the property in the data array of the BaseRecord. In case on extent properties, this is the offset of the first element.
    
    Returns:
    
    the offset of the property in data array. For extent fields, this is the offset of the first element.
  - getType
```
public java.lang.Class<? extends BaseDataType> getType()
```
    Obtain the FWD type of the field.
    
    Returns:
    
    the FWD type of the field.
  - getDecimals
```
public int getDecimals()
```
    Obtain numeric scale (precision in 4GL terms) (applies to decimal fields only) ad defined in the field declaration. The method returns 0 when no such declaration was encountered in ABL source, but the default value to be used in this case is 10.
    
    Returns:
    
    the scale/precision type of the decimal field.
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Test whether this property is case sensitive. Only for character data this method is expected to return true.
    
    Returns:
    
    true if this is a case-sensitive character property.
  - getMaxWidth
```
public int getMaxWidth()
```
    Get the maximum acceptable length for this character property.
    
    Returns:
    
    the maximum acceptable length for this character property. 0 otherwise, or not defined.
  - isCharacter
```
boolean isCharacter()
```
    Check whether this property has character type.
    
    Returns:
    
    true if the type of this property is character and false otherwise.
  - isDateTimeTz
```
boolean isDateTimeTz()
```
    Check whether this property has datetime-tz type.
    
    Returns:
    
    true if the type of this property is datetime-tz and false otherwise.
  - getDataHandler
```
public DataHandler getDataHandler()
```
    Obtain the DataHandler used for setting a value of this property as a parameter in a prepared query. It will automatically handle null values.
    
    Returns:
    
    the DataHandler for values of this property.
  - getColumn
```
public java.lang.String getColumn()
```
    Retrieve the column name in the SQL table of this property.
    
    Returns:
    
    the name of the column of this property.
  - getName
```
public java.lang.String getName()
```
    Retrieve the name of this property.
    
    Returns:
    
    the name of this property.
  - getLegacyName
```
public java.lang.String getLegacyName()
```
    Retrieve the legacy name of this property.
    
    Returns:
    
    the legacy name of this property.
  - getExtent
```
public int getExtent()
```
    Retrieve the extent of this property.
    
    Returns:
    
    The number of elements in this extent property. If this is not an extent property, or it represents a denormalized extent property, 0 is returned.
  - isMandatory
```
public boolean isMandatory()
```
    Test whether this is a mandatory property.
    
    Returns:
    
    true for mandatory fields.
  - isReserved
```
public boolean isReserved()
```
    Check if this property meta is for a reserved property.
    
    Returns:
    
    true if the referenced property is reserved.
  - getOriginalExtent
```
public int getOriginalExtent()
```
    Retrieve the original extent of this property, which differs from @extent@ only for denormalized extent fields. The actual extent is returned (not 0) for denormalized extent fields.
    
    Returns:
    
    The number of elements in this extent property. If this is not an extent property, 0 is returned.
  - getOriginalName
```
public java.lang.String getOriginalName()
```
    Retrieve the original name of this property, for extent fields which were denormalized.
    Only denormalized properties will have a non-empty string for this value. All other properties, scalar or otherwise, will report empty string.
    
    Returns:
    
    Original property name for a denormalized extent field.
  - getInitialValue
```
public java.lang.Object getInitialValue()
```
    Retrieve the original initial value of this property. Note that if the initial value is a dynamic function (e.g., date "today", datetime/datetimetz "now"), the value returned will be the result of invoking that function at the moment this method is called.
    
    Returns:
    
    The initial value for this property.
  - getFormat
```
public java.lang.String getFormat()
```
    Retrieve the format used by this property.
    
    Returns:
    
    the format used by this property.
  - getDmoProperty
```
public Property getDmoProperty()
```
    Get the dmoProperty instance.
    
    Returns:
    
    See above.
  - toString
```
public java.lang.String toString()
```
    Returns a short text describing this object. Used for debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a short description of this object to be used when debugging.

Class PropertyMeta

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dmoProperty

initialValue

id

extent

dataHandler

seriesSize

columnIndex

columnCount

offset

setterName

getterName

Constructor Detail

PropertyMeta

PropertyMeta

Method Detail

compareTo

getId

getOffset

getType

getDecimals

isCaseSensitive

getMaxWidth

isCharacter

isDateTimeTz

getDataHandler

getColumn

getName

getLegacyName

getExtent

isMandatory

isReserved

getOriginalExtent

getOriginalName

getInitialValue

getFormat

getDmoProperty

toString