com.goldencode.p2j.persist

Class TableMapper.LegacyFieldInfo

java.lang.Object

com.goldencode.p2j.persist.TableMapper.LegacyFieldInfo

All Implemented Interfaces:

java.lang.Comparable<TableMapper.LegacyFieldInfo>

Enclosing class:

TableMapper<K>

public static class TableMapper.LegacyFieldInfo
extends java.lang.Object
implements java.lang.Comparable<TableMapper.LegacyFieldInfo>

A container with a field's legacy and DMO property name and field attributes.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	caseSensitive Flags case-sensitive character fields.
private java.lang.String	codePage Code page of the CLOB field.
private java.lang.String	columnLabel COLUMN-LABEL attribute of this field.
private java.lang.Class<? extends BaseDataType>	dataType Field data type.
private int	decimals DECIMALS attribute of this field.
private java.lang.String	definedFormat Defined FORMAT attribute of this field.
private int	extent EXTENT attribute of the field (from the legacy schema).
private java.lang.Integer	fieldId The id of this field in the sequence of the fields of the buffer.
private java.lang.String	format FORMAT attribute of this field.
private java.lang.String	help HELP attribute of this field.
private java.lang.String	initial INITIAL attribute of this field.
private boolean	initialNull INITIAL-NULL pseudo- attribute of this field.
private BaseDataType	initialValue The initial value for this field.
private java.lang.String	javaName The associated DMO property name.
private java.lang.String	label LABEL attribute of this field.
private java.lang.String	lcLegacyName Lowercased version of the legacy name.
private java.lang.String	legacyName The legacy name of this field.
private java.lang.String	like Fully qualified name of the source field from which the field definitions were copied using LIKE option.
private boolean	literalQuestion LITERAL-QUESTION attribute of this field.
boolean	mandatory MANDATORY attribute of this field.
private boolean	mutable Flags mutable objects.
private int	order ORDER attribute of the field (from the legacy schema).
java.lang.String	original Original property name (not exposed in DMO) for denormalized field with extent.
private int	position POSITION attribute of the field (from the legacy schema).
private SerializeOptions	serializeOptions Options needed when serializing temp-table data to/from external media
private java.lang.String	validateExpression VALIDATE-EXPRESSION attribute of this field.
private java.lang.String	validateMessage VALIDATE-MESSAGE attribute of this field.

Constructor Summary

Constructors

Modifier

Constructor and Description

private

LegacyFieldInfo(boolean mutable, java.lang.String columnLabel, java.lang.Integer fieldId, java.lang.String format, java.lang.String help, java.lang.String initial, int decimals, java.lang.String javaName, java.lang.String label, java.lang.String legacyName, boolean mandatory, int extent, int order, int position, java.lang.String original, java.lang.String validateMessage, java.lang.String validateExpression, java.lang.Class<? extends BaseDataType> dataType, BaseDataType initialValue, boolean initialNull, boolean serializeHidden, java.lang.String serializeName, java.lang.String xmlDataType, java.lang.String xmlNodeName, java.lang.String xmlNodeType, java.lang.String like, java.lang.String codePage, boolean caseSensitive) Create a new field information container, holding the legacy and converted names and field attributes.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TableMapper.LegacyFieldInfo o) Compare this field info object to another, based on its natural order.
java.lang.String	getCodePage() Get code page of the CLOB field.
java.lang.String	getColumnLabel(TempTable tt) Get the column label.
java.lang.Class<? extends BaseDataType>	getDataType() Get the field's data-type as a Java class instance.
int	getDecimals(TempTable tt) Obtain the precision for decimal fields.
java.lang.String	getDefinedFormat() Get the defined format string.
java.lang.String	getDefinedLabel() Get the defined label.
int	getExtent() Get the EXTENT attribute.
java.lang.Integer	getFieldId() Get the field's ID, which also represents its natural order.
java.lang.String	getFormat(TempTable tt) Get the format string.
java.lang.String	getHelp(TempTable tt) Get the help string.
java.lang.String	getInitial() Get the schema's string representation of the field's initial value.
BaseDataType	getInitialValue() Get the field's initial value as actual data.
java.lang.String	getJavaName() Get the field's corresponding DMO property name.
java.lang.String	getLabel(TempTable tt) Get the label.
java.lang.String	getLcLegacyName() Get the legacy name.
java.lang.String	getLegacyName() Get the legacy name.
java.lang.String	getLike() Get fully qualified name of the source field from which the field definitions were copied using LIKE option.
private TableMapper.MutableFieldInfo	getMutableInfo(TempTable tt, boolean setter) Get the TableMapper.MutableFieldInfo associated with the field in the given TempTable instance.
int	getOrder() Get the ORDER attribute.
java.lang.String	getOriginal() Get the field's original name (will differ from legacy name, if extent field was denormalized).
int	getPosition() Get the POSITION attribute, if it is set, otherwise return the value of the ORDER attribute.
SerializeOptions	getSerializeOptions(TempTable tt) Get all serialize options defined for the field (only meaningful for temp-table fields).
java.lang.String	getValidateExpression(TempTable tt) Get the validate expression, if any.
java.lang.String	getValidateMessage(TempTable tt) Get the validate message, if any.
boolean	isCaseSensitive() Checks whether this is a case-sensitive character field.
boolean	isInitialNull() Get the value of the INITIAL-NULL pseudo-attribute.
boolean	isLiteralQuestion(TempTable tt) Get the literal-question value.
boolean	isMandatory() Indicate whether this field is mandatory (i.e., non-null).
void	setColumnLabel(java.lang.String columnLabel, TempTable tt) Set the column label.
void	setDecimals(int decimals, TempTable tt) Sets the precision for decimal fields.
void	setFormat(java.lang.String format, TempTable tt) Set the format string.
void	setHelp(java.lang.String help, TempTable tt) Set the help string.
void	setLabel(java.lang.String label, TempTable tt) Set the label.
void	setLiteralQuestion(boolean literalQuestion, TempTable tt) Set the literal-question value.
void	setValidateExpression(java.lang.String validateExpression, TempTable tt) Get the validate expression, if any.
void	setValidateMessage(java.lang.String validateMessage, TempTable tt) Set the validate message attribute to a new value.
java.lang.String	toString() Obtain a short sreing representation of the object used in debugging.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

columnLabel

private java.lang.String columnLabel

COLUMN-LABEL attribute of this field.

fieldId

private final java.lang.Integer fieldId

The id of this field in the sequence of the fields of the buffer. It is needed by the dynamic bufferField(int) attribute of the BufferImpl for emulating the BUFFER-FIELD(integer) buffer handle attribute.

format

private java.lang.String format

FORMAT attribute of this field.

definedFormat

private java.lang.String definedFormat

Defined FORMAT attribute of this field.

help

private java.lang.String help

HELP attribute of this field.

initial

private final java.lang.String initial

INITIAL attribute of this field.

initialNull

private final boolean initialNull

INITIAL-NULL pseudo- attribute of this field.

decimals

private int decimals

DECIMALS attribute of this field.

javaName

private final java.lang.String javaName

The associated DMO property name.

label

private java.lang.String label

LABEL attribute of this field.

legacyName

private final java.lang.String legacyName

The legacy name of this field.

lcLegacyName

private final java.lang.String lcLegacyName

Lowercased version of the legacy name.

extent

private final int extent

EXTENT attribute of the field (from the legacy schema).

order

private final int order

ORDER attribute of the field (from the legacy schema).

position

private final int position

POSITION attribute of the field (from the legacy schema).

literalQuestion

private boolean literalQuestion

LITERAL-QUESTION attribute of this field.

mandatory

public final boolean mandatory

MANDATORY attribute of this field.

original

public final java.lang.String original

Original property name (not exposed in DMO) for denormalized field with extent.

validateMessage

private java.lang.String validateMessage

VALIDATE-MESSAGE attribute of this field.

validateExpression

private java.lang.String validateExpression

VALIDATE-EXPRESSION attribute of this field.

dataType

private final java.lang.Class<? extends BaseDataType> dataType

Field data type.

initialValue

private final BaseDataType initialValue

The initial value for this field.

serializeOptions

private final SerializeOptions serializeOptions

Options needed when serializing temp-table data to/from external media

like

private final java.lang.String like

Fully qualified name of the source field from which the field definitions were copied using LIKE option.

codePage

private final java.lang.String codePage

Code page of the CLOB field.

caseSensitive

private final boolean caseSensitive

Flags case-sensitive character fields.

mutable

private final boolean mutable

Flags mutable objects.

Constructor Detail

LegacyFieldInfo

private LegacyFieldInfo(boolean mutable,
                        java.lang.String columnLabel,
                        java.lang.Integer fieldId,
                        java.lang.String format,
                        java.lang.String help,
                        java.lang.String initial,
                        int decimals,
                        java.lang.String javaName,
                        java.lang.String label,
                        java.lang.String legacyName,
                        boolean mandatory,
                        int extent,
                        int order,
                        int position,
                        java.lang.String original,
                        java.lang.String validateMessage,
                        java.lang.String validateExpression,
                        java.lang.Class<? extends BaseDataType> dataType,
                        BaseDataType initialValue,
                        boolean initialNull,
                        boolean serializeHidden,
                        java.lang.String serializeName,
                        java.lang.String xmlDataType,
                        java.lang.String xmlNodeName,
                        java.lang.String xmlNodeType,
                        java.lang.String like,
                        java.lang.String codePage,
                        boolean caseSensitive)

Create a new field information container, holding the legacy and converted names and field attributes.

Parameters:

mutable - If this structure is mutable. This is the case of temp-tables, which allow some of theirs field properties to be changed programmatically, at runtime. Only the mutable attributes have setters and their implementation must check this flag.

columnLabel - COLUMN-LABEL attribute.

fieldId - The id of field in the sequence of the fields of the buffer.

format - FORMAT attribute.

help - HELP attribute.

initial - INITIAL attribute.

javaName - The field's associated DMO property name.

label - LABEL attribute.

legacyName - The field's legacy name.

mandatory - MANDATORY attribute.

extent - EXTENT attribute from the schema (this is the original extent value without any regard for normalization/denormalization).

order - ORDER attribute.

position - POSITION attribute.

original - Original property name (actually not exposed in DMO) for denormalized field with extent.

validateMessage - VALIDATE-MESSAGE attribute.

validateExpression - VALIDATE-EXPRESSION attribute.

dataType - The field data type.

initialValue - The value of the field when the record is first created.

serializeHidden - true to omit this field from serialized output, else false.

serializeName - Name of field in serialized output.

xmlDataType - XML schema data type of field.

xmlNodeName - Name of element or attribute representing field in XML output.

xmlNodeType - Node type of field in XML output (valid values are "ELEMENT" and "ATTRIBUTE").

like - Fully qualified name of the source field from which the field definitions were copied using LIKE option.

codePage - Code page of the CLOB field.

caseSensitive - Flags case-sensitive character fields.

Method Detail

getColumnLabel

public java.lang.String getColumnLabel(TempTable tt)

Get the column label.

Parameters:

tt - The TempTable resource.

Returns:

Column label.

setColumnLabel

public void setColumnLabel(java.lang.String columnLabel,
                           TempTable tt)

Set the column label.

Parameters:

tt - The TempTable resource.

columnLabel - The new column label.

getFormat

public java.lang.String getFormat(TempTable tt)

Get the format string.

Parameters:

tt - The TempTable resource.

Returns:

Format string.

getDefinedFormat

public java.lang.String getDefinedFormat()

Get the defined format string.

Returns:

Defined format string.

setFormat

public void setFormat(java.lang.String format,
                      TempTable tt)

Set the format string.

Parameters:

tt - The TempTable resource.

format - The new format string.

getHelp

public java.lang.String getHelp(TempTable tt)

Get the help string.

Parameters:

tt - The TempTable resource.

Returns:

Help string.

setHelp

public void setHelp(java.lang.String help,
                    TempTable tt)

Set the help string.

Parameters:

tt - The TempTable resource.

help - The new help string.

getLabel

public java.lang.String getLabel(TempTable tt)

Get the label.

Parameters:

tt - The TempTable resource.

Returns:

Label.

getDefinedLabel

public java.lang.String getDefinedLabel()

Get the defined label.

Returns:

Defined label.

setLabel

public void setLabel(java.lang.String label,
                     TempTable tt)

Set the label.

Parameters:

tt - The TempTable resource.

label - The new abel.

isLiteralQuestion

public boolean isLiteralQuestion(TempTable tt)

Get the literal-question value.

Parameters:

tt - The TempTable resource.

Returns:

Literal-question value.

setLiteralQuestion

public void setLiteralQuestion(boolean literalQuestion,
                               TempTable tt)

Set the literal-question value.

Parameters:

tt - The TempTable resource.

literalQuestion - The new value of LITERAL-QUESTION attribute.

getValidateMessage

public java.lang.String getValidateMessage(TempTable tt)

Get the validate message, if any.

Parameters:

tt - The TempTable resource.

Returns:

Validate message.

setValidateMessage

public void setValidateMessage(java.lang.String validateMessage,
                               TempTable tt)

Set the validate message attribute to a new value.

Parameters:

tt - The TempTable resource.

validateMessage - The new validate message.

getValidateExpression

public java.lang.String getValidateExpression(TempTable tt)

Get the validate expression, if any.

Parameters:

tt - The TempTable resource.

Returns:

Validate expression.

setValidateExpression

public void setValidateExpression(java.lang.String validateExpression,
                                  TempTable tt)

Get the validate expression, if any.

Parameters:

tt - The TempTable resource.

validateExpression - The new validate expression.

getFieldId

public java.lang.Integer getFieldId()

Get the field's ID, which also represents its natural order.

Returns:

Field id.

getInitial

public java.lang.String getInitial()

Get the schema's string representation of the field's initial value.

Returns:

Initial value string.

getJavaName

public java.lang.String getJavaName()

Get the field's corresponding DMO property name.

Returns:

DMO property name.

getLegacyName

public java.lang.String getLegacyName()

Get the legacy name.

Returns:

Legacy name.

getLcLegacyName

public java.lang.String getLcLegacyName()

Get the legacy name.

Returns:

lowercased legacy name.

isMandatory

public boolean isMandatory()

Indicate whether this field is mandatory (i.e., non-null).

Returns:

true if mandatory; else false.

getExtent

public int getExtent()

Get the EXTENT attribute.

Returns:

The value of the EXTENT attribute from the original schema.

getOrder

public int getOrder()

Get the ORDER attribute.

Returns:

The value of the ORDER attribute from the original schema.

getPosition

public int getPosition()

Get the POSITION attribute, if it is set, otherwise return the value of the ORDER attribute. This is a fallback since some schemata are not exported with the POSITION attribute and temp-tables that are explicitly defined do not have the POSITION. In both of these cases, the 4GL would use the ORDER as the substitute value.

Returns:

The value of the POSITION attribute from the original schema.

getOriginal

public java.lang.String getOriginal()

Get the field's original name (will differ from legacy name, if extent field was denormalized).

Returns:

Original legacy name.

getDataType

public java.lang.Class<? extends BaseDataType> getDataType()

Get the field's data-type as a Java class instance.

Returns:

Data type of the field.

getInitialValue

public BaseDataType getInitialValue()

Get the field's initial value as actual data.

Returns:

Initial value.

isInitialNull

public boolean isInitialNull()

Get the value of the INITIAL-NULL pseudo-attribute.

Returns:

the value of the INITIAL-NULL pseudo-attribute.

getSerializeOptions

public SerializeOptions getSerializeOptions(TempTable tt)

Get all serialize options defined for the field (only meaningful for temp-table fields).

Parameters:

tt - The TempTable resource.

Returns:

Serialize options.

getLike

public java.lang.String getLike()

Get fully qualified name of the source field from which the field definitions were copied using LIKE option.

Returns:

see above.

getCodePage

public java.lang.String getCodePage()

Get code page of the CLOB field.

Returns:

code page of the CLOB 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(TempTable tt)

Obtain the precision for decimal fields.

Parameters:

tt - The TempTable resource.

Returns:

the precision for decimal fields.

setDecimals

public void setDecimals(int decimals,
                        TempTable tt)

Sets the precision for decimal fields. Only for mutable objects.

Parameters:

tt - The TempTable resource.

decimals - The new precision for decimal fields.

Throws:

java.lang.IllegalStateException - if the object is not declared as mutable.

compareTo

public int compareTo(TableMapper.LegacyFieldInfo o)

Compare this field info object to another, based on its natural order. Natural order is determined by field IDs.

Specified by:

compareTo in interface java.lang.Comparable<TableMapper.LegacyFieldInfo>

Returns:

> 1 if this field sorts ahead of the given field; < 1 if this field sorts behind the given field; 0 if they sort equivalently.

toString

public java.lang.String toString()

Obtain a short sreing representation of the object used in debugging.

Overrides:

toString in class java.lang.Object

Returns:

a short sreing representation of the object used in debugging.

getMutableInfo

private TableMapper.MutableFieldInfo getMutableInfo(TempTable tt,
                                                    boolean setter)

Get the TableMapper.MutableFieldInfo associated with the field in the given TempTable instance.

Parameters:

tt - The TempTable resource.

setter - Flag indicating if this call is associated with a setter, which will change the value. In this case, if not already built, the TableMapper.MutableFieldInfo will be constructed. Otherwise, the default value from field will be returned.

Returns:

The instance from AbstractTempTable.fieldInfo, for this temp-table.