ifs.fnd.record

Class FndSimpleArray

java.lang.Object

ifs.fnd.record.FndAttribute

ifs.fnd.record.FndBinary

ifs.fnd.record.FndSimpleArray

All Implemented Interfaces:

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

public final class FndSimpleArray
extends FndBinary

An extension of FndBinary attribute that holds an array of simple java types. The type of elements is specified at construction time.

See Also:

setLongArray(long[]), setDoubleArray(double[]), setStringArray(java.lang.String[]), setDateArray(java.util.Date[]), setBinaryArray(byte[][]), setBooleanArray(boolean[]), getLongArray(), getDoubleArray(), getStringArray(), getDateArray(), getBinaryArray(), getBooleanArray(), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FndSimpleArray.ElementType Enumeration class that represents the type of array elements

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

FndAttribute.Iterator

Field Summary

Fields

Modifier and Type	Field and Description
static FndSimpleArray.ElementType	BINARY Constant indicating that the type of array elements is byte[].
static FndSimpleArray.ElementType	BOOLEAN Constant indicating that the type of array elements is boolean.
static FndSimpleArray.ElementType	DATE Constant indicating that the type of array elements is Date.
static FndSimpleArray.ElementType	DOUBLE Constant indicating that the type of array elements is double.
static FndSimpleArray.ElementType	LONG Constant indicating that the type of array elements is long.
static FndSimpleArray.ElementType	STRING Constant indicating that the type of array elements is String.

Fields inherited from class ifs.fnd.record.FndBinary

defaultEncoding

Fields inherited from class ifs.fnd.record.FndAttribute

meta, rec, value

Constructor Summary

Constructors

Constructor and Description
FndSimpleArray() Creates a new instance of FndSimpleArray with TEXT type of elements.
FndSimpleArray(FndAttributeMeta meta, FndSimpleArray.ElementType type) Creates a new instance of FndSimpleArray with the specified type of elements.
FndSimpleArray(java.lang.String name) Creates a new instance of FndSimpleArray with TEXT type of elements.
FndSimpleArray(java.lang.String name, FndSimpleArray.ElementType type) Creates a new instance of FndSimpleArray with the specified type of elements.

Method Summary

Modifier and Type	Method and Description
void	assign(FndBinary from) Sets the value of the attribute from another attribute.
FndSimpleArrayParser.DestArray	createDestArray(java.lang.String elementType) Creates a new instance of FndSimpleArrayParser.DestArray for given element type.
protected void	formatAttributeToXml(FndXmlSerializer s, FndAttribute customAttr, FndAttributeXmlFormatter customFormatter) Formats this object into the XML stream.
protected void	formatValueToXml(FndXmlSerializer s) Formats this attribute's value to the xml stream.
byte[][]	getBinaryArray() Retrieves an array of byte[] from the internal binary representation.
boolean[]	getBooleanArray() Retrieves an array of long from the internal binary representation.
java.util.Date[]	getDateArray() Retrieves an array of Date from the internal binary representation.
double[]	getDoubleArray() Retrieves an array of double from the internal binary representation.
FndSimpleArray.ElementType	getElementType() Returns the type of array elements.
long[]	getLongArray() Retrieves an array of long from the internal binary representation.
java.lang.String[]	getStringArray() Retrieves an array of String from the internal binary representation.
protected FndAttribute	newAttribute(FndAttributeMeta meta) Creates a new attribute based on meta-data.
void	setBinaryArray(byte[][] arr) Stores an array of byte[] in the internal binary representation.
void	setBooleanArray(boolean[] arr) Stores a boolean array in the internal binary representation.
void	setDateArray(java.util.Date[] arr) Stores a Date array in the internal binary representation.
void	setDoubleArray(double[] arr) Stores a double array in the internal binary representation.
void	setLongArray(long[] arr) Stores a long array in the internal binary representation.
void	setStringArray(java.lang.String[] arr) Stores a String array in the internal binary representation.
void	setValue(FndSimpleArray attribute) Copies the value from another FndSimpleArray
void	setValue(FndSimpleArrayParser.DestArray arr) Sets the value of this binary attribute.

Methods inherited from class ifs.fnd.record.FndBinary

clone, cloneValue, copy, createIsNotNullCondition, createIsNullCondition, formatValue, getCount, getDataAsString, getInputStreamManager, getLength, getOutputStreamManager, getSize, getSqlType, getValue, getValue, isLong, isNull, parseString, setInputStreamManager, setOutputStreamManager, setSqlValue, setValue, setValue, toFndSqlValue, toString, valueOf

Methods inherited from class ifs.fnd.record.FndAttribute

addInvalidValueInfo, assign, checkFormat, checkFormat, checkNotModified, checkNotModified, checkNotModified, checkNotModified, checkNotModified, checkNotModified, checkRange, checkRange, checkRange, checkRange, checkRange, checkRange, checkUpperCase, checkUpperCase, checkValuePresent, checkValuePresent, checkValuePresent, checkValuePresent, checkValuePresent, checkValuePresent, clear, compareTo, createBetweenCondition, createEqualCondition, createGreaterThanCondition, createGreaterThanOrEqualCondition, createLessThanCondition, createLessThanOrEqualCondition, createNotEqualCondition, descending, exclude, exist, getColumns, getInnerTypes, getInvalidValueInfo, getMeta, getName, getParentRecord, getResultCategory, getSortDirection, getState, getType, hasValue, include, include, internalGetValue, internalSetValue, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, invalidate, isCompound, isDirty, isExcluded, isKey, isMandatory, isPartOfPrimaryKey, isQuery, isSet, isUpdateAllowed, isVector, parse, parseBuffer, parseDatabaseString, parseXmlString, set, setDirty, setDirty, setExistent, setInvalidValueInfo, setMandatory, setName, setNonExistent, setNull, setParentRecord, setQuery, setState, setType, setUpdateAllowed, sortFieldIterator, toDatabaseString, unset, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

LONG

public static final FndSimpleArray.ElementType LONG

Constant indicating that the type of array elements is long.

DOUBLE

public static final FndSimpleArray.ElementType DOUBLE

Constant indicating that the type of array elements is double.

STRING

public static final FndSimpleArray.ElementType STRING

Constant indicating that the type of array elements is String.

DATE

public static final FndSimpleArray.ElementType DATE

Constant indicating that the type of array elements is Date.

BINARY

public static final FndSimpleArray.ElementType BINARY

Constant indicating that the type of array elements is byte[].

BOOLEAN

public static final FndSimpleArray.ElementType BOOLEAN

Constant indicating that the type of array elements is boolean.

Constructor Detail

FndSimpleArray

public FndSimpleArray()

Creates a new instance of FndSimpleArray with TEXT type of elements.

FndSimpleArray

public FndSimpleArray(java.lang.String name)

Creates a new instance of FndSimpleArray with TEXT type of elements.

Parameters:

name - the name of the attribute

FndSimpleArray

public FndSimpleArray(java.lang.String name,
                      FndSimpleArray.ElementType type)

Creates a new instance of FndSimpleArray with the specified type of elements.

Parameters:

name - the name of the attribute

type - the type of array elements

FndSimpleArray

public FndSimpleArray(FndAttributeMeta meta,
                      FndSimpleArray.ElementType type)

Creates a new instance of FndSimpleArray with the specified type of elements.

Method Detail

newAttribute

protected FndAttribute newAttribute(FndAttributeMeta meta)

Description copied from class: FndBinary

Creates a new attribute based on meta-data.

Overrides:

newAttribute in class FndBinary

Parameters:

meta - Meta-data to base the attribute on

Returns:

The created attribute

setValue

public void setValue(FndSimpleArray attribute)
              throws ApplicationException

Copies the value from another FndSimpleArray

Parameters:

attribute - Attribute to copy value from

Throws:

ApplicationException - Value out of range

assign

public void assign(FndBinary from)
            throws ApplicationException,
                   SystemException

Sets the value of the attribute from another attribute. The main difference between assign and setValue is that the value will be cloned in assign (if necessary). The attribute value will never be cloned in setValue.

Overrides:

assign in class FndBinary

Parameters:

from - Attribute to copy value from

Throws:

SystemException - Thrown if cloning fails

ApplicationException - Thrown if value if out of range for this attribute

formatAttributeToXml

protected 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 void formatValueToXml(FndXmlSerializer s)
                         throws ParseException

Formats this attribute's value to the xml stream.

Overrides:

formatValueToXml in class FndBinary

Parameters:

s - XML serializer to which to add the value

Throws:

ParseException

getElementType

public FndSimpleArray.ElementType getElementType()

Returns the type of array elements.

Returns:

an instance of nested class ElementType representing the type of array elements.

getDateArray

public java.util.Date[] getDateArray()
                              throws ParseException

Retrieves an array of Date from the internal binary representation.

Returns:

a Date array deserialized from the binary representation

Throws:

ParseException - if the internal binary representation has invalid format

setDateArray

public void setDateArray(java.util.Date[] arr)
                  throws IfsException

Stores a Date array in the internal binary representation.

Parameters:

arr - Date array to be serialized and stored as a value of this binary attribute

Throws:

IfsException - if the formatting process fails for any reason

getStringArray

public java.lang.String[] getStringArray()
                                  throws ParseException

Retrieves an array of String from the internal binary representation.

Returns:

a String array deserialized from the binary representation

Throws:

ParseException - if the internal binary representation has invalid format

setStringArray

public void setStringArray(java.lang.String[] arr)
                    throws IfsException

Stores a String array in the internal binary representation.

Parameters:

arr - String array to be serialized and stored as a value of this binary attribute

Throws:

IfsException - if the formatting process fails for any reason

getLongArray

public long[] getLongArray()
                    throws ParseException

Retrieves an array of long from the internal binary representation.

Returns:

a long array deserialized from the binary representation

Throws:

ParseException - if the internal binary representation has invalid format

setLongArray

public void setLongArray(long[] arr)
                  throws IfsException

Stores a long array in the internal binary representation.

Parameters:

arr - long array to be serialized and stored as a value of this binary attribute

Throws:

IfsException - if the formatting process fails for any reason

getBooleanArray

public boolean[] getBooleanArray()
                          throws ParseException

Retrieves an array of long from the internal binary representation.

Returns:

a long array deserialized from the binary representation

Throws:

ParseException - if the internal binary representation has invalid format

setBooleanArray

public void setBooleanArray(boolean[] arr)
                     throws IfsException

Stores a boolean array in the internal binary representation.

Parameters:

arr - boolean array to be serialized and stored as a value of this binary attribute

Throws:

IfsException - if the formatting process fails for any reason

getDoubleArray

public double[] getDoubleArray()
                        throws ParseException

Retrieves an array of double from the internal binary representation.

Returns:

double array deserialized from the binary representation

Throws:

ParseException - if the internal binary representation has invalid format

setDoubleArray

public void setDoubleArray(double[] arr)
                    throws IfsException

Stores a double array in the internal binary representation.

Parameters:

arr - double array to be serialized and stored as a value of this binary attribute

Throws:

IfsException - if the formatting process fails for any reason

getBinaryArray

public byte[][] getBinaryArray()
                        throws ParseException

Retrieves an array of byte[] from the internal binary representation.

Returns:

a byte[] array deserialized from the binary representation

Throws:

ParseException - if the internal binary representation has invalid format

setBinaryArray

public void setBinaryArray(byte[][] arr)
                    throws IfsException

Stores an array of byte[] in the internal binary representation.

Parameters:

arr - an array of byte[] to be serialized and stored as a value of this binary attribute

Throws:

IfsException - if the formatting process fails for any reason

createDestArray

public FndSimpleArrayParser.DestArray createDestArray(java.lang.String elementType)
                                               throws ParseException

Creates a new instance of FndSimpleArrayParser.DestArray for given element type.

Parameters:

elementType - the String representing the type of array elements

Returns:

an instance of FndSimpleArrayParser.DestArray, which may be used during parsing

Throws:

ParseException - if the specified element type is invalid

setValue

public void setValue(FndSimpleArrayParser.DestArray arr)
              throws IfsException

Sets the value of this binary attribute. A parsed instance of DestArray will be formatted into a binary value.

Parameters:

arr - an instance of FndSimpleArrayParser.DestArray

Throws:

IfsException - if the formatting process fails for any reason