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

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.persist.BufferFieldImpl

All Implemented Interfaces:

BufferField, NamedSerializable, SerializeHiddenable, XmlNode, WriteProtectable, ADMData, Available, CommonField, CommonHandle, CommonHandleChain, DatabaseInfo, Deletable, InstantiatingProcedure, Nameable, Sizeable, UniqueID, WrappedResource, Printable
```
public final class BufferFieldImpl
extends HandleChain
implements BufferField, Deletable
```
Implementation of Progress 4GL BUFFER-FIELD methods and attributes, using a FieldReference as a delegate worker.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`admData` Corresponds to ADM-DATA attribute.
`private character`	`columnLabel` Explicit value of `COLUMN-LABEL` attribute for database table fields.
`private java.lang.String`	`dataType` The calculated field's data-type.
`private FieldReference`	`fieldRef` `FieldReference` delegate object
`private boolean`	`forceDelete` Flag indicating if the delete must be forced.
`private character`	`format` Explicit value of `FORMAT` attribute for database table fields.
`private character`	`help` Explicit value of `HELP` attribute for database table fields.
`private java.lang.Boolean`	`key` The key flag.
`private character`	`label` Explicit value of `LABEL` attribute for database table fields.
`private TableMapper.LegacyFieldInfo`	`lfi` The legacy info collected from table creation or modified afterwards.
`private logical`	`literalQuestion` Explicit value of `LITERAL-QUESTION` attribute for database table fields.
`private static CentralLogger`	`LOG` Logger
`private boolean`	`mutableOptions` Flag for mutable options.
`private boolean`	`readOnly` The current value for READ-ONLY attribute.
`private logical`	`serializeHidden` Explicit value of `SERIALIZE-HIDDEN` attribute for database table fields.
`private character`	`serializeName` Explicit value of `SERIALIZE-NAME` attribute for database table fields.
`private java.lang.Long`	`uniqueID` Corresponds to UNIQUE-ID attribute.
`private character`	`validateExpression` Explicit value of `VALIDATE-EXPRESSION` attribute for database table fields.
`private character`	`validateMessage` Explicit value of `VALIDATE-MESSAGE` attribute for database table fields.
`private java.lang.String`	`viewAs` The current value for VIEW-AS attribute.
`private character`	`xmlDataType` Explicit value of `XML-DATA-TYPE` attribute for database table fields.
`private character`	`xmlNodeName` Explicit value of `XML-NODE-NAME` attribute for database table fields.
`private character`	`xmlNodeType` Explicit value of `XML-NODE-TYPE` attribute for database table fields.

Fields inherited from class com.goldencode.p2j.util.HandleChain
name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Fields inherited from interface com.goldencode.p2j.persist.BufferField
COMBO_BOX, DROP_DOWN, DROP_DOWN_LIST, FILL_IN, TOGGLE_BOX

Fields inherited from interface com.goldencode.p2j.persist.XmlNode
ATTRIBUTE, ELEMENT, HIDDEN, TEXT

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`BufferFieldImpl(FieldReference fieldRef, int index, TableMapper.LegacyFieldInfo lfi)` Create an instance of this class which accesses a specific element of an extent field, given a field reference for the same DMO property, which does not reference a specific element of that field.
`(package private)`	`BufferFieldImpl(java.lang.Object instProc, DataModelObject dmo, java.lang.String property)` Create a new field reference given a DMO proxy and property name.
`(package private)`	`BufferFieldImpl(java.lang.Object instProc, DataModelObject dmo, java.lang.String property, boolean bulk)` Create a new field reference given a DMO proxy and property name.
`private`	`BufferFieldImpl(java.lang.Object instProc, DataModelObject dmo, java.lang.String property, boolean uppercase, NumberType index, boolean bulk)` Create a new field reference given a DMO proxy, a property name, and an index for the property.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) int`	`_extent()` Getter of EXTENT attribute.
`(package private) boolean`	`_literalQuestion()` Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN).
`java.lang.String`	`_name()` Get the `name` attribute of handle as a string.
`(package private) P2JField`	`asP2JField()` Convert the information about this field at the current moment into a `P2JField` object and return it.
`logical`	`available()` Indicate one of the following conditions.
`handle`	`bufferHandle()` Returns the handle of the buffer object to which the buffer-field belongs.
`character`	`bufferName()` Conversion of BUFFER-NAME attribute (KW_BUF_NAME).
`logical`	`caseSensitive()` Getter of CASE-SENSITIVE attribute.
`void`	`changeLiteralQuestion(logical literalQuestion)` Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN).
`void`	`changeValidateExpression(character validateExpression)` Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR).
`void`	`changeValidateMessage(character validateMessage)` Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG).
`void`	`changeValue(int index, java.lang.Object newValue)` Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
`private void`	`changeValue(int index, java.lang.Object newValue, boolean validate)` Change the value of a specific element of an extent field, optionally validating the supplied subscript.
`void`	`changeValue(NumberType index, java.lang.Object newValue)` Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
`void`	`changeValue(java.lang.Object newValue)` Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
`private boolean`	`checkUnknown(java.lang.String attributeName, BaseDataType value)` Check if the provided value of the attribute is unknown and raise error in this case.
`private TableMapper.LegacyFieldInfo`	`computeLegacyInfo()` Extracts and returns the `LegacyFieldInfo` associated with this field.
`FieldReference`	`createFieldReference(java.lang.Integer extIndex)` Creates and returns a copy of the `FieldReference` held by this instance.
`integer`	`extent()` Conversion of EXTENT attribute (KW_EXTENT).
`(package private) void`	`forceDelete()` Force the delete of this BUFFER-FIELD.
`character`	`getADMData()` Get the value of the ADM-DATA attribute.
`Buffer`	`getBuffer()` Returns the handle of the buffer object to which the buffer-field belongs.
`character`	`getColumnLabel()` Getter of COLUMN-LABEL attribute.
`character`	`getDataType()` Returns the value of the DATA-TYPE attribute
`character`	`getDbName()` Returns the state of the DBNAME attribute
`integer`	`getDecimals()` Obtain the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
`character`	`getDefaultString()` Get the DEFAULT-STRING attribute.
`BaseDataType`	`getDefaultValue()` Get the DEFAULT-VALUE attribute.
`(package private) Buffer`	`getDMOProxy()` Get the DMO proxy which references parent buffer.
`character`	`getFormat()` Getter of FORMAT attribute.
`decimal`	`getHeight()` Get the HEIGHT Progress attribute.
`decimal`	`getHeightChars()` HEIGHT-CHARS attribute is not defined for BUFFER-FIELD handle.
`integer`	`getHeightPixels()` HEIGHT-PIXELS attribute is not defined for BUFFER-FIELD handle.
`character`	`getHelp()` Returns the value of the HELP attribute
`character`	`getLabel()` Returns the value of the LABEL attribute
`(package private) java.lang.String`	`getLcLegacyName()` Get the lowercased legacy name.
`java.lang.String`	`getOriginalPropertyName()` Get the original property name of this field.
`private RecordBuffer`	`getParentBuffer()` Get the parent record buffer.
`java.lang.String`	`getProperty()` Get the property name of this field.
`logical`	`getSerializeHidden()` Checks whether fields are written when the temp-table is serialized, for example into JSON or XML.
`character`	`getSerializeName()` Implementation of the read access of the `SERIALIZE-NAME` attribute.
`character`	`getTable()` Returns the state of the TABLE attribute
`private TempTable`	`getTempTable()` Get the parent temp-table from the `fieldRef`.
`integer`	`getUniqueID()` Gets the the unique ID number associated to this object by the underlying system.
`decimal`	`getWidth()` Get the WIDTH Progress attribute.
`decimal`	`getWidthChars()` Get the WIDTH-CHARS attribute of this BUFFER-FIELD handle.
`integer`	`getWidthPixels()` WIDTH-PIXELS attribute is not defined for BUFFER-FIELD handle.
`character`	`getXmlDataType()` Obtain the XML Schema data type for the buffer-field object.
`character`	`getXmlNodeName()` Obtain the name of the XML element or attribute representing the target object (either a `DataSet`, a `TempTable`, a `TemporaryBuffer`, or a temp-table `BufferField`) name in an XML document.
`character`	`getXmlNodeType()` Obtain the XML node type of this object.
`protected boolean`	`hasNextSibling()` Check if this resource supports the NEXT-SIBLING attribute.
`protected boolean`	`hasPrevSibling()` Check if this resource supports the PREV-SIBLING attribute.
`character`	`initial()` Get the INITIAL attribute for the field.
`private BaseDataType`	`initialValue()` Get the value of INITIAL attribute as a BaseDataType.
`logical`	`isKey()` Checks whether this field participates in an index.
`logical`	`isReadOnly()` Checks whether the widget is write-protected.
`logical`	`literalQuestion()` Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN).
`logical`	`mandatory()` Conversion of MANDATORY attribute (KW_MAND).
`character`	`name()` Get the `name` attribute of a BUFFER-FIELD, which is the legacy name of the field referenced by this object.
`integer`	`position()` Gets the read-only POSITION attribute.
`protected boolean`	`processResource()` Buffer field resources are always generated lazily, and are being deleted by the parent BUFFER.
`protected boolean`	`resourceDelete()` Delete the resource.
`void`	`setADMData(character value)` Set the value of the ADM-DATA attribute.
`void`	`setADMData(java.lang.String value)` Set the value of the ADM-DATA attribute.
`void`	`setColumnLabel(character columnLabel)` Setter of COLUMN-LABEL attribute.
`void`	`setColumnLabel(java.lang.String columnLabel)` Setter of COLUMN-LABEL attribute.
`void`	`setDataType(character dataType)` Set the `DATA-TYPE` attribute..
`void`	`setDataType(java.lang.String dataType)` Set the `DATA-TYPE` attribute.
`void`	`setDecimals(long decimals)` Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
`void`	`setDecimals(NumberType decimals)` Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
`void`	`setDefaultString(character val)` Set the DEFAULT-STRING attribute.
`void`	`setDefaultString(java.lang.String val)` Set the DEFAULT-STRING attribute.
`void`	`setFormat(character format)` Setter of FORMAt attribute.
`void`	`setFormat(java.lang.String format)` Setter of FORMAT attribute.
`void`	`setHeight(NumberType heightChars)` Set the HEIGHT Progress attribute.
`void`	`setHeightChars(double h)` HEIGHT-CHARS attribute is not defined for BUFFER-FIELD handle.
`void`	`setHeightChars(NumberType h)` HEIGHT-CHARS attribute is not defined for BUFFER-FIELD handle.
`void`	`setHeightPixels(int heightPixels)` HEIGHT-PIXELS attribute is not defined for BUFFER-FIELD handle.
`void`	`setHeightPixels(NumberType heightPixels)` HEIGHT-PIXELS attribute is not defined for BUFFER-FIELD handle.
`void`	`setHelp(character help)` Set the `HELP` attribute of handle.
`void`	`setHelp(java.lang.String help)` Set the `HELP` attribute of handle.
`void`	`setLabel(character label)` Set the `LABEL` attribute of handle.
`void`	`setLabel(java.lang.String label)` Set the `LABEL` attribute of handle.
`void`	`setReadOnly(boolean ro)` Sets the READ-ONLY attribute of the widget.
`void`	`setReadOnly(logical ro)` Sets the READ-ONLY attribute of the widget.
`void`	`setSerializeHidden(boolean val)` Allow to configure whether fields are written when the temp-table is serialized, for example into JSON or XML.
`void`	`setSerializeHidden(logical val)` Allow to configure whether fields are written when the temp-table is serialized, for example into JSON or XML.
`void`	`setSerializeName(java.lang.String sName)` Implementation of the write access of the `SERIALIZE-NAME` attribute.
`void`	`setSerializeName(Text sName)` Implementation of the write access of the `SERIALIZE-NAME` attribute.
`void`	`setWidth(NumberType widthChars)` Set the WIDTH Progress attribute.
`void`	`setWidthChars(double widthChars)` Set the WIDTH-CHARS attribute of this BUFFER-FIELD handle.
`void`	`setWidthChars(NumberType widthChars)` Set the WIDTH-CHARS attribute of this BUFFER-FIELD handle.
`void`	`setWidthPixels(int widthPixels)` WIDTH-PIXELS attribute is not defined for BUFFER-FIELD handle.
`void`	`setWidthPixels(NumberType widthPixels)` WIDTH-PIXELS attribute is not defined for BUFFER-FIELD handle.
`void`	`setXmlDataType(java.lang.String newType)` Configures the XML Schema data type for the buffer-field object.
`void`	`setXmlDataType(Text newType)` Configures the XML Schema data type for the buffer-field object.
`void`	`setXmlNodeName(java.lang.String name)` Sets the name of the XML element or attribute representing the target object (either a `DataSet`, a `TempTable`, a `TemporaryBuffer`, or a temp-table `BufferField`) name in an XML document.
`void`	`setXmlNodeName(Text name)` Sets the name of the XML element or attribute representing the target object (either a `DataSet`, a `TempTable`, a `TemporaryBuffer`, or a temp-table `BufferField`) name in an XML document.
`void`	`setXmlNodeType(SerializeOptions.XmlNodeType newType)` Allows to specify how a this object will be represented in XML and XML Schema.
`void`	`setXmlNodeType(java.lang.String newType)` Allows to specify how a this object will be represented in XML and XML Schema.
`void`	`setXmlNodeType(Text newType)` Allows to specify how a this object will be represented in XML and XML Schema.
`character`	`stringValue()` Conversion of STRING-VALUE attribute (KW_STR_VAL).
`character`	`stringValue(int index)` Conversion of STRING-VALUE attribute (KW_STR_VAL).
`character`	`stringValue(NumberType index)` Conversion of STRING-VALUE attribute (KW_STR_VAL).
`java.lang.String`	`toString()` Provides a short description of this object used for debugging.
`boolean`	`valid()` Reports if this object is valid for use.
`private boolean`	`validateBufferFieldIndex(int index)` Validate the index passed to a BUFFER-VALUE method call.
`private boolean`	`validateBufferFieldIndex(NumberType index)` Validate the index passed to a BUFFER-VALUE method call.
`character`	`validateExpression()` Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR).
`character`	`validateMessage()` Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG).
`BaseDataType`	`value()` Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
`BaseDataType`	`value(int index)` Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
`private BaseDataType`	`value(int index, boolean validate)` Retrieve the value of a specific element of an extent field, optionally validating the supplied subscript.
`BaseDataType`	`value(NumberType index)` Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
`character`	`viewAs()` Get the BUFFER:VIEW-AS attribute.
`void`	`viewAs(character viewAs)` Set the BUFFER:VIEW-AS attribute.
`void`	`viewAs(java.lang.String viewAs)` Set the BUFFER:VIEW-AS attribute.

Methods inherited from class com.goldencode.p2j.util.HandleChain
delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNameReadOnly, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, registerResource, resourceType, setInstantiatingProcedure, type, unableToAssignUnknown, unknown

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

Methods inherited from interface com.goldencode.p2j.util.CommonField
setLabel

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete, delete

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
resourceType

Methods inherited from interface com.goldencode.util.Printable
asString, print

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger
  - fieldRef
```
private final FieldReference fieldRef
```
    FieldReference delegate object
  - admData
```
private java.lang.String admData
```
    Corresponds to ADM-DATA attribute.
  - uniqueID
```
private java.lang.Long uniqueID
```
    Corresponds to UNIQUE-ID attribute.
  - lfi
```
private final TableMapper.LegacyFieldInfo lfi
```
    The legacy info collected from table creation or modified afterwards.
  - mutableOptions
```
private boolean mutableOptions
```
    Flag for mutable options. This happens when the field belongs to a temp-table.
  - forceDelete
```
private boolean forceDelete
```
    Flag indicating if the delete must be forced.
  - key
```
private java.lang.Boolean key
```
    The key flag. Lazily initialized / computed.
  - viewAs
```
private java.lang.String viewAs
```
    The current value for VIEW-AS attribute.
  - readOnly
```
private boolean readOnly
```
    The current value for READ-ONLY attribute.
  - literalQuestion
```
private logical literalQuestion
```
    Explicit value of LITERAL-QUESTION attribute for database table fields.
  - columnLabel
```
private character columnLabel
```
    Explicit value of COLUMN-LABEL attribute for database table fields.
  - format
```
private character format
```
    Explicit value of FORMAT attribute for database table fields.
  - help
```
private character help
```
    Explicit value of HELP attribute for database table fields.
  - label
```
private character label
```
    Explicit value of LABEL attribute for database table fields.
  - validateExpression
```
private character validateExpression
```
    Explicit value of VALIDATE-EXPRESSION attribute for database table fields.
  - validateMessage
```
private character validateMessage
```
    Explicit value of VALIDATE-MESSAGE attribute for database table fields.
  - serializeHidden
```
private logical serializeHidden
```
    Explicit value of SERIALIZE-HIDDEN attribute for database table fields.
  - serializeName
```
private character serializeName
```
    Explicit value of SERIALIZE-NAME attribute for database table fields.
  - xmlDataType
```
private character xmlDataType
```
    Explicit value of XML-DATA-TYPE attribute for database table fields.
  - xmlNodeName
```
private character xmlNodeName
```
    Explicit value of XML-NODE-NAME attribute for database table fields.
  - xmlNodeType
```
private character xmlNodeType
```
    Explicit value of XML-NODE-TYPE attribute for database table fields.
  - dataType
```
private java.lang.String dataType
```
    The calculated field's data-type.
- Constructor Detail
  - BufferFieldImpl
```
BufferFieldImpl(java.lang.Object instProc,
                DataModelObject dmo,
                java.lang.String property)
```
    Create a new field reference given a DMO proxy and property name. A non-indexed getter method will be used to resolve the field.
    
    Parameters:
    
    instProc - The parent buffer's instantiating-procedure.
    
    dmo - DMO proxy.
    
    property - Target property name.
  - BufferFieldImpl
```
BufferFieldImpl(java.lang.Object instProc,
                DataModelObject dmo,
                java.lang.String property,
                boolean bulk)
```
    Create a new field reference given a DMO proxy and property name. A non-indexed getter method will be used to resolve the field.
    
    Parameters:
    
    instProc - The parent buffer's instantiating-procedure.
    
    dmo - DMO proxy.
    
    property - Target property name.
    
    bulk - When the reference is an EXTENT field and index is null the bulk getter/setter will be used.
  - BufferFieldImpl
```
private BufferFieldImpl(java.lang.Object instProc,
                        DataModelObject dmo,
                        java.lang.String property,
                        boolean uppercase,
                        NumberType index,
                        boolean bulk)
```
    Create a new field reference given a DMO proxy, a property name, and an index for the property. An indexed getter method will be used to resolve the field.
    
    Parameters:
    
    instProc - The parent buffer's instantiating-procedure.
    
    dmo - DMO proxy.
    
    property - Target property name.
    
    uppercase - true to force a character value to be uppercased/right-trimmed; false to leave the result unchanged.
    
    index - Index to pass to property's getter method at resolve time.
    
    bulk - When the reference is an EXTENT field and index is null the bulk getter/setter will be used.
    
    Throws:
    
    java.lang.IllegalArgumentException - if field reference is not recognized.
  - BufferFieldImpl
```
private BufferFieldImpl(FieldReference fieldRef,
                        int index,
                        TableMapper.LegacyFieldInfo lfi)
```
    Create an instance of this class which accesses a specific element of an extent field, given a field reference for the same DMO property, which does not reference a specific element of that field.
    
    Parameters:
    
    fieldRef - A reference to an extent field, which does not have an index into a specific element.
    
    index - A one-based index into an extent field.
    
    lfi - The legacy field info (used in case of denormalized fields)
- Method Detail
  - processResource
```
protected boolean processResource()
```
    Buffer field resources are always generated lazily, and are being deleted by the parent BUFFER. For this reason, they will not be processed at the external program where they are lazily created.
    
    Overrides:
    
    processResource in class HandleResource
    
    Returns:
    
    Always false.
  - name
```
public character name()
```
    Get the name attribute of a BUFFER-FIELD, which is the legacy name of the field referenced by this object.
    
    Specified by:
    
    name in interface Nameable
    
    Overrides:
    
    name in class HandleChain
    
    Returns:
    
    See above.
  - _name
```
public java.lang.String _name()
```
    Get the name attribute of handle as a string.
    
    Overrides:
    
    _name in class HandleChain
    
    Returns:
    
    See above.
  - available
```
public logical available()
```
    Indicate one of the following conditions.
    
    Specified by:
    
    available in interface Available
    
    Returns:
    
    true if the query buffer has a record with a field available that corresponds to this buffer-field object handle; false if the query buffer has a record with the field missing that corresponds to this buffer-field object handle; Unknown value (?) if the query buffer associated with this buffer-field object handle has no record..
  - extent
```
public integer extent()
```
    Conversion of EXTENT attribute (KW_EXTENT). Getter of EXTENT attribute.
    
    Specified by:
    
    extent in interface BufferField
    
    Returns:
    
    the value of EXTENT attribute.
  - initial
```
public character initial()
```
    Get the INITIAL attribute for the field.
    The value of the INITIAL schema field (which is always CHARACTER), formatted with the buffer-field's format. If the INITIAL schema field has the Unknown value (?), the value of the INITIAL attribute is the null string ("").
    
    Specified by:
    
    initial in interface BufferField
    
    Returns:
    
    Current value of INITIAL attribute.
  - stringValue
```
public character stringValue()
```
    Conversion of STRING-VALUE attribute (KW_STR_VAL). Getter of STRING-VALUE attribute. The STRING-VALUE( ) method uses the format attribute to convert the buffer value to a string.
    
    Specified by:
    
    stringValue in interface BufferField
    
    Returns:
    
    current value of STRING-VALUE attribute.
  - stringValue
```
public character stringValue(int index)
```
    Conversion of STRING-VALUE attribute (KW_STR_VAL). Getter of STRING-VALUE attribute. The STRING-VALUE( ) method uses the format attribute to convert the buffer value to a string.
    
    Specified by:
    
    stringValue in interface BufferField
    
    Parameters:
    
    index - An integer expression representing a subscript, for fields that have extents.
    
    Returns:
    
    current value of STRING-VALUE attribute.
  - stringValue
```
public character stringValue(NumberType index)
```
    Conversion of STRING-VALUE attribute (KW_STR_VAL). Getter of STRING-VALUE attribute. The STRING-VALUE( ) method uses the format attribute to convert the buffer value to a string.
    
    Specified by:
    
    stringValue in interface BufferField
    
    Parameters:
    
    index - An integer expression representing a subscript, for fields that have extents.
    
    Returns:
    
    Current value of STRING-VALUE attribute.
  - value
```
public BaseDataType value(int index)
```
    Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Getter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.
    
    Specified by:
    
    value in interface BufferField
    
    Parameters:
    
    index - A base-1 INTEGER expression representing a subscript, for fields that have extents.
    
    Returns:
    
    Current value of a buffer-field object.
  - value
```
public BaseDataType value(NumberType index)
```
    Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Getter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.
    
    Specified by:
    
    value in interface BufferField
    
    Parameters:
    
    index - A base-1 INTEGER expression representing a subscript, for fields that have extents.
    
    Returns:
    
    Current value of a buffer-field object if the object is an extent field or unknown if it is a scalar one.
  - changeValue
```
public void changeValue(int index,
                        java.lang.Object newValue)
```
    Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Setter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.
    
    Specified by:
    
    changeValue in interface BufferField
    
    Parameters:
    
    index - An INTEGER expression representing a subscript, for fields that have extents.
    
    newValue - New value of a buffer-field object.
  - changeValue
```
public void changeValue(NumberType index,
                        java.lang.Object newValue)
```
    Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Setter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.
    
    Specified by:
    
    changeValue in interface BufferField
    
    Parameters:
    
    index - An INTEGER expression representing a subscript, for fields that have extents.
    
    newValue - New value of a buffer-field object.
  - value
```
public BaseDataType value()
```
    Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Getter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.
    
    Specified by:
    
    value in interface BufferField
    
    Returns:
    
    Current value of a buffer-field object. If the field is an extent field, unknown value is returned.
  - changeValue
```
public void changeValue(java.lang.Object newValue)
```
    Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
    Setter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.
    Special care is taken when the field is a CHARACTER and the LITERAL-QUESTION is the default value false; in this case the
    - "?" is understand as the unknown literal (?) and
    - trailing blanks (spaces) for strings with total length less than 9 are removed. Note that the BUFFER-VALUE specification does not mention any thing about the string length, and also upholds that enclosing quotes are removed. The current implementation reflects the 4GL's behaviour obtained by manual testing.
    If LITERAL-QUESTION is set to yes the string are not affected.
    Specified by:
    
    changeValue in interface BufferField
    
    Parameters:
    
    newValue - New value of a buffer-field object.
  - bufferName
```
public character bufferName()
```
    Conversion of BUFFER-NAME attribute (KW_BUF_NAME). Gets the name of the buffer object to which the buffer-field object belongs.
    
    Specified by:
    
    bufferName in interface BufferField
    
    Returns:
    
    name of the buffer object to which the buffer-field object belongs.
  - bufferHandle
```
public handle bufferHandle()
```
    Returns the handle of the buffer object to which the buffer-field belongs.
    
    Specified by:
    
    bufferHandle in interface BufferField
    
    Returns:
    
    the handle of the buffer object to which the buffer-field belongs.
  - getBuffer
```
public Buffer getBuffer()
```
    Returns the handle of the buffer object to which the buffer-field belongs.
    
    Returns:
    
    the handle of the buffer object to which the buffer-field belongs.
  - literalQuestion
```
public logical literalQuestion()
```
    Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN). Getter of LITERAL-QUESTION attribute.
    
    Specified by:
    
    literalQuestion in interface BufferField
    
    Returns:
    
    current value of LITERAL-QUESTION attribute.
  - changeLiteralQuestion
```
public void changeLiteralQuestion(logical literalQuestion)
```
    Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN). Setter of LITERAL-QUESTION attribute.
    
    Specified by:
    
    changeLiteralQuestion in interface BufferField
    
    Parameters:
    
    literalQuestion - New value of LITERAL-QUESTION attribute.
  - validateMessage
```
public character validateMessage()
```
    Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG). Getter of VALIDATE-MESSAGE attribute.
    
    Specified by:
    
    validateMessage in interface BufferField
    
    Returns:
    
    current value of VALIDATE-MESSAGE attribute.
  - changeValidateMessage
```
public void changeValidateMessage(character validateMessage)
```
    Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG). Setter of VALIDATE-MESSAGE attribute.
    
    Specified by:
    
    changeValidateMessage in interface BufferField
    
    Parameters:
    
    validateMessage - New value of VALIDATE-MESSAGE attribute.
  - mandatory
```
public logical mandatory()
```
    Conversion of MANDATORY attribute (KW_MAND). Getter of KW_MAND attribute.
    
    Specified by:
    
    mandatory in interface BufferField
    
    Returns:
    
    current value of KW_MAND attribute.
  - position
```
public integer position()
```
    Gets the read-only POSITION attribute.
    
    Specified by:
    
    position in interface BufferField
    
    Returns:
    
    Current value of POSITION attribute.
  - validateExpression
```
public character validateExpression()
```
    Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR). Getter of VALIDATE-EXPRESSION attribute.
    
    Specified by:
    
    validateExpression in interface BufferField
    
    Returns:
    
    current value of VALIDATE-EXPRESSION attribute.
  - changeValidateExpression
```
public void changeValidateExpression(character validateExpression)
```
    Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR). Setter of VALIDATE-EXPRESSION attribute.
    
    Specified by:
    
    changeValidateExpression in interface BufferField
    
    Parameters:
    
    validateExpression - New value of VALIDATE-EXPRESSION attribute.
  - valid
```
public boolean valid()
```
    Reports if this object is valid for use.
    
    Specified by:
    
    valid in interface WrappedResource
    
    Returns:
    
    true if we are valid (can be used).
  - getDbName
```
public character getDbName()
```
    Returns the state of the DBNAME attribute
    
    Specified by:
    
    getDbName in interface DatabaseInfo
    
    Returns:
    
    Current value of the DBNAME attribute.
  - getTable
```
public character getTable()
```
    Returns the state of the TABLE attribute
    
    Specified by:
    
    getTable in interface DatabaseInfo
    
    Returns:
    
    Current value of the TABLE attribute.
  - getHeightChars
```
public decimal getHeightChars()
```
    HEIGHT-CHARS attribute is not defined for BUFFER-FIELD handle. Calls HandleResource.invalidAttribute(java.lang.String, boolean) to display appropriate error.
    
    Specified by:
    
    getHeightChars in interface Sizeable
    
    Returns:
    
    unknown value.
  - setHeightChars
```
public void setHeightChars(NumberType h)
```
    HEIGHT-CHARS attribute is not defined for BUFFER-FIELD handle. Calls HandleChain.readOnlyError(java.lang.String) to display appropriate error.
    
    Specified by:
    
    setHeightChars in interface Sizeable
    
    Parameters:
    
    h - Not used.
  - setHeightChars
```
public void setHeightChars(double h)
```
    HEIGHT-CHARS attribute is not defined for BUFFER-FIELD handle. Calls HandleChain.readOnlyError(java.lang.String) to display appropriate error.
    
    Specified by:
    
    setHeightChars in interface Sizeable
    
    Parameters:
    
    h - Not used.
  - getWidthChars
```
public decimal getWidthChars()
```
    Get the WIDTH-CHARS attribute of this BUFFER-FIELD handle. For buffer-field objects, the WIDTH-CHARS attribute is the number of characters in the STRING-VALUE, which the AVM calculates using the FORMAT attribute.
    
    Specified by:
    
    getWidthChars in interface Sizeable
    
    Returns:
    
    See above.
  - getWidth
```
public decimal getWidth()
```
    Get the WIDTH Progress attribute. The value is equal to the current component char width. This attribute is an alias for WIDTH-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-QUERY(widget, "WIDTH") works properly.
    
    Specified by:
    
    getWidth in interface Sizeable
    
    Returns:
    
    The integer value of the WIDTH attribute.
  - setWidthChars
```
public void setWidthChars(NumberType widthChars)
```
    Set the WIDTH-CHARS attribute of this BUFFER-FIELD handle. The WIDTH-CHARS attribute of a buffer-field is readable but not writeable.
    
    Specified by:
    
    setWidthChars in interface Sizeable
    
    Parameters:
    
    widthChars - The new value for the WIDTH-CHARS attribute.
  - setWidthChars
```
public void setWidthChars(double widthChars)
```
    Set the WIDTH-CHARS attribute of this BUFFER-FIELD handle. The WIDTH-CHARS attribute of a buffer-field is readable but not writeable.
    
    Specified by:
    
    setWidthChars in interface Sizeable
    
    Parameters:
    
    widthChars - The new value for the WIDTH-CHARS attribute.
  - setWidth
```
public void setWidth(NumberType widthChars)
```
    Set the WIDTH Progress attribute. This attribute is an alias for WIDTH-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-SET(widget, "WIDTH") works properly.
    
    Specified by:
    
    setWidth in interface Sizeable
    
    Parameters:
    
    widthChars - The integer value for the new WIDTH value.
  - getHeight
```
public decimal getHeight()
```
    Get the HEIGHT Progress attribute. The value is equal to the current component char height. This attribute is an alias for HEIGHT-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-QUERY(widget, "HEIGHT") works properly.
    
    Specified by:
    
    getHeight in interface Sizeable
    
    Returns:
    
    The integer value of the HEIGHT attribute.
  - setHeight
```
public void setHeight(NumberType heightChars)
```
    Set the HEIGHT Progress attribute. This attribute is an alias for HEIGHT-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-SET(widget, "HEIGHT") works properly.
    
    Specified by:
    
    setHeight in interface Sizeable
    
    Parameters:
    
    heightChars - The integer value for the new HEIGHT value.
  - getWidthPixels
```
public integer getWidthPixels()
```
    WIDTH-PIXELS attribute is not defined for BUFFER-FIELD handle. Calls HandleResource.invalidAttribute(java.lang.String, boolean) to display appropriate error.
    
    Specified by:
    
    getWidthPixels in interface Sizeable
    
    Returns:
    
    unknown value.
  - setWidthPixels
```
public void setWidthPixels(NumberType widthPixels)
```
    WIDTH-PIXELS attribute is not defined for BUFFER-FIELD handle. Calls HandleChain.readOnlyError(java.lang.String) to display appropriate error.
    
    Specified by:
    
    setWidthPixels in interface Sizeable
    
    Parameters:
    
    widthPixels - Not used.
  - setWidthPixels
```
public void setWidthPixels(int widthPixels)
```
    WIDTH-PIXELS attribute is not defined for BUFFER-FIELD handle. Calls HandleChain.readOnlyError(java.lang.String) to display appropriate error.
    
    Specified by:
    
    setWidthPixels in interface Sizeable
    
    Parameters:
    
    widthPixels - Not used.
  - getHeightPixels
```
public integer getHeightPixels()
```
    HEIGHT-PIXELS attribute is not defined for BUFFER-FIELD handle. Calls HandleResource.invalidAttribute(java.lang.String, boolean) to display appropriate error.
    
    Specified by:
    
    getHeightPixels in interface Sizeable
    
    Returns:
    
    unknown value.
  - setHeightPixels
```
public void setHeightPixels(NumberType heightPixels)
```
    HEIGHT-PIXELS attribute is not defined for BUFFER-FIELD handle. Calls HandleChain.readOnlyError(java.lang.String) to display appropriate error.
    
    Specified by:
    
    setHeightPixels in interface Sizeable
    
    Parameters:
    
    heightPixels - Not used.
  - setHeightPixels
```
public void setHeightPixels(int heightPixels)
```
    HEIGHT-PIXELS attribute is not defined for BUFFER-FIELD handle. Calls HandleChain.readOnlyError(java.lang.String) to display appropriate error.
    
    Specified by:
    
    setHeightPixels in interface Sizeable
    
    Parameters:
    
    heightPixels - Not used.
  - getFormat
```
public character getFormat()
```
    Getter of FORMAT attribute.
    
    Specified by:
    
    getFormat in interface CommonField
    
    Returns:
    
    current value of FORMAT attribute.
  - setFormat
```
public void setFormat(java.lang.String format)
```
    Setter of FORMAT attribute.
    
    Specified by:
    
    setFormat in interface CommonField
    
    Parameters:
    
    format - The new value.
  - setFormat
```
public void setFormat(character format)
```
    Setter of FORMAt attribute.
    
    Specified by:
    
    setFormat in interface CommonField
    
    Parameters:
    
    format - The new value.
  - getColumnLabel
```
public character getColumnLabel()
```
    Getter of COLUMN-LABEL attribute.
    
    Specified by:
    
    getColumnLabel in interface CommonField
    
    Returns:
    
    current value of COLUMN-LABEL attribute.
  - setColumnLabel
```
public void setColumnLabel(character columnLabel)
```
    Setter of COLUMN-LABEL attribute.
    
    Specified by:
    
    setColumnLabel in interface CommonField
    
    Parameters:
    
    columnLabel - New value of a attribute.
  - setColumnLabel
```
public void setColumnLabel(java.lang.String columnLabel)
```
    Setter of COLUMN-LABEL attribute.
    
    Specified by:
    
    setColumnLabel in interface CommonField
    
    Parameters:
    
    columnLabel - New value of a attribute.
  - getDataType
```
public character getDataType()
```
    Returns the value of the DATA-TYPE attribute
    
    Specified by:
    
    getDataType in interface CommonField
    
    Returns:
    
    Current value of the DATA-TYPE attribute.
  - setDataType
```
public void setDataType(java.lang.String dataType)
```
    Set the DATA-TYPE attribute.
    
    Specified by:
    
    setDataType in interface CommonField
    
    Parameters:
    
    dataType - The DATA-TYPE to be set.
  - setDataType
```
public void setDataType(character dataType)
```
    Set the DATA-TYPE attribute..
    
    Specified by:
    
    setDataType in interface CommonField
    
    Parameters:
    
    dataType - The DATA-TYPE to be set.
  - getLabel
```
public character getLabel()
```
    Returns the value of the LABEL attribute
    
    Specified by:
    
    getLabel in interface CommonField
    
    Returns:
    
    Current value of the LABEL attribute.
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Set the LABEL attribute of handle.
    
    Specified by:
    
    setLabel in interface CommonField
    
    Parameters:
    
    label - The LABEL to be set.
  - setLabel
```
public void setLabel(character label)
```
    Set the LABEL attribute of handle.
    
    Specified by:
    
    setLabel in interface CommonField
    
    Parameters:
    
    label - The LABEL to be set.
  - getADMData
```
public character getADMData()
```
    Get the value of the ADM-DATA attribute.
    
    Specified by:
    
    getADMData in interface ADMData
    
    Returns:
    
    See above.
  - setADMData
```
public void setADMData(java.lang.String value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - setADMData
```
public void setADMData(character value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - getUniqueID
```
public integer getUniqueID()
```
    Gets the the unique ID number associated to this object by the underlying system. Not the same as the handle value itself.
    
    Specified by:
    
    getUniqueID in interface UniqueID
    
    Returns:
    
    The integer number of the children.
  - caseSensitive
```
public logical caseSensitive()
```
    Getter of CASE-SENSITIVE attribute. Indicates whether the buffer-field is case-sensitive.
    
    Specified by:
    
    caseSensitive in interface BufferField
    
    Returns:
    
    current value of CASE-SENSITIVE attribute.
  - getSerializeName
```
public character getSerializeName()
```
    Implementation of the read access of the SERIALIZE-NAME attribute.
    
    Specified by:
    
    getSerializeName in interface NamedSerializable
    
    Returns:
    
    the current value of the SERIALIZE-NAME attribute.
  - setSerializeName
```
public void setSerializeName(Text sName)
```
    Implementation of the write access of the SERIALIZE-NAME attribute.
    
    Specified by:
    
    setSerializeName in interface NamedSerializable
    
    Parameters:
    
    sName - the new value for the SERIALIZE-NAME attribute.
  - setSerializeName
```
public void setSerializeName(java.lang.String sName)
```
    Implementation of the write access of the SERIALIZE-NAME attribute.
    
    Specified by:
    
    setSerializeName in interface NamedSerializable
    
    Parameters:
    
    sName - the new value for the SERIALIZE-NAME attribute.
  - getProperty
```
public java.lang.String getProperty()
```
    Get the property name of this field.
    
    Returns:
    
    property name of this field.
  - getOriginalPropertyName
```
public java.lang.String getOriginalPropertyName()
```
    Get the original property name of this field. If the original property is not defined (not a denormalized extent field), the normal property name is returned.
    
    Returns:
    
    property name of this field.
  - createFieldReference
```
public FieldReference createFieldReference(java.lang.Integer extIndex)
```
    Creates and returns a copy of the FieldReference held by this instance.
    
    Parameters:
    
    extIndex - The extent index. If none, null is accepted.
    
    Returns:
    
    Copy of the FieldReference held by this instance.
  - resourceDelete
```
protected boolean resourceDelete()
```
    Delete the resource. BUFFER-FIELD will be deleted only when the dynamic buffer is deleted. No resource-specific delete is required.
    
    Overrides:
    
    resourceDelete in class HandleResource
    
    Returns:
    
    true if the resource was deleted.
  - hasPrevSibling
```
protected boolean hasPrevSibling()
```
    Check if this resource supports the PREV-SIBLING attribute.
    
    Overrides:
    
    hasPrevSibling in class HandleChain
    
    Returns:
    
    Always false.
  - hasNextSibling
```
protected boolean hasNextSibling()
```
    Check if this resource supports the NEXT-SIBLING attribute.
    
    Overrides:
    
    hasNextSibling in class HandleChain
    
    Returns:
    
    Always false.
  - getDMOProxy
```
Buffer getDMOProxy()
```
    Get the DMO proxy which references parent buffer.
    
    Returns:
    
    DMO proxy object.
  - forceDelete
```
void forceDelete()
```
    Force the delete of this BUFFER-FIELD.
  - _extent
```
int _extent()
```
    Getter of EXTENT attribute.
    
    Returns:
    
    the value of EXTENT attribute.
  - value
```
private BaseDataType value(int index,
                           boolean validate)
```
    Retrieve the value of a specific element of an extent field, optionally validating the supplied subscript.
    
    Parameters:
    
    index - One-based subscript of the extent field to be changed.
    
    validate - true to validate index, else false.
  - changeValue
```
private void changeValue(int index,
                         java.lang.Object newValue,
                         boolean validate)
```
    Change the value of a specific element of an extent field, optionally validating the supplied subscript.
    
    Parameters:
    
    index - One-based subscript of the extent field to be changed.
    
    newValue - New value to set into the extent field.
    
    validate - true to validate index, else false.
  - validateBufferFieldIndex
```
private boolean validateBufferFieldIndex(NumberType index)
```
    Validate the index passed to a BUFFER-VALUE method call. For scalar fields, this value must be zero. For extent fields, this value must be a positive number less than or equal to the size of the extent field. Unknown value is invalid in either case.
    
    Parameters:
    
    index - Index value (unadjusted) provided by converted business logic.
    
    Returns:
    
    true if index is valid, else false.
    
    Throws:
    
    ErrorConditionException - if index is invalid and session is not in silent error mode.
  - validateBufferFieldIndex
```
private boolean validateBufferFieldIndex(int index)
```
    Validate the index passed to a BUFFER-VALUE method call. For scalar fields, this value must be zero. For extent fields, this value must be a positive number less than or equal to the size of the extent field. Unknown value is invalid in either case.
    
    Parameters:
    
    index - Index value (unadjusted) provided by converted business logic, or -1 if that value was unknown.
    
    Returns:
    
    true if index is valid, else false.
    
    Throws:
    
    ErrorConditionException - if index is invalid and session is not in silent error mode.
  - checkUnknown
```
private boolean checkUnknown(java.lang.String attributeName,
                             BaseDataType value)
```
    Check if the provided value of the attribute is unknown and raise error in this case.
    
    Parameters:
    
    attributeName - Name of the attribute which value is checked.
    
    value - Value of the attribute to be checked.
    
    Returns:
    
    false if the value is unknown.
  - getParentBuffer
```
private RecordBuffer getParentBuffer()
```
    Get the parent record buffer.
    
    Returns:
    
    parent record buffer.
  - getXmlDataType
```
public character getXmlDataType()
```
    Obtain the XML Schema data type for the buffer-field object.
    
    Specified by:
    
    getXmlDataType in interface XmlNode
    
    Returns:
    
    the XML Schema data type for the buffer-field object.
  - setXmlDataType
```
public void setXmlDataType(java.lang.String newType)
```
    Configures the XML Schema data type for the buffer-field object.
    
    Specified by:
    
    setXmlDataType in interface XmlNode
    
    Parameters:
    
    newType - the new XML Schema data type for the buffer-field object.
  - setXmlDataType
```
public void setXmlDataType(Text newType)
```
    Configures the XML Schema data type for the buffer-field object.
    
    Specified by:
    
    setXmlDataType in interface XmlNode
    
    Parameters:
    
    newType - the new XML Schema data type for the buffer-field object.
  - getXmlNodeType
```
public character getXmlNodeType()
```
    Obtain the XML node type of this object. This represents the getter for XML-NODE-TYPE ABL attribute.
    
    Specified by:
    
    getXmlNodeType in interface XmlNode
    
    Returns:
    
    the XML node type of this object.
  - setXmlNodeType
```
public void setXmlNodeType(Text newType)
```
    Allows to specify how a this object will be represented in XML and XML Schema. Valid XML node types are "ATTRIBUTE", "ELEMENT", "HIDDEN", and "TEXT". This represents the setter for XML-NODE-TYPE ABL attribute.
    
    Specified by:
    
    setXmlNodeType in interface XmlNode
    
    Parameters:
    
    newType - The new type.
  - setXmlNodeType
```
public void setXmlNodeType(java.lang.String newType)
```
    Allows to specify how a this object will be represented in XML and XML Schema. Valid XML node types are "ATTRIBUTE", "ELEMENT", "HIDDEN", and "TEXT". This represents the setter for XML-NODE-TYPE ABL attribute.
    
    Specified by:
    
    setXmlNodeType in interface XmlNode
    
    Parameters:
    
    newType - The new type.
  - setXmlNodeType
```
public void setXmlNodeType(SerializeOptions.XmlNodeType newType)
```
    Allows to specify how a this object will be represented in XML and XML Schema. Valid XML node types are "ATTRIBUTE", "ELEMENT", "HIDDEN", and "TEXT". This represents the setter for XML-NODE-TYPE ABL attribute.
    
    Parameters:
    
    newType - The new type.
  - getSerializeHidden
```
public logical getSerializeHidden()
```
    Checks whether fields are written when the temp-table is serialized, for example into JSON or XML. This represents the getter for SERIALIZE-HIDDEN ABL attribute.
    
    Specified by:
    
    getSerializeHidden in interface SerializeHiddenable
    
    Returns:
    
    true when the fields are hidden.
  - setSerializeHidden
```
public void setSerializeHidden(logical val)
```
    Allow to configure whether fields are written when the temp-table is serialized, for example into JSON or XML. This represents the setter for SERIALIZE-HIDDEN ABL attribute.
    
    Specified by:
    
    setSerializeHidden in interface SerializeHiddenable
    
    Parameters:
    
    val - true when the fields are hidden.
  - setSerializeHidden
```
public void setSerializeHidden(boolean val)
```
    Allow to configure whether fields are written when the temp-table is serialized, for example into JSON or XML. This represents the setter for SERIALIZE-HIDDEN ABL attribute.
    
    Specified by:
    
    setSerializeHidden in interface SerializeHiddenable
    
    Parameters:
    
    val - true when the fields are hidden.
  - getDecimals
```
public integer getDecimals()
```
    Obtain the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
    
    Specified by:
    
    getDecimals in interface BufferField
    
    Returns:
    
    the number of decimals after the decimal point for this buffer-field.
  - setDecimals
```
public void setDecimals(NumberType decimals)
```
    Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
    This attribute is writable for temp-tables but only read-only for permanent tables.
    
    Specified by:
    
    setDecimals in interface BufferField
    
    Parameters:
    
    decimals - The new number of decimals after the decimal point for this buffer-field.
  - setDecimals
```
public void setDecimals(long decimals)
```
    Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
    This attribute is writable for temp-tables but only read-only for permanent tables.
    
    Specified by:
    
    setDecimals in interface BufferField
    
    Parameters:
    
    decimals - The new number of decimals after the decimal point for this buffer-field.
  - isKey
```
public logical isKey()
```
    Checks whether this field participates in an index.
    
    Specified by:
    
    isKey in interface BufferField
    
    Returns:
    
    true if this field is part of an index.
  - getXmlNodeName
```
public character getXmlNodeName()
```
    Obtain the name of the XML element or attribute representing the target object (either a DataSet, a TempTable, a TemporaryBuffer, or a temp-table BufferField) name in an XML document.
    
    Specified by:
    
    getXmlNodeName in interface XmlNode
    
    Returns:
    
    the name of the XML element for this object.
  - setXmlNodeName
```
public void setXmlNodeName(java.lang.String name)
```
    Sets the name of the XML element or attribute representing the target object (either a DataSet, a TempTable, a TemporaryBuffer, or a temp-table BufferField) name in an XML document.
    
    Specified by:
    
    setXmlNodeName in interface XmlNode
    
    Parameters:
    
    name - The new name of the XML element for this object.
  - setXmlNodeName
```
public void setXmlNodeName(Text name)
```
    Sets the name of the XML element or attribute representing the target object (either a DataSet, a TempTable, a TemporaryBuffer, or a temp-table BufferField) name in an XML document.
    
    Specified by:
    
    setXmlNodeName in interface XmlNode
    
    Parameters:
    
    name - The new name of the XML element for this object.
  - getDefaultValue
```
public BaseDataType getDefaultValue()
```
    Get the DEFAULT-VALUE attribute. This is the initial value of the field in its proper data type. This is a polymorphic return type which must be specified as a BDT value even though it will have the actual data type of the field on return.
    
    Specified by:
    
    getDefaultValue in interface BufferField
    
    Returns:
    
    The default value of the field.
  - getDefaultString
```
public character getDefaultString()
```
    Get the DEFAULT-STRING attribute.
    
    Specified by:
    
    getDefaultString in interface BufferField
    
    Returns:
    
    See above.
  - setDefaultString
```
public void setDefaultString(java.lang.String val)
```
    Set the DEFAULT-STRING attribute.
    
    Specified by:
    
    setDefaultString in interface BufferField
    
    Parameters:
    
    val - The default-string value.
  - setDefaultString
```
public void setDefaultString(character val)
```
    Set the DEFAULT-STRING attribute.
    
    Specified by:
    
    setDefaultString in interface BufferField
    
    Parameters:
    
    val - The default-string value.
  - getHelp
```
public character getHelp()
```
    Returns the value of the HELP attribute
    
    Specified by:
    
    getHelp in interface CommonField
    
    Returns:
    
    Current value of the HELP attribute.
  - setHelp
```
public void setHelp(java.lang.String help)
```
    Set the HELP attribute of handle.
    
    Specified by:
    
    setHelp in interface CommonField
    
    Parameters:
    
    help - The HELP to be set.
  - setHelp
```
public void setHelp(character help)
```
    Set the HELP attribute of handle.
    
    Specified by:
    
    setHelp in interface CommonField
    
    Parameters:
    
    help - The HELP to be set.
  - toString
```
public java.lang.String toString()
```
    Provides a short description of this object used for debugging.
    
    Overrides:
    
    toString in class HandleResource
    
    Returns:
    
    a short description of this object used for debugging.
  - isReadOnly
```
public logical isReadOnly()
```
    Checks whether the widget is write-protected.
    
    Specified by:
    
    isReadOnly in interface WriteProtectable
    
    Returns:
    
    true if the widget is write-protected.
  - setReadOnly
```
public void setReadOnly(boolean ro)
```
    Sets the READ-ONLY attribute of the widget.
    
    Specified by:
    
    setReadOnly in interface WriteProtectable
    
    Parameters:
    
    ro - true if the widget should be write-protected.
  - setReadOnly
```
public void setReadOnly(logical ro)
```
    Sets the READ-ONLY attribute of the widget.
    
    Specified by:
    
    setReadOnly in interface WriteProtectable
    
    Parameters:
    
    ro - true if the widget should be write-protected.
  - viewAs
```
public character viewAs()
```
    Get the BUFFER:VIEW-AS attribute.
    
    Specified by:
    
    viewAs in interface BufferField
    
    Returns:
    
    the value of BUFFER:VIEW-AS attribute.
  - viewAs
```
public void viewAs(java.lang.String viewAs)
```
    Set the BUFFER:VIEW-AS attribute.
    
    Specified by:
    
    viewAs in interface BufferField
    
    Parameters:
    
    viewAs - The flag state.
  - viewAs
```
public void viewAs(character viewAs)
```
    Set the BUFFER:VIEW-AS attribute.
    
    Specified by:
    
    viewAs in interface BufferField
    
    Parameters:
    
    viewAs - The flag state.
  - asP2JField
```
P2JField asP2JField()
```
    Convert the information about this field at the current moment into a P2JField object and return it. Because some parts of the is not immutable, each time this method is invoked, a fresh object is created to reflect the current status.
    
    Returns:
    
    The attributes of the field encapsulated in a P2JField object.
  - _literalQuestion
```
boolean _literalQuestion()
```
    Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN). Getter of LITERAL-QUESTION attribute.
    
    Returns:
    
    current value of LITERAL-QUESTION attribute.
  - getLcLegacyName
```
java.lang.String getLcLegacyName()
```
    Get the lowercased legacy name.
    
    Returns:
    
    The lowercased legacy name.
  - initialValue
```
private BaseDataType initialValue()
```
    Get the value of INITIAL attribute as a BaseDataType.
    
    Returns:
    
    Current value of INITIAL attribute.
  - computeLegacyInfo
```
private TableMapper.LegacyFieldInfo computeLegacyInfo()
```
    Extracts and returns the LegacyFieldInfo associated with this field. This method also updates the mutableSerializationOptions if the field belongs to a temp-table.
    
    Returns:
    
    the LegacyFieldInfo associated with this field.
  - getTempTable
```
private TempTable getTempTable()
```
    Get the parent temp-table from the fieldRef.
    
    Returns:
    
    The parent TempTable instance, or null if this is not a temporary buffer.

Class BufferFieldImpl

Field Summary

Fields inherited from class com.goldencode.p2j.util.HandleChain

Fields inherited from class com.goldencode.p2j.util.HandleResource

Fields inherited from interface com.goldencode.p2j.persist.BufferField

Fields inherited from interface com.goldencode.p2j.persist.XmlNode

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.HandleChain

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.util.CommonField

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

Methods inherited from interface com.goldencode.p2j.util.Deletable

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

Methods inherited from interface com.goldencode.util.Printable

Field Detail

LOG

fieldRef

admData

uniqueID

lfi

mutableOptions

forceDelete

key

viewAs

readOnly

literalQuestion

columnLabel

format

help

label

validateExpression

validateMessage

serializeHidden

serializeName

xmlDataType

xmlNodeName

xmlNodeType

dataType

Constructor Detail

BufferFieldImpl

BufferFieldImpl

BufferFieldImpl

BufferFieldImpl

Method Detail

processResource

name

_name

available

extent

initial

stringValue

stringValue

stringValue

value

value

changeValue

changeValue

value

changeValue

bufferName

bufferHandle

getBuffer

literalQuestion

changeLiteralQuestion

validateMessage

changeValidateMessage

mandatory

position

validateExpression

changeValidateExpression

valid

getDbName

getTable

getHeightChars

setHeightChars

setHeightChars

getWidthChars

getWidth