FndAbstractArray (IFS Java Server Framework API documentation (for internal use only))

java.lang.Object
- ifs.fnd.record.FndAttribute
- - ifs.fnd.record.FndCompoundAttribute
  - - ifs.fnd.record.FndAbstractArray

All Implemented Interfaces:

FndSortField, FndRecordArraySerialization, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractLanguageCodeArray, AuthorizationInfoArray, AuthorizationObjectArray, CommandArray, ConfigParameterAreaArray, ConfigParameterArray, ConfigParameterGroupArray, ConfigParameterInstanceArray, FndArray, FndEjbOperationArray, FndEnumerationView.EnumerationValueArray, FndEnumerationView.PropertiesArray, FndListEjbOperationsArray, FndUserArray, PlsqlInvocationArray, PropagatedVariableArray
```
public abstract class FndAbstractArray
extends FndCompoundAttribute
implements FndRecordArraySerialization, java.lang.Cloneable
```
Abstract super-class for arrays. Subclasses of FndAbstractArray are generated from a model created in IFS Developer Studio.
See method sort(FndSortField...) that sorts records in an array according to a specified sequence of attributes and/or references.

See Also:

FndArray, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ifs.fnd.record.FndCompoundAttribute
  FndCompoundAttribute.Iterator

Field Summary
- Fields inherited from class ifs.fnd.record.FndAttribute
  meta, rec, value

Constructor Summary

Constructors
Constructor and Description
`FndAbstractArray()` Create a new instance
`FndAbstractArray(FndAttributeMeta meta)` Create a new instance
`FndAbstractArray(FndAttributeMeta meta, FndCompoundReference parentKeyInParent)` Create a new instance
`FndAbstractArray(java.lang.String name)` Create a new instance

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAll(FndAbstractArray array)` Deprecated. This method will be made protected in a future release.
`void`	`assign(FndAbstractArray array)` Deprecated. This method will be made protected in a future release.
`protected void`	`assign(FndAbstractArray from, boolean cloning)` Assigns the given array replacing the existing array, if any.
`protected void`	`assign(FndAttribute from)` Assigns the given array replacing the existing array, if any.
`void`	`clear()` Clears the contents of this attribute.
`java.lang.Object`	`clone()` Copy the array.
`protected void`	`copy(FndAttribute target, boolean cloning)` Copy the array.
`boolean`	`customQuery()` Check if the aggregate use framework or custom query functionality.
`protected void`	`formatAttributeToXml(FndXmlSerializer s, FndAttribute customAttr, FndAttributeXmlFormatter customFormatter)` Formats this object into the XML stream.
`void`	`formatRecordArray(FndTokenWriter stream)` Formats the array into an Fnd Buffer
`protected void`	`formatValue(FndTokenWriter stream, boolean releaseMemory)` Formats value of the array to an Fnd Buffer.
`protected void`	`formatValueToXml(FndXmlSerializer s)` Formats this attribute's value to the xml stream.
`protected java.util.List<FndAbstractRecord>`	`getInternalRecords()` Returns the records of the array as a List.
`int`	`getLength()` Returns the size of the array (number of elements).
`FndAbstractRecord`	`getTemplateRecord()` Returns the array type
`int`	`hashCode()` Return a hash code value for this array
`protected void`	`internalAdd(FndAbstractArray arr)` Adds elements of another array to this array.
`protected boolean`	`internalAdd(FndAbstractRecord rec)` Adds an element to the array.
`protected boolean`	`internalAdd(FndAbstractRecord rec, boolean setDirty)` Adds an element to the array.
`protected void`	`internalAdd(int i, FndAbstractRecord rec)`
`protected boolean`	`internalContains(FndAbstractRecord rec)`
`protected boolean`	`internalEquals(FndAbstractRecord rec)` Deprecated.
`protected FndAbstractRecord`	`internalFirstElement()`
`protected FndAbstractRecord`	`internalGet(int i)` Returns the untyped object at a specific index.
`protected int`	`internalIndexOf(FndAbstractRecord rec)`
`protected FndAbstractRecord`	`internalLastElement()`
`protected int`	`internalLastIndexOf(FndAbstractRecord rec)`
`protected FndAbstractRecord`	`internalRemove(int i)` Removes and returns an object from the array.
`protected FndAbstractRecord`	`internalSet(int i, FndAbstractRecord rec)`
`boolean`	`isNull()` Check if the array is null
`boolean`	`isVector()` Check if this is an array attribute
`protected void`	`load(java.util.List<FndAbstractRecord> records)` Sets the value of the array
`protected void`	`markStateRecursively(FndRecordState state)` Set record state on all records (recursively) in the array.
`protected abstract FndAttribute`	`newAttribute(FndAttributeMeta meta)` Create a new attribute of the same type.
`FndAbstractRecord`	`newRecord()` Creates a new record of the correct type for the array.
`protected FndAbstractRecord`	`newRecord(FndTokenReader stream)`
`protected void`	`parseBuffer(FndTokenReader stream)` Creates the array by parsing an Fnd Buffer
`void`	`parseRecordArray(FndTokenReader stream)` Creates the array by parsing an Fnd Buffer
`void`	`reset()` Empties the array and sets it to non-existent.
`int`	`serializedSize()` Approximates the size of the serialized form of this array.
`void`	`setNonExistent()` Clears the array and sets it to non-existent (as opposed to having an existing array having a null value)
`void`	`setNull()` Clears the array
`void`	`setState(FndRecordState state)` Set record state on all records (recursively) in the array.
`void`	`setTemplateRecord(FndAbstractRecord record)` Sets the datatype of the array
`int`	`size()` Returns the size of the array (number of elements)
`void`	`sort(java.util.Comparator<FndAbstractRecord> comparator)` Sorts the array according to the order induced by the specified comparator.
`void`	`sort(FndSortField... fields)` Sorts the array according to the specified sequence of sort fields.
`void`	`sort(java.lang.String orderBy)` Sorts the array according to the specified order by clause.
`void`	`sortOnAttribute(FndAttribute attr)` Sorts the array on a specific attribute.
`void`	`sortOnAttribute(FndAttribute attr, boolean reverse)` Sorts the array on a specific attribute.
`void`	`sortOnAttribute(java.lang.String str)` Sorts the array on a specific attribute.
`void`	`sortOnAttribute(java.lang.String str, boolean reverse)` Sorts the array on a specific attribute.
`void`	`sortOnState()` Sorts the array on record state.
`FndArray`	`transformToRecordArray()` Transform this array to an array of dynamic FndRecords.

Methods inherited from class ifs.fnd.record.FndCompoundAttribute
cascadeDelete, connectElement, connectElementToParent, containsDependentDetails, createCondition, format, getCompoundMeta, getParentKeyInParent, hasPersistentParts, isCompound, setParentKeyInElement, setParentKeyInParent

Methods inherited from class ifs.fnd.record.FndAttribute
addInvalidValueInfo, checkFormat, checkFormat, checkNotModified, checkNotModified, checkNotModified, checkNotModified, checkNotModified, checkNotModified, checkRange, checkRange, checkRange, checkRange, checkRange, checkRange, checkUpperCase, checkUpperCase, checkValuePresent, checkValuePresent, checkValuePresent, checkValuePresent, checkValuePresent, checkValuePresent, cloneValue, compareTo, createBetweenCondition, createEqualCondition, createGreaterThanCondition, createGreaterThanOrEqualCondition, createLessThanCondition, createLessThanOrEqualCondition, createNotEqualCondition, descending, exclude, exist, getColumns, getInnerTypes, getInvalidValueInfo, getMeta, getName, getParentRecord, getResultCategory, getSortDirection, getSqlType, getState, getType, hasValue, include, include, internalGetValue, internalSetValue, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, isDirty, isExcluded, isKey, isLong, isMandatory, isPartOfPrimaryKey, isQuery, isSet, isUpdateAllowed, parse, parseDatabaseString, parseString, parseXmlString, set, setDirty, setDirty, setExistent, setInvalidValueInfo, setMandatory, setName, setParentRecord, setQuery, setSqlValue, setState, setType, setUpdateAllowed, sortFieldIterator, toDatabaseString, toFndSqlValue, toString, unset, validate, validate

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

- Constructor Detail
  - FndAbstractArray
```
public FndAbstractArray()
```
    Create a new instance
  - FndAbstractArray
```
public FndAbstractArray(java.lang.String name)
```
    Create a new instance
    
    Parameters:
    
    name - attribute name
  - FndAbstractArray
```
public FndAbstractArray(FndAttributeMeta meta)
```
    Create a new instance
    
    Parameters:
    
    meta - attribute meta data
  - FndAbstractArray
```
public FndAbstractArray(FndAttributeMeta meta,
                        FndCompoundReference parentKeyInParent)
```
    Create a new instance
    
    Parameters:
    
    meta - attribute meta data
    
    parentKeyInParent - key in parent record
- Method Detail
  - setTemplateRecord
```
public final void setTemplateRecord(FndAbstractRecord record)
```
    Sets the datatype of the array
    
    Parameters:
    
    record - Determines the type of records that will be stored in the array
  - getTemplateRecord
```
public final FndAbstractRecord getTemplateRecord()
```
    Returns the array type
    
    Returns:
    
    A record of the type associated with the array
  - setNull
```
public final void setNull()
```
    Clears the array
    
    Overrides:
    
    setNull in class FndAttribute
  - setNonExistent
```
public final void setNonExistent()
```
    Clears the array and sets it to non-existent (as opposed to having an existing array having a null value)
    
    Overrides:
    
    setNonExistent in class FndAttribute
    
    See Also:
    
    FndAttribute.exist(), FndAbstractRecord.setNonExistent()
  - isNull
```
public final boolean isNull()
```
    Check if the array is null
    
    Overrides:
    
    isNull in class FndAttribute
    
    Returns:
    
    True if the array is empty (regardless of if it's existent or not)
  - isVector
```
public final boolean isVector()
```
    Check if this is an array attribute
    
    Overrides:
    
    isVector in class FndAttribute
    
    Returns:
    
    true
  - clear
```
public final void clear()
```
    Clears the contents of this attribute. The method clears the internal list with records and then calls super.clear().
    
    Overrides:
    
    clear in class FndAttribute
  - internalAdd
```
protected final boolean internalAdd(FndAbstractRecord rec)
```
    Adds an element to the array. Use add instead when working with typed arrays.
    
    Parameters:
    
    rec - Object to be added
    
    Returns:
    
    true
  - internalAdd
```
protected final boolean internalAdd(FndAbstractRecord rec,
                                    boolean setDirty)
```
    Adds an element to the array. Use add instead when working with typed arrays.
    
    Parameters:
    
    rec - Object to be added
    
    setDirty - true if the array should be marked as dirty, false otherwise
    
    Returns:
    
    true
  - internalAdd
```
protected final void internalAdd(int i,
                                 FndAbstractRecord rec)
```
  - internalAdd
```
protected final void internalAdd(FndAbstractArray arr)
```
    Adds elements of another array to this array.
    
    Parameters:
    
    arr - array the elements of which should be added to this array
  - internalContains
```
protected final boolean internalContains(FndAbstractRecord rec)
```
  - internalEquals
```
protected final boolean internalEquals(FndAbstractRecord rec)
```
    Deprecated.
  - hashCode
```
public final int hashCode()
```
    Return a hash code value for this array
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code value
  - internalFirstElement
```
protected final FndAbstractRecord internalFirstElement()
```
  - internalGet
```
protected final FndAbstractRecord internalGet(int i)
```
    Returns the untyped object at a specific index. Use typed function get instead if working with a typed array.
    
    Parameters:
    
    i - index
    
    Returns:
    
    Object at specified index
    
    Throws:
    
    IfsRuntimeException - if the index is out of range (index < 0 || index >= size())
  - internalIndexOf
```
protected final int internalIndexOf(FndAbstractRecord rec)
```
  - internalLastElement
```
protected final FndAbstractRecord internalLastElement()
```
  - internalLastIndexOf
```
protected final int internalLastIndexOf(FndAbstractRecord rec)
```
  - internalRemove
```
protected final FndAbstractRecord internalRemove(int i)
```
    Removes and returns an object from the array. Use the typed function remove when working with typed arrays.
    
    Parameters:
    
    i - Array index
    
    Returns:
    
    The removed object
  - internalSet
```
protected final FndAbstractRecord internalSet(int i,
                                              FndAbstractRecord rec)
```
  - reset
```
public final void reset()
```
    Empties the array and sets it to non-existent.
  - getInternalRecords
```
protected final java.util.List<FndAbstractRecord> getInternalRecords()
```
    Returns the records of the array as a List.
    
    Returns:
    
    List of records
  - load
```
protected final void load(java.util.List<FndAbstractRecord> records)
```
    Sets the value of the array
    
    Parameters:
    
    records - A List of records that the array will contain after the operation
  - size
```
public final int size()
```
    Returns the size of the array (number of elements)
    
    Returns:
    
    Size of the array
  - getLength
```
public final int getLength()
```
    Returns the size of the array (number of elements). (Internally calls the size() method)
    
    Overrides:
    
    getLength in class FndAttribute
    
    Returns:
    
    Size of the array
  - formatValue
```
protected final void formatValue(FndTokenWriter stream,
                                 boolean releaseMemory)
                          throws ParseException
```
    Formats value of the array to an Fnd Buffer.
    
    Overrides:
    
    formatValue in class FndAttribute
    
    Parameters:
    
    stream - Stream to which to write the resulting buffer
    
    releaseMemory - true if after formatting the attribute value should be cleared releasing the memory, false otherwise
    
    Throws:
    
    ParseException - Thrown if the data contained in the array cannot be serialized to an Fnd Buffer
  - serializedSize
```
public final int serializedSize()
```
    Approximates the size of the serialized form of this array.
    
    Returns:
    
    the number of bytes needed for the serialized form of this array
  - sort
```
public final void sort(java.lang.String orderBy)
```
    Sorts the array according to the specified order by clause. The clause contains a list of sort fields, each corresponding to one or more attributes. Every attribute in the list must be a simple (sortable) attribute contained in the main record or in one of its aggregates.
    In the following example it is assumed that arr is an array of PersonInfo instances, each having a non-empty aggregate ISOCountry.
```
     arr.sort("ISO_COUNTRY/DESCRIPTION, CREATION_DATE DESC");
 
```
    See method sort(FndSortField...) that supports better compile-time checking.
    Parameters:
    
    orderBy - String containing a list of attribute paths as created by FndSort.formatOrderByClause.
  - sort
```
public final void sort(FndSortField... fields)
                throws SystemException
```
    Sorts the array according to the specified sequence of sort fields. Every specified sort field is converted into a list of attributes. Every attribute in the list must be a simple (sortable) attribute contained in the element record or in one of its aggregates.
    In the following example it is assumed that arr is an array of PersonInfo instances, each having a non-empty aggregate ISOCountry. Note that the variable person which refers to the first element of the array is used just to define the ordering of records, it could be any other instance of PersonInfo.
```
    if(arr.size() > 0) {
       PersonInfo person = arr.get(0);
       arr.sort(person.iSOCountry().description, person.creationDate.descending());
    }
 
```
    Parameters:
    
    fields - instances of FndAttribute and/or FndCompoundReference that define the order of records
    
    Throws:
    
    SystemException - if the specified attributes/references are not contained in this array's element record type or in one of its aggregates
    
    See Also:
    
    sort(String), sortOnAttribute(String), sortOnAttribute(FndAttribute)
  - sortOnAttribute
```
public final void sortOnAttribute(FndAttribute attr)
```
    Sorts the array on a specific attribute. The elements will be sorted according to the value of the attribute.
    
    Parameters:
    
    attr - The attribute on which to sort the array
    
    See Also:
    
    sortOnAttribute(FndAttribute, boolean), sortOnAttribute(String), sort(FndSortField...)
  - sortOnAttribute
```
public final void sortOnAttribute(java.lang.String str)
```
    Sorts the array on a specific attribute. The elements will be sorted according to the value of the attribute.
    
    Parameters:
    
    str - The name of the attribute on which to do the sorting
    
    See Also:
    
    sortOnAttribute(String, boolean), sortOnAttribute(FndAttribute), sort(FndSortField...)
  - sortOnAttribute
```
public final void sortOnAttribute(FndAttribute attr,
                                  boolean reverse)
```
    Sorts the array on a specific attribute. The elements will be sorted according to the value of the attribute.
    
    Parameters:
    
    attr - The attribute on which to sort the array
    
    reverse - True if the sorting should be done in the reverse order
    
    See Also:
    
    sort(FndSortField...)
  - sortOnAttribute
```
public final void sortOnAttribute(java.lang.String str,
                                  boolean reverse)
```
    Sorts the array on a specific attribute. The elements will be sorted according to the value of the attribute.
    
    Parameters:
    
    str - The name of the attribute on which to do the sorting
    
    reverse - True if the sorting should be done in the reverse order
    
    See Also:
    
    sort(FndSortField...)
  - sort
```
public final void sort(java.util.Comparator<FndAbstractRecord> comparator)
```
    Sorts the array according to the order induced by the specified comparator.
    
    Parameters:
    
    comparator - the comparator to determine the order of the array
  - sortOnState
```
public final void sortOnState()
```
    Sorts the array on record state. Removed records first, then new records and last modified records.
  - newRecord
```
protected FndAbstractRecord newRecord(FndTokenReader stream)
                               throws ParseException
```
    Throws:
    
    ParseException
  - newRecord
```
public FndAbstractRecord newRecord()
```
    Creates a new record of the correct type for the array.
    
    Returns:
    
    A new record of the type set by the setTemplateRecord function or FndRecord if not set
  - parseBuffer
```
protected final void parseBuffer(FndTokenReader stream)
                          throws ParseException
```
    Creates the array by parsing an Fnd Buffer
    
    Overrides:
    
    parseBuffer in class FndAttribute
    
    Parameters:
    
    stream - Stream from which to read the buffer to be parsed
    
    Throws:
    
    ParseException - Errors in parsing the buffers
  - parseRecordArray
```
public final void parseRecordArray(FndTokenReader stream)
                            throws ParseException
```
    Creates the array by parsing an Fnd Buffer
    
    Specified by:
    
    parseRecordArray in interface FndRecordArraySerialization
    
    Parameters:
    
    stream - Stream from which to read the buffer to be parsed
    
    Throws:
    
    ParseException - Errors in parsing the buffers
  - formatRecordArray
```
public final void formatRecordArray(FndTokenWriter stream)
                             throws ParseException
```
    Formats the array into an Fnd Buffer
    
    Specified by:
    
    formatRecordArray in interface FndRecordArraySerialization
    
    Parameters:
    
    stream - Stream to which to output the resulting buffer
    
    Throws:
    
    ParseException - Thrown if the buffer could not be created
  - formatAttributeToXml
```
protected final void formatAttributeToXml(FndXmlSerializer s,
                                          FndAttribute customAttr,
                                          FndAttributeXmlFormatter customFormatter)
                                   throws ParseException
```
    Formats this object into the XML stream.
    
    Overrides:
    
    formatAttributeToXml in class FndAttribute
    
    Parameters:
    
    s - XML serializer to which to append the attribute contents
    
    customAttr - top level attribute (tested with "==" operator) which will be formatted by the custom formatter
    
    customFormatter - formatter that will format the custom attribute value
    
    Throws:
    
    ParseException
  - formatValueToXml
```
protected final void formatValueToXml(FndXmlSerializer s)
```
    Formats this attribute's value to the xml stream.
    
    Overrides:
    
    formatValueToXml in class FndAttribute
    
    Parameters:
    
    s - XML serializer to which to add the value
  - assign
```
public final void assign(FndAbstractArray array)
```
    Deprecated. This method will be made protected in a future release.
    
    Assigns the given array replacing the existing array, if any. Array elements will not be cloned. This is a very dangerous method! Do not use source array after a call to this method!
    
    Parameters:
    
    array - Array that will replace the existing values
  - assign
```
protected final void assign(FndAbstractArray from,
                            boolean cloning)
                     throws SystemException
```
    Assigns the given array replacing the existing array, if any. A call to this method with no cloning is very dangerous! Do not use source array after a call to this method if cloning is disabled.
    
    Parameters:
    
    from - Array that will replace the existing values
    
    cloning - Enable/disable cloning of source array
    
    Throws:
    
    SystemException
  - assign
```
protected final void assign(FndAttribute from)
                     throws SystemException
```
    Assigns the given array replacing the existing array, if any. (Array elements will be cloned) Argument must be an instance of FndAbstractArray.
    
    Overrides:
    
    assign in class FndAttribute
    
    Parameters:
    
    from - Attribute to copy value from.
    
    Throws:
    
    SystemException
  - addAll
```
public final boolean addAll(FndAbstractArray array)
```
    Deprecated. This method will be made protected in a future release.
    
    Appends the elements of the given array to the existing array. Returns true if the existing array is modified as a result of the operation.
    
    Parameters:
    
    array - Array that will be added
    
    Returns:
    
    true if the array was modified
  - setState
```
public final void setState(FndRecordState state)
```
    Set record state on all records (recursively) in the array.
    
    Parameters:
    
    state - record state
  - markStateRecursively
```
protected final void markStateRecursively(FndRecordState state)
```
    Set record state on all records (recursively) in the array.
    
    Parameters:
    
    state - record state
  - copy
```
protected final void copy(FndAttribute target,
                          boolean cloning)
                   throws java.lang.CloneNotSupportedException,
                          SystemException
```
    Copy the array. Clone all array elements and copy value of attribute flags.
    
    Overrides:
    
    copy in class FndAttribute
    
    Parameters:
    
    target - Array to copy to (must be an instance of FndAbstractArray).
    
    cloning - true if records should be cloned
    
    Throws:
    
    java.lang.CloneNotSupportedException
    
    SystemException
  - clone
```
public final java.lang.Object clone()
                             throws java.lang.CloneNotSupportedException
```
    Copy the array. All array elements will be cloned.
    
    Overrides:
    
    clone in class FndAttribute
    
    Returns:
    
    A copy of the array.
    
    Throws:
    
    java.lang.CloneNotSupportedException - if cloning is not implemented
  - newAttribute
```
protected abstract FndAttribute newAttribute(FndAttributeMeta meta)
```
    Create a new attribute of the same type.
    
    Overrides:
    
    newAttribute in class FndAttribute
    
    Parameters:
    
    meta - Meta-data
    
    Returns:
    
    New attribute instance.
  - customQuery
```
public boolean customQuery()
```
    Check if the aggregate use framework or custom query functionality.
    
    Returns:
    
    true if the aggregate use custom query implementation.
  - transformToRecordArray
```
public FndArray transformToRecordArray()
                                throws SystemException
```
    Transform this array to an array of dynamic FndRecords. The array and contained views will be invalid after this call.
    
    Returns:
    
    The newly created FndArray
    
    Throws:
    
    SystemException

Class FndAbstractArray

Nested Class Summary

Nested classes/interfaces inherited from class ifs.fnd.record.FndCompoundAttribute

Field Summary

Fields inherited from class ifs.fnd.record.FndAttribute

Constructor Summary

Method Summary

Methods inherited from class ifs.fnd.record.FndCompoundAttribute

Methods inherited from class ifs.fnd.record.FndAttribute

Methods inherited from class java.lang.Object

Constructor Detail

FndAbstractArray

FndAbstractArray

FndAbstractArray

FndAbstractArray

Method Detail

setTemplateRecord

getTemplateRecord

setNull

setNonExistent

isNull

isVector

clear

internalAdd

internalAdd

internalAdd

internalAdd

internalContains

internalEquals

hashCode

internalFirstElement

internalGet

internalIndexOf

internalLastElement

internalLastIndexOf

internalRemove

internalSet

reset

getInternalRecords

load

size

getLength

formatValue

serializedSize

sort

sort

sortOnAttribute

sortOnAttribute

sortOnAttribute

sortOnAttribute

sort

sortOnState

newRecord

newRecord

parseBuffer

parseRecordArray

formatRecordArray

formatAttributeToXml

formatValueToXml

assign

assign

assign

addAll

setState

markStateRecursively

copy

clone

newAttribute

customQuery

transformToRecordArray