public static class TableMapper.LegacyFieldInfo extends java.lang.Object implements java.lang.Comparable<TableMapper.LegacyFieldInfo>
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 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 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 |
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.
|
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 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.
|
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()
Get the column label.
|
java.lang.Class<? extends BaseDataType> |
getDataType()
Get the field's data-type as a Java class instance.
|
int |
getDecimals()
Obtain the precision for decimal fields.
|
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()
Get the format string.
|
java.lang.String |
getHelp()
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()
Get the label.
|
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.
|
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()
Get all serialize options defined for the field (only meaningful for temp-table fields).
|
java.lang.String |
getValidateExpression()
Get the validate expression, if any.
|
java.lang.String |
getValidateMessage()
Get the validate message, if any.
|
boolean |
isCaseSensitive()
Checks whether this is a case-sensitive character field.
|
boolean |
isLiteralQuestion()
Get the literal-question value.
|
boolean |
isMandatory()
Indicate whether this field is mandatory (i.e., non-null).
|
void |
setColumnLabel(java.lang.String columnLabel)
Set the column label.
|
void |
setDecimals(int decimals)
Sets the precision for decimal fields.
|
void |
setFormat(java.lang.String format)
Set the format string.
|
void |
setHelp(java.lang.String help)
Set the help string.
|
void |
setLabel(java.lang.String label)
Set the label.
|
void |
setLiteralQuestion(boolean literalQuestion)
Set the literal-question value.
|
void |
setValidateExpression(java.lang.String validateExpression)
Get the validate expression, if any.
|
void |
setValidateMessage(java.lang.String validateMessage)
Set the validate message attribute to a new value.
|
java.lang.String |
toString()
Obtain a short sreing representation of the object used in debugging.
|
private java.lang.String columnLabel
private final java.lang.Integer fieldId
bufferField(int)
attribute of the BufferImpl
for
emulating the BUFFER-FIELD(integer)
buffer handle attribute.private java.lang.String format
private java.lang.String help
private final java.lang.String initial
private int decimals
private final java.lang.String javaName
private java.lang.String label
private final java.lang.String legacyName
private final int extent
private final int order
private final int position
private boolean literalQuestion
public final boolean mandatory
public final java.lang.String original
private java.lang.String validateMessage
private java.lang.String validateExpression
private final java.lang.Class<? extends BaseDataType> dataType
private final BaseDataType initialValue
private final SerializeOptions serializeOptions
private final java.lang.String like
private final java.lang.String codePage
private final boolean caseSensitive
private final boolean mutable
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 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)
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.public java.lang.String getColumnLabel()
public void setColumnLabel(java.lang.String columnLabel)
columnLabel
- The new column label.public java.lang.String getFormat()
public void setFormat(java.lang.String format)
format
- The new format string.public java.lang.String getHelp()
public void setHelp(java.lang.String help)
help
- The new help string.public java.lang.String getLabel()
public void setLabel(java.lang.String label)
label
- The new abel.public boolean isLiteralQuestion()
public void setLiteralQuestion(boolean literalQuestion)
literalQuestion
- The new value of LITERAL-QUESTION
attribute.public java.lang.String getValidateMessage()
public void setValidateMessage(java.lang.String validateMessage)
validateMessage
- The new validate message.public java.lang.String getValidateExpression()
public void setValidateExpression(java.lang.String validateExpression)
validateExpression
- The new validate expression.public java.lang.Integer getFieldId()
public java.lang.String getInitial()
public java.lang.String getJavaName()
public java.lang.String getLegacyName()
public boolean isMandatory()
true
if mandatory; else false
.public int getExtent()
public int getOrder()
public int getPosition()
public java.lang.String getOriginal()
public java.lang.Class<? extends BaseDataType> getDataType()
public BaseDataType getInitialValue()
public SerializeOptions getSerializeOptions()
public java.lang.String getLike()
public java.lang.String getCodePage()
public boolean isCaseSensitive()
true
only if this is a case-sensitive character field.public int getDecimals()
public void setDecimals(int decimals)
decimals
- The new precision for decimal fields.java.lang.IllegalStateException
- if the object is not declared as mutable.public int compareTo(TableMapper.LegacyFieldInfo o)
compareTo
in interface java.lang.Comparable<TableMapper.LegacyFieldInfo>
public java.lang.String toString()
toString
in class java.lang.Object