TempTableSchema.Column (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.persist.serial.TempTableSchema.Column

Enclosing class:

TempTableSchema
```
static class TempTableSchema.Column
extends java.lang.Object
```
Schema information needed to serialize/deserialize a field/column.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Integer`	`extent` Extent of an array field (null for a scalar field)
`private java.lang.reflect.Method`	`getter` Method to get field data from buffer
`private BaseDataType`	`initialValue` The initial value as an instance of the appropriate type of the INIT option for this column.
`private java.lang.String`	`legacyName` Legacy name of field.
`private TableMapper.LegacyFieldInfo`	`lfi` Field info object to which we delegate all getters.
`int`	`offset` The offset in the record's data array.
`private int`	`order` Order in which column is serialized
`private java.lang.String`	`precomputedName` Name of element or attribute in serialized form (may differ from legacy field name)
`private boolean`	`serializeHidden` The field's SERIALIZE-HIDDEN option value.
`private java.lang.String`	`serializeName` The field's SERIALIZE-NAME option value.
`private java.lang.reflect.Method`	`setter` Method to set field data into buffer
`private TempTable`	`tt` The `TempTable` instance.
`private java.lang.Class<? extends BaseDataType>`	`type` Data wrapper type of field
`private java.lang.String`	`xmlNodeName` The field's XML-NODE-NAME option value.

Constructor Summary

Constructors
Constructor and Description
`Column(int order, java.util.Map<java.lang.String,java.lang.reflect.Method> getterMap, java.util.Map<java.lang.String,java.lang.reflect.Method> setterMap, TableMapper.LegacyFieldInfo lfi, int offset, RecordBuffer buf)` Constructor.
`Column(java.lang.String legacyName, java.lang.String name, BaseDataType initialValue)` Constructor used for BEFORE TEMP-TABLE columns.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCodePage()` Get field codepage.
`java.lang.String`	`getColumnLabel()` Get the `COLUMN-LABEL` attribute of this column.
`int`	`getDecimals()` Obtain the precision for decimal fields.
`java.lang.String`	`getDefinedFormat()` Obtain the defined format for this column if one was set.
`java.lang.String`	`getDefinedLabel()` Get the defined `LABEL` attribute of this column.
`java.lang.Integer`	`getExtent()` Get extent of column, if any.
`java.lang.String`	`getFieldName()` Get the column's legacy field name.
`java.lang.String`	`getFormat()` Obtain the format for this column if one was set.
`java.lang.reflect.Method`	`getGetter()` Get the DMO getter method for this column's value.
`java.lang.String`	`getHelp()` Obtain the help message for this column if one was set.
`java.lang.String`	`getInitial()` Obtain the initial value for this column (field).
`java.lang.String`	`getLabel()` Get the `LABEL` attribute of this column.
`SerializeOptions.XmlNodeType`	`getNodeType()` Get the XML node type (element or attribute) for this column.
`int`	`getOrder()` Get the order in which this column is serialized.
`java.lang.String`	`getSerializeName()` Get the column's legacy SERIALIZE-NAME, used for JSON (de)serialization.
`java.lang.reflect.Method`	`getSetter()` Get the DMO setter method for this column's value.
`java.lang.Class<? extends BaseDataType>`	`getType()` Get the data type of the field.
`java.lang.String`	`getXmlDataType()` Get the XML data type of the field.
`java.lang.String`	`getXmlNodeName()` Get the column's XML-NODE-NAME name, used for XML (de)serialization.
`boolean`	`isCaseSensitive()` Checks whether this is a case-sensitive character field.
`boolean`	`isChanged(BaseDataType datum)` Test whether a value is different than the initial value for this column.
`boolean`	`isHidden()` Test whether this is a BEFORE TEMP-TABLE hidden field.
`boolean`	`isInitialNull()` Get the value of the INITIAL-NULL pseudo-attribute.
`boolean`	`isNillable()` Indicate whether column can be null.
`boolean`	`isSerializeHidden()` Get the column's legacy SERIALIZE-HIDDEN attribute value

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

- Field Detail
  - offset
```
public final int offset
```
    The offset in the record's data array.
  - legacyName
```
private final java.lang.String legacyName
```
    Legacy name of field.
  - extent
```
private final java.lang.Integer extent
```
    Extent of an array field (null for a scalar field)
  - order
```
private final int order
```
    Order in which column is serialized
  - precomputedName
```
private final java.lang.String precomputedName
```
    Name of element or attribute in serialized form (may differ from legacy field name)
  - xmlNodeName
```
private final java.lang.String xmlNodeName
```
    The field's XML-NODE-NAME option value.
  - serializeName
```
private final java.lang.String serializeName
```
    The field's SERIALIZE-NAME option value.
  - serializeHidden
```
private final boolean serializeHidden
```
    The field's SERIALIZE-HIDDEN option value.
  - getter
```
private final java.lang.reflect.Method getter
```
    Method to get field data from buffer
  - setter
```
private final java.lang.reflect.Method setter
```
    Method to set field data into buffer
  - type
```
private final java.lang.Class<? extends BaseDataType> type
```
    Data wrapper type of field
  - initialValue
```
private final BaseDataType initialValue
```
    The initial value as an instance of the appropriate type of the INIT option for this column.
  - lfi
```
private final TableMapper.LegacyFieldInfo lfi
```
    Field info object to which we delegate all getters.
  - tt
```
private TempTable tt
```
    The TempTable instance.
- Constructor Detail
  - Column
```
Column(int order,
       java.util.Map<java.lang.String,java.lang.reflect.Method> getterMap,
       java.util.Map<java.lang.String,java.lang.reflect.Method> setterMap,
       TableMapper.LegacyFieldInfo lfi,
       int offset,
       RecordBuffer buf)
```
    Constructor.
    
    Parameters:
    
    order - Order of column in serialization output.
    
    getterMap - Map of java property names to getter methods.
    
    setterMap - Map of java property names to setter methods.
    
    lfi - Field info object.
    
    offset - The offset in the record's data array.
    
    buf - The buffer instance.
  - Column
```
public Column(java.lang.String legacyName,
              java.lang.String name,
              BaseDataType initialValue)
```
    Constructor used for BEFORE TEMP-TABLE columns. It allows to set the internal values directly.
    
    Parameters:
    
    legacyName - The fields's name (legacy name).
    
    name - Name of element or attribute in serialized form (may differ from legacy field name).
    
    initialValue - The initial value as an instance of the appropriate type of the INIT option for this column.
- Method Detail
  - getFieldName
```
public java.lang.String getFieldName()
```
    Get the column's legacy field name.
    
    Returns:
    
    Legacy field name.
  - getXmlNodeName
```
public java.lang.String getXmlNodeName()
```
    Get the column's XML-NODE-NAME name, used for XML (de)serialization.
    
    Returns:
    
    The field name used for (de)serialization.
  - getSerializeName
```
public java.lang.String getSerializeName()
```
    Get the column's legacy SERIALIZE-NAME, used for JSON (de)serialization.
    
    Returns:
    
    The field name used for (de)serialization.
  - isSerializeHidden
```
public boolean isSerializeHidden()
```
    Get the column's legacy SERIALIZE-HIDDEN attribute value
    
    Returns:
    
    The column's legacy SERIALIZE-HIDDEN attribute value.
  - isNillable
```
public boolean isNillable()
```
    Indicate whether column can be null.
    
    Returns:
    
    true if nillable, else false.
  - getExtent
```
public java.lang.Integer getExtent()
```
    Get extent of column, if any.
    
    Returns:
    
    Extent value for an array column, null for a scalar column.
  - getOrder
```
public int getOrder()
```
    Get the order in which this column is serialized.
    
    Returns:
    
    Order.
  - getNodeType
```
public SerializeOptions.XmlNodeType getNodeType()
```
    Get the XML node type (element or attribute) for this column.
    
    Returns:
    
    Node type.
  - getCodePage
```
public java.lang.String getCodePage()
```
    Get field codepage.
    
    Returns:
    
    Field codepage.
  - getGetter
```
public java.lang.reflect.Method getGetter()
```
    Get the DMO getter method for this column's value.
    
    Returns:
    
    Getter method.
  - getSetter
```
public java.lang.reflect.Method getSetter()
```
    Get the DMO setter method for this column's value.
    
    Returns:
    
    Setter method.
  - getType
```
public java.lang.Class<? extends BaseDataType> getType()
```
    Get the data type of the field.
    
    Returns:
    
    Data type.
  - getXmlDataType
```
public java.lang.String getXmlDataType()
```
    Get the XML data type of the field.
    
    Returns:
    
    XML data type.
  - getInitial
```
public java.lang.String getInitial()
```
    Obtain the initial value for this column (field).
    
    Returns:
    
    the initial value for this column if any is declared.
  - isInitialNull
```
public boolean isInitialNull()
```
    Get the value of the INITIAL-NULL pseudo-attribute.
    
    Returns:
    
    the value of the INITIAL-NULL pseudo-attribute.
  - getFormat
```
public java.lang.String getFormat()
```
    Obtain the format for this column if one was set.
    
    Returns:
    
    the format for this column.
  - getDefinedFormat
```
public java.lang.String getDefinedFormat()
```
    Obtain the defined format for this column if one was set.
    
    Returns:
    
    the defined format for this column.
  - getHelp
```
public java.lang.String getHelp()
```
    Obtain the help message for this column if one was set.
    
    Returns:
    
    the help for this column.
  - isHidden
```
public boolean isHidden()
```
    Test whether this is a BEFORE TEMP-TABLE hidden field. The hidden fields start with double underscore (__).
    
    Returns:
    
    true if this is a BEFORE temp-table hidden field.
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Checks whether this is a case-sensitive character field.
    
    Returns:
    
    true only if this is a case-sensitive character field.
  - getDecimals
```
public int getDecimals()
```
    Obtain the precision for decimal fields.
    
    Returns:
    
    the precision for decimal fields.
  - getColumnLabel
```
public java.lang.String getColumnLabel()
```
    Get the COLUMN-LABEL attribute of this column.
    
    Returns:
    
    The COLUMN-LABEL attribute of this column.
  - getLabel
```
public java.lang.String getLabel()
```
    Get the LABEL attribute of this column.
    
    Returns:
    
    The LABEL attribute of this column.
  - getDefinedLabel
```
public java.lang.String getDefinedLabel()
```
    Get the defined LABEL attribute of this column.
    
    Returns:
    
    The defined LABEL attribute of this column.
  - isChanged
```
public boolean isChanged(BaseDataType datum)
```
    Test whether a value is different than the initial value for this column.
    
    Parameters:
    
    datum - The value to be tested.
    
    Returns:
    
    true if the value is different.

Class TempTableSchema.Column

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

offset

legacyName

extent

order

precomputedName

xmlNodeName

serializeName

serializeHidden

getter

setter

type

initialValue

lfi

tt

Constructor Detail

Column

Column

Method Detail

getFieldName

getXmlNodeName

getSerializeName

isSerializeHidden

isNillable

getExtent

getOrder

getNodeType

getCodePage

getGetter

getSetter

getType

getXmlDataType

getInitial

isInitialNull

getFormat

getDefinedFormat

getHelp

isHidden

isCaseSensitive

getDecimals

getColumnLabel

getLabel

getDefinedLabel

isChanged