ifs.fnd.record

Class FndAttribute

java.lang.Object

ifs.fnd.record.FndAttribute

All Implemented Interfaces:

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

Direct Known Subclasses:

FndBinary, FndBoolean, FndCompoundAttribute, FndCompoundItem, FndQueryableAttribute

public class FndAttribute
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, FndSortField

Super-class for all attribute types like FndAlpha, FndDate of FndText.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FndAttribute.Iterator An iterator over a list of attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected FndAttributeMeta	meta Meta-data of the attribute.
protected FndAbstractRecord	rec Pointer to the parent record.
protected java.lang.Object	value Value of the attribute.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FndAttribute()
protected	FndAttribute(FndAttributeMeta meta)
protected	FndAttribute(FndAttributeMeta meta, java.lang.Object value)
protected	FndAttribute(FndAttributeType type)
protected	FndAttribute(FndAttributeType type, java.lang.String name)
protected	FndAttribute(FndAttributeType type, java.lang.String name, java.lang.Object value)
protected	FndAttribute(java.lang.String name)
protected	FndAttribute(java.lang.String type, java.lang.String name)
protected	FndAttribute(java.lang.String type, java.lang.String name, java.lang.Object value)

Method Summary

Modifier and Type	Method and Description
void	addInvalidValueInfo(java.lang.String info) Marks the value of this attribute as invalid.
protected void	assign(FndAttribute from) Copy the value of an attribut to this attribute (attributes must be of the same type).
void	checkFormat() Performs the checks (upper case) indicated by the meta-data.
void	checkFormat(boolean abort) Performs the checks (upper case) indicated by the meta-data.
void	checkNotModified() Checks if the attribute value has been modified.
void	checkNotModified(boolean abort) Checks if the attribute value has been modified.
void	checkNotModified(FndTranslatableText msg) Checks if the attribute value has been modified.
void	checkNotModified(FndTranslatableText msg, boolean abort) Checks if the attribute value has been modified.
void	checkNotModified(java.lang.String msg) Deprecated. Use the method with a FndTranslatableText argument
void	checkNotModified(java.lang.String msg, boolean abort) Deprecated. Use the method with a FndTranslatableText argument
void	checkRange() Deprecated. This method does nothing. Validation of range is implemented by database layer.
void	checkRange(boolean abort) Deprecated. This method does nothing. Validation of range is implemented by database layer.
void	checkRange(FndTranslatableText msg) Deprecated. This method does nothing. Validation of range is implemented by database layer.
void	checkRange(FndTranslatableText msg, boolean abort) Deprecated. This method does nothing. Validation of range is implemented by database layer.
void	checkRange(java.lang.String msg) Deprecated. Use the method with a FndTranslatableText argument
void	checkRange(java.lang.String smsg, boolean abort) Deprecated. Use the method with a FndTranslatableText argument
void	checkUpperCase() Checks if the value is uppercase.
void	checkUpperCase(boolean abort) Checks if the value is uppercase.
boolean	checkValuePresent() Checks if the attribute has a value.
boolean	checkValuePresent(boolean abort) Checks if the attribute has a value.
boolean	checkValuePresent(FndTranslatableText msg) Checks if the attribute has a value, if not an exception is thrown with the provided message.
boolean	checkValuePresent(FndTranslatableText msg, boolean abort) Checks if the attribute has a value.
boolean	checkValuePresent(java.lang.String msg) Deprecated. Use the method with a FndTranslatableText argument
boolean	checkValuePresent(java.lang.String msg, boolean abort) Deprecated. Use the method with a FndTranslatableText argument
void	clear() Clears the contents of this attribute.
java.lang.Object	clone() Copies the attribute.
protected java.lang.Object	cloneValue() Clone the attribute value.
int	compareTo(FndAttribute attr) Compares two attributes for sorting purposes.
protected void	copy(FndAttribute target, boolean cloning) Copy the attribute flags and value.
protected FndSimpleCondition	createBetweenCondition(java.lang.Object value1, java.lang.Object value2) Create a "attribute between value1 and value2" condition on this attribute.
protected FndSimpleCondition	createEqualCondition(java.lang.Object value) Create a 'attribute = value" condition on this attribute.
protected FndSimpleCondition	createGreaterThanCondition(java.lang.Object value) Create a "attribute > value" condition on this attribute.
protected FndSimpleCondition	createGreaterThanOrEqualCondition(java.lang.Object value) Create a "attribute >= value" condition on this attribute.
protected FndSimpleCondition	createLessThanCondition(java.lang.Object value) Create a "attribute < value" condition on this attribute.
protected FndSimpleCondition	createLessThanOrEqualCondition(java.lang.Object value) Create a "attribute <= value" condition on this attribute.
protected FndSimpleCondition	createNotEqualCondition(java.lang.Object value) Create a "attribute <> value" condition on this attribute.
FndSortField	descending() Creates a new descending FndSortField.
void	exclude() Sets the exclude flag.
boolean	exist() Checks the exist flag.
protected void	formatAttributeToXml(FndXmlSerializer s, FndAttribute customAttr, FndAttributeXmlFormatter customFormatter) Formats this object into the XML stream.
protected void	formatValue(FndTokenWriter stream, boolean releaseMemory) Format the value of the attribute to an Fnd Buffer
protected void	formatValueToXml(FndXmlSerializer s) Formats this attribute's value to the xml stream.
protected java.lang.String[]	getColumns() Returns database column names from the meta-data.
protected FndAttributeType[]	getInnerTypes() Gets inner types from the meta-data
java.lang.String	getInvalidValueInfo() Gets the invalid value info for the current value.
int	getLength() Returns the length of the attribute.
FndAttributeMeta	getMeta() Returns meta-data for this attribute.
java.lang.String	getName() Returns the name of the attribute
FndAbstractRecord	getParentRecord() Get the parent record for this attribute.
FndQueryResultCategory	getResultCategory() Get the query result category set on the attribute.
FndSort.Direction	getSortDirection() Returns FndSort.ASCENDING, which is the default sort direction for an attribute.
protected FndSqlType	getSqlType() Get SQL type for attribute.
java.lang.String	getState() Returns string representation of attribute state as indicated by various flags.
FndAttributeType	getType() Returns type of the attribute
boolean	hasValue() Check if the attribute has been given a non-null value.
void	include() Clears the exclude flag.
void	include(FndQueryResultCategory category) Sets the include category for this attribute.
protected java.lang.Object	internalGetValue() Gets the value of the attribute.
protected void	internalSetValue(java.lang.Object value) Sets the value of the attribute.
void	invalidate(FndTranslatableText msg) Marks the value of this attribute as invalid.
void	invalidate(FndTranslatableText msg, java.lang.String p1) Marks the value of this attribute as invalid.
void	invalidate(FndTranslatableText msg, java.lang.String p1, java.lang.String p2) Marks the value of this attribute as invalid.
void	invalidate(FndTranslatableText msg, java.lang.String p1, java.lang.String p2, java.lang.String p3) Marks the value of this attribute as invalid.
void	invalidate(FndTranslatableText msg, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4) Marks the value of this attribute as invalid.
void	invalidate(FndTranslatableText msg, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5) Marks the value of this attribute as invalid.
void	invalidate(java.lang.String msg) Deprecated. Use the method with a FndTranslatableText argument
void	invalidate(java.lang.String msg, java.lang.String p1) Deprecated. Use the method with a FndTranslatableText argument
void	invalidate(java.lang.String msg, java.lang.String p1, java.lang.String p2) Deprecated. Use the method with a FndTranslatableText argument
void	invalidate(java.lang.String msg, java.lang.String p1, java.lang.String p2, java.lang.String p3) Deprecated. Use the method with a FndTranslatableText argument
void	invalidate(java.lang.String msg, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4) Deprecated. Use the method with a FndTranslatableText argument
void	invalidate(java.lang.String msg, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5) Deprecated. Use the method with a FndTranslatableText argument
boolean	isCompound() Check if this is a compound attribute or not (array/aggregate)
boolean	isDirty() Checks the dirty flag.
boolean	isExcluded() Checks the exclude flag.
boolean	isKey() Checks if this is a key.
boolean	isLong() Check if this is a long attribute or not (CLOB/BLOB storage).
boolean	isMandatory() Check if the attribute must have a value set
boolean	isNull() Checks if the attribute has a null value.
boolean	isPartOfPrimaryKey() Check if this attribute is a part of the primary key for the parent record
boolean	isQuery() Checks the query flag
boolean	isSet() Check if attribute has been set to a value or not.
boolean	isUpdateAllowed() Check if the attribute may be updated.
boolean	isVector() Checks if this attribute is an array.
protected FndAttribute	newAttribute(FndAttributeMeta meta) Creates a new attribute of the same type using supplied meta-data.
protected void	parse(FndTokenReader stream) Parses an Fnd Buffer to get the attribute.
protected void	parseBuffer(FndTokenReader stream)
protected void	parseDatabaseString(java.lang.String dbValue) Parses a database string to get the attribute's value.
void	parseString(java.lang.String value) Parses a string to get the attribute's value.
void	parseXmlString(java.lang.String s) This method is specially used for supporting few non printalbe chars and should be overridden by attributes where the string representation doesn't match that of it's internal storage object (value).
protected void	set() Sets the set-flag.
void	setDirty() Sets the dirty flag.
void	setDirty(boolean dirty) Sets or clears the dirty flag.
void	setExistent() Sets the exist flag.
void	setInvalidValueInfo(java.lang.String info) Marks the value of this attribute as invalid.
void	setMandatory(boolean mandatory) Set (or unset) the mandatory flag on the attribute.
protected void	setName(java.lang.String name) Sets the name of the attribute
void	setNonExistent() Clears the exist flag.
void	setNull() Clears attribute value.
protected void	setParentRecord(FndAbstractRecord rec)
void	setQuery(boolean query) Sets or clears the query flag.
protected void	setSqlValue(FndSqlData data, int colNr) Get value from database and set on this attribute (must be overridden for persistent attribute types)
void	setState(java.lang.String state) Sets the attribute state.
protected void	setType(FndAttributeType type) Sets type of the attribute
void	setUpdateAllowed(boolean updateable) Set (or unset) the updateable flag on the attribute.
FndAttribute.Iterator	sortFieldIterator() Returns an iterator over one attribute (this attribute).
protected java.lang.String	toDatabaseString() Gets database string representation of the attribute's value.
protected FndSqlValue	toFndSqlValue() Return a FndSqlValue based on the value of this attribute
java.lang.String	toString() Returns string representation of the attribute's value.
protected void	unset() Un-sets the set flag.
void	validate() Performs all applicable primitive attribute checks based on meta-data and flags about the attribute.
void	validate(boolean abort) Performs all applicable primitive attribute checks based on meta-data and flags about the attribute.

Methods inherited from class java.lang.Object

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

Field Detail

meta

protected FndAttributeMeta meta

Meta-data of the attribute.

value

protected java.lang.Object value

Value of the attribute.

rec

protected FndAbstractRecord rec

Pointer to the parent record.

Constructor Detail

FndAttribute

protected FndAttribute()

FndAttribute

protected FndAttribute(java.lang.String name)

FndAttribute

protected FndAttribute(java.lang.String type,
                       java.lang.String name)

FndAttribute

protected FndAttribute(java.lang.String type,
                       java.lang.String name,
                       java.lang.Object value)

FndAttribute

protected FndAttribute(FndAttributeType type)

FndAttribute

protected FndAttribute(FndAttributeType type,
                       java.lang.String name)

FndAttribute

protected FndAttribute(FndAttributeType type,
                       java.lang.String name,
                       java.lang.Object value)

FndAttribute

protected FndAttribute(FndAttributeMeta meta)

FndAttribute

protected FndAttribute(FndAttributeMeta meta,
                       java.lang.Object value)

Method Detail

newAttribute

protected FndAttribute newAttribute(FndAttributeMeta meta)

Creates a new attribute of the same type using supplied meta-data.

Parameters:

meta - Meta-data

Returns:

Created attribute

setInvalidValueInfo

public final void setInvalidValueInfo(java.lang.String info)

Marks the value of this attribute as invalid. The specified text will be not translated and it will replace the existing invalid value info, if any.

Parameters:

info - text that describes why the current value is invalid, or null to clear the invalid value status for this attribute.

See Also:

addInvalidValueInfo(java.lang.String), invalidate(java.lang.String), getInvalidValueInfo()

addInvalidValueInfo

public final void addInvalidValueInfo(java.lang.String info)

Marks the value of this attribute as invalid. The specified text will be not translated. If this attribute is already marked as invalid then the specified text will be appended to the existing invalid value info.

Parameters:

info - text that describes why the current value is invalid.

See Also:

setInvalidValueInfo(java.lang.String), invalidate(java.lang.String), getInvalidValueInfo()

getInvalidValueInfo

public final java.lang.String getInvalidValueInfo()

Gets the invalid value info for the current value.

Returns:

text that describes why the current attribute value is invalid, or null if the value is assumed to be valid.

See Also:

invalidate(java.lang.String)

invalidate

public final void invalidate(java.lang.String msg)

Deprecated. Use the method with a FndTranslatableText argument

Marks the value of this attribute as invalid. The method does not performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(java.lang.String msg,
                             java.lang.String p1)

Deprecated. Use the method with a FndTranslatableText argument

Marks the value of this attribute as invalid. The method does not performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(java.lang.String msg,
                             java.lang.String p1,
                             java.lang.String p2)

Deprecated. Use the method with a FndTranslatableText argument

Marks the value of this attribute as invalid. The method does not performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(java.lang.String msg,
                             java.lang.String p1,
                             java.lang.String p2,
                             java.lang.String p3)

Deprecated. Use the method with a FndTranslatableText argument

Marks the value of this attribute as invalid. The method dose not performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

p3 - third placeholder text

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(java.lang.String msg,
                             java.lang.String p1,
                             java.lang.String p2,
                             java.lang.String p3,
                             java.lang.String p4)

Deprecated. Use the method with a FndTranslatableText argument

Marks the value of this attribute as invalid. The method dose not performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

p3 - third placeholder text

p4 - fourth placeholder text

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(java.lang.String msg,
                             java.lang.String p1,
                             java.lang.String p2,
                             java.lang.String p3,
                             java.lang.String p4,
                             java.lang.String p5)

Deprecated. Use the method with a FndTranslatableText argument

Marks the value of this attribute as invalid. The method dose not performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

p3 - third placeholder text

p4 - fourth placeholder text

p5 - fifth placeholder text

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(FndTranslatableText msg)

Marks the value of this attribute as invalid. The method performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

Since:

4.1.0

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(FndTranslatableText msg,
                             java.lang.String p1)

Marks the value of this attribute as invalid. The method performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

Since:

4.1.0

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(FndTranslatableText msg,
                             java.lang.String p1,
                             java.lang.String p2)

Marks the value of this attribute as invalid. The method performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

Since:

4.1.0

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(FndTranslatableText msg,
                             java.lang.String p1,
                             java.lang.String p2,
                             java.lang.String p3)

Marks the value of this attribute as invalid. The method performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

p3 - third placeholder text

Since:

4.1.0

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(FndTranslatableText msg,
                             java.lang.String p1,
                             java.lang.String p2,
                             java.lang.String p3,
                             java.lang.String p4)

Marks the value of this attribute as invalid. The method performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

p3 - third placeholder text

p4 - fourth placeholder text

Since:

4.1.0

See Also:

getInvalidValueInfo()

invalidate

public final void invalidate(FndTranslatableText msg,
                             java.lang.String p1,
                             java.lang.String p2,
                             java.lang.String p3,
                             java.lang.String p4,
                             java.lang.String p5)

Marks the value of this attribute as invalid. The method performs translation of the specified message.

Parameters:

msg - text that describes why the current value is invalid.

p1 - first placeholder text

p2 - second placeholder text

p3 - third placeholder text

p4 - fourth placeholder text

p5 - fifth placeholder text

Since:

4.1.0

See Also:

getInvalidValueInfo()

checkValuePresent

public final boolean checkValuePresent()
                                throws ValidationException

Checks if the attribute has a value.

Returns:

true if the attribute has a value

Throws:

ValidationException - The attribute contains no value

checkValuePresent

public final boolean checkValuePresent(boolean abort)
                                throws ValidationException

Checks if the attribute has a value.

Parameters:

abort - true if execution should be aborted, false to store error message as invalid attribute info

Returns:

true if the attribute has a value, false otherwise

Throws:

ValidationException - The attribute contains no value

See Also:

invalidate(java.lang.String)

checkValuePresent

public final boolean checkValuePresent(java.lang.String msg)
                                throws ValidationException

Deprecated. Use the method with a FndTranslatableText argument

Checks if the attribute has a value, if not an exception is thrown with the provided message.

Parameters:

msg - Error message

Returns:

true if the attribute has a value

Throws:

ValidationException - The attribute contains no value

checkValuePresent

public final boolean checkValuePresent(FndTranslatableText msg)
                                throws ValidationException

Checks if the attribute has a value, if not an exception is thrown with the provided message.

Parameters:

msg - Error message

Returns:

true if the attribute has a value

Throws:

ValidationException - The attribute contains no value

Since:

4.1.0

checkValuePresent

public final boolean checkValuePresent(java.lang.String msg,
                                       boolean abort)
                                throws ValidationException

Deprecated. Use the method with a FndTranslatableText argument

Checks if the attribute has a value.

Parameters:

msg - Error message

abort - true if execution should be aborted, false to store error message as invalid attribute info

Returns:

true if the attribute has a value, false otherwise

Throws:

ValidationException - The attribute contains no value

See Also:

invalidate(java.lang.String)

checkValuePresent

public final boolean checkValuePresent(FndTranslatableText msg,
                                       boolean abort)
                                throws ValidationException

Checks if the attribute has a value.

Parameters:

msg - Error message

abort - true if execution should be aborted, false to store error message as invalid attribute info

Returns:

true if the attribute has a value, false otherwise

Throws:

ValidationException - The attribute contains no value

Since:

4.1.0

See Also:

invalidate(java.lang.String)

checkRange

public final void checkRange()
                      throws ValidationException

Deprecated. This method does nothing. Validation of range is implemented by database layer.

Checks the length of the value of the attribute against the max length specified in the meta-data.

Throws:

ValidationException

checkRange

public final void checkRange(boolean abort)

Deprecated. This method does nothing. Validation of range is implemented by database layer.

Checks the length of the value of the attribute against the max length specified in the meta-data.

Parameters:

abort - true if execution should be aborted, false to store error message as invalid attribute info

checkRange

public final void checkRange(java.lang.String msg)

Deprecated. Use the method with a FndTranslatableText argument

Checks the length of the value of the attribute against the max length specified in the meta-data.

Parameters:

msg - Error message

checkRange

public final void checkRange(FndTranslatableText msg)

Deprecated. This method does nothing. Validation of range is implemented by database layer.

Checks the length of the value of the attribute against the max length specified in the meta-data.

Parameters:

msg - Error message

Since:

4.1.0

checkRange

public final void checkRange(java.lang.String smsg,
                             boolean abort)

Deprecated. Use the method with a FndTranslatableText argument

Checks the length of the value of the attribute against the max length specified in the meta-data.

Parameters:

smsg - Error message

abort - true if execution should be aborted, false to store error message as invalid attribute info

See Also:

invalidate(java.lang.String)

checkRange

public final void checkRange(FndTranslatableText msg,
                             boolean abort)

Deprecated. This method does nothing. Validation of range is implemented by database layer.

Checks the length of the value of the attribute against the max length specified in the meta-data.

Parameters:

msg - Error message

abort - true if execution should be aborted, false to store error message as invalid attribute info

Since:

4.1.0

checkNotModified

public final void checkNotModified()
                            throws ValidationException

Checks if the attribute value has been modified.

Throws:

ValidationException - Attribute has been modified

checkNotModified

public final void checkNotModified(boolean abort)
                            throws ValidationException

Checks if the attribute value has been modified.

Parameters:

abort - true if execution should be aborted, false to store error message as invalid attribute info

Throws:

ValidationException - Attribute has been modified

See Also:

invalidate(java.lang.String)

checkNotModified

public final void checkNotModified(java.lang.String msg)
                            throws ValidationException

Deprecated. Use the method with a FndTranslatableText argument

Checks if the attribute value has been modified.

Parameters:

msg - Error message

Throws:

ValidationException - Attribute has been modified

checkNotModified

public final void checkNotModified(FndTranslatableText msg)
                            throws ValidationException

Checks if the attribute value has been modified.

Parameters:

msg - Error message

Throws:

ValidationException - Attribute has been modified

Since:

4.1.0

checkNotModified

public final void checkNotModified(java.lang.String msg,
                                   boolean abort)
                            throws ValidationException

Deprecated. Use the method with a FndTranslatableText argument

Checks if the attribute value has been modified.

Parameters:

msg - Error message

abort - true if execution should be aborted, false to store error message as invalid attribute info

Throws:

ValidationException - Attribute has been modified

See Also:

invalidate(java.lang.String)

checkNotModified

public final void checkNotModified(FndTranslatableText msg,
                                   boolean abort)
                            throws ValidationException

Checks if the attribute value has been modified.

Parameters:

msg - Error message

abort - true if execution should be aborted, false to store error message as invalid attribute info

Throws:

ValidationException - Attribute has been modified

Since:

4.1.0

See Also:

invalidate(java.lang.String)

validate

public final void validate()
                    throws ValidationException

Performs all applicable primitive attribute checks based on meta-data and flags about the attribute. For example checkValuePresent will be performed if the attribute is mandatory, checkFormat if it is of string type etc. Attributes in aggregated records will be validated recursively. Only dirty attributes will be validated.

Throws:

ValidationException - if validation fails

validate

public final void validate(boolean abort)
                    throws ValidationException

Performs all applicable primitive attribute checks based on meta-data and flags about the attribute. For example checkValuePresent will be performed if the attribute is mandatory, checkFormat if it is of string type etc. Attributes in aggregated records will be validated recursively. Only dirty attributes will be validated.

Parameters:

abort - true if execution should be aborted, false to store error message as invalid attribute info

Throws:

ValidationException - if validation fails

See Also:

invalidate(java.lang.String)

checkFormat

public final void checkFormat()
                       throws ValidationException

Performs the checks (upper case) indicated by the meta-data.

Throws:

ValidationException - A format check failed

checkFormat

public final void checkFormat(boolean abort)
                       throws ValidationException

Performs the checks (upper case) indicated by the meta-data.

Parameters:

abort - true if execution should be aborted, false to store error message as invalid attribute info

Throws:

ValidationException - A format check failed

See Also:

invalidate(java.lang.String)

checkUpperCase

public final void checkUpperCase()
                          throws ValidationException

Checks if the value is uppercase.

Throws:

ValidationException - The value is not upper case

checkUpperCase

public final void checkUpperCase(boolean abort)
                          throws ValidationException

Checks if the value is uppercase.

Parameters:

abort - true if execution should be aborted, false to store error message as invalid attribute info

Throws:

ValidationException - The value is not upper case

See Also:

invalidate(java.lang.String)

getLength

public int getLength()

Returns the length of the attribute. This method should be overidden in all attribute types that define the length to be anything other than the length of the value.toString().

Returns:

Length

getParentRecord

public final FndAbstractRecord getParentRecord()

Get the parent record for this attribute.

Returns:

parent record

setParentRecord

protected final void setParentRecord(FndAbstractRecord rec)

assign

protected void assign(FndAttribute from)
               throws SystemException

Copy the value of an attribut to this attribute (attributes must be of the same type). (Override this method for attributes with non-standard value storage (arrays and aggregates)).

Parameters:

from - Attribute to copy value from.

Throws:

SystemException

copy

protected void copy(FndAttribute target,
                    boolean cloning)
             throws java.lang.CloneNotSupportedException,
                    SystemException

Copy the attribute flags and value. Depending on the implementation of cloneValue() the attribute value may be copied or cloned.

Parameters:

target - Attribute to copy to.

cloning - true - clone value if necessary, false - never clone value

Throws:

java.lang.CloneNotSupportedException

SystemException

cloneValue

protected java.lang.Object cloneValue()
                               throws java.lang.CloneNotSupportedException

Clone the attribute value. This method must be overridden by subclasses where the value is a mutable object.

Returns:

The value of the attribute (no cloning in this case).

Throws:

java.lang.CloneNotSupportedException - if cloning is not implemented

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Copies the attribute. The internal value of the attribute will be cloned if necessary.

Overrides:

clone in class java.lang.Object

Returns:

A copy of the attribute.

Throws:

java.lang.CloneNotSupportedException - if cloning is not supported

getName

public final java.lang.String getName()

Returns the name of the attribute

Returns:

Name

setName

protected final void setName(java.lang.String name)

Sets the name of the attribute

Parameters:

name - Name

getType

public final FndAttributeType getType()

Returns type of the attribute

Returns:

Type

setType

protected final void setType(FndAttributeType type)

Sets type of the attribute

Parameters:

type - Type

getInnerTypes

protected final FndAttributeType[] getInnerTypes()

Gets inner types from the meta-data

Returns:

Inner types

getColumns

protected final java.lang.String[] getColumns()

Returns database column names from the meta-data.

Returns:

Column names

getState

public final java.lang.String getState()

Returns string representation of attribute state as indicated by various flags.

Returns:

State

setState

public final void setState(java.lang.String state)

Sets the attribute state.

Parameters:

state - String to be parsed for state flags

getMeta

public final FndAttributeMeta getMeta()

Returns meta-data for this attribute.

Returns:

Meta-data

isKey

public final boolean isKey()

Checks if this is a key.

Returns:

true if attribute is key

isDirty

public final boolean isDirty()

Checks the dirty flag.

Returns:

true if dirty

isVector

public boolean isVector()

Checks if this attribute is an array.

Returns:

false

exist

public final boolean exist()

Checks the exist flag. An attribute may be non-existent because a client application did not send it to the server or because it has explicitly been set so.

Returns:

true if the exist flag is set, false otherwise

See Also:

setNonExistent()

clear

public void clear()

Clears the contents of this attribute. The method nullifies the value and sets the flag field to the default value.

setNonExistent

public void setNonExistent()

Clears the exist flag. A non-existent attribute is ignored by most framework methods, for example such attribute is not saved in the database and is not sent back to the client application.

See Also:

exist(), FndAbstractRecord.setNonExistent()

setExistent

public final void setExistent()

Sets the exist flag.

See Also:

exist()

isUpdateAllowed

public final boolean isUpdateAllowed()

Check if the attribute may be updated.

Returns:

true if the attribute value may be updated

setUpdateAllowed

public final void setUpdateAllowed(boolean updateable)

Set (or unset) the updateable flag on the attribute. This affects buffer serialization and validations.

Parameters:

updateable - indicates if the attribute is updateable

isMandatory

public final boolean isMandatory()

Check if the attribute must have a value set

Returns:

true if the attribute must have a value

setMandatory

public final void setMandatory(boolean mandatory)

Set (or unset) the mandatory flag on the attribute. This affects buffer serialization and validations.

Parameters:

mandatory - indicates if mandatory should be true or false

setDirty

public final void setDirty()

Sets the dirty flag.

setDirty

public final void setDirty(boolean dirty)

Sets or clears the dirty flag.

Parameters:

dirty - Value to set the dirty flag to

setQuery

public final void setQuery(boolean query)

Sets or clears the query flag.

Parameters:

query - Value to set the query flag to

isQuery

public final boolean isQuery()

Checks the query flag

Returns:

true if query flag is set

exclude

public final void exclude()

Sets the exclude flag. Also sets the existent flag.

See class FndQueryResultCategory for example of usage.

include

public final void include()

Clears the exclude flag. Also sets the existent flag.

See class FndQueryResultCategory for example of usage.

include

public final void include(FndQueryResultCategory category)

Sets the include category for this attribute. Also sets the existent flag.

See class FndQueryResultCategory for example of usage.

Parameters:

category - any of the FndQueryResultCategory enumeration values.

isExcluded

public final boolean isExcluded()

Checks the exclude flag.

Returns:

true if exclude is set

isNull

public boolean isNull()

Checks if the attribute has a null value. (Use isSet() if you want to check if the attribute has been given a value.)

Returns:

true if no value

setNull

public void setNull()

Clears attribute value.

internalSetValue

protected final void internalSetValue(java.lang.Object value)

Sets the value of the attribute. Use the typed setValue functions for typed attributes instead.

Parameters:

value - Value to set the attribute to

internalGetValue

protected final java.lang.Object internalGetValue()

Gets the value of the attribute. Use the typed getValue function from sub-classes when working with typed attributes.

Returns:

Value

toString

public java.lang.String toString()

Returns string representation of the attribute's value.

Overrides:

toString in class java.lang.Object

Returns:

Value as string

toDatabaseString

protected java.lang.String toDatabaseString()

Gets database string representation of the attribute's value. The default implementation of this method just calls toString(), so the method should be overridden by attributes that have different string representations in database storage and in serialized stream.

Returns:

string used to store the value of this attribute in the database, or null if this attribute has no value

formatValue

protected void formatValue(FndTokenWriter stream,
                           boolean releaseMemory)
                    throws ParseException

Format the value of the attribute to an Fnd Buffer

Parameters:

stream - Stream to which to write the buffer

releaseMemory - true if after formatting the attribute value should be cleared releasing the memory, false otherwise

Throws:

ParseException - Attribute's value cannot be serialized into a buffer

parseString

public void parseString(java.lang.String value)
                 throws ParseException

Parses a string to get the attribute's value.

Parameters:

value - Value to set the attribute to

Throws:

ParseException - if value cannot be parsed (contains an illegal value).

parseXmlString

public void parseXmlString(java.lang.String s)
                    throws ParseException

This method is specially used for supporting few non printalbe chars and should be overridden by attributes where the string representation doesn't match that of it's internal storage object (value). Parses a XML string to get the attribute's value.

Parameters:

s - Value to set the attribute to

Throws:

ParseException - if value cannot be parsed (contains an illegal value).

parseDatabaseString

protected void parseDatabaseString(java.lang.String dbValue)
                            throws ParseException

Parses a database string to get the attribute's value. The default implementation of this method just calls parseString(), so the method should be overridden by attributes that have different string representations in database storage and in serialized stream.

Parameters:

dbValue - database string value

Throws:

ParseException - if the specified string contains an illegal value

parseBuffer

protected void parseBuffer(FndTokenReader stream)
                    throws ParseException

Throws:

ParseException

parse

protected void parse(FndTokenReader stream)
              throws ParseException

Parses an Fnd Buffer to get the attribute.

Parameters:

stream - Stream from which to read the buffer

Throws:

ParseException - Syntax error in buffer

formatAttributeToXml

protected void formatAttributeToXml(FndXmlSerializer s,
                                    FndAttribute customAttr,
                                    FndAttributeXmlFormatter customFormatter)
                             throws ParseException

Formats this object into the XML stream.

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.

Parameters:

s - XML serializer to which to add the value

Throws:

ParseException

compareTo

public int compareTo(FndAttribute attr)

Compares two attributes for sorting purposes. Overriden in sortable sub-classes.

Parameters:

attr - the attribute to compare this object to.

Returns:

0

isCompound

public boolean isCompound()

Check if this is a compound attribute or not (array/aggregate)

Returns:

false for non-compound attributes

toFndSqlValue

protected FndSqlValue toFndSqlValue()

Return a FndSqlValue based on the value of this attribute

setSqlValue

protected void setSqlValue(FndSqlData data,
                           int colNr)
                    throws IfsException

Get value from database and set on this attribute (must be overridden for persistent attribute types)

Parameters:

data - an instance of FndSqlData interface to get value from

colNr - column/parameter index number

Throws:

IfsException

isPartOfPrimaryKey

public final boolean isPartOfPrimaryKey()

Check if this attribute is a part of the primary key for the parent record

Returns:

true if this attribute is a part of the primary key

getSqlType

protected FndSqlType getSqlType()

Get SQL type for attribute.

isLong

public boolean isLong()

Check if this is a long attribute or not (CLOB/BLOB storage).

Returns:

true if this is a long attribute

isSet

public final boolean isSet()

Check if attribute has been set to a value or not. (Attribute may be existent but not have a value set.) Note that the value may be null.

Returns:

true if the attribute has been set.

set

protected final void set()

Sets the set-flag. (Stupid name...)

unset

protected final void unset()

Un-sets the set flag.

hasValue

public final boolean hasValue()

Check if the attribute has been given a non-null value.

Returns:

true if the attribute is existent and has been given a non-null value.

getResultCategory

public final FndQueryResultCategory getResultCategory()

Get the query result category set on the attribute.

Returns:

Result category set on the attribute.

createBetweenCondition

protected FndSimpleCondition createBetweenCondition(java.lang.Object value1,
                                                    java.lang.Object value2)

Create a "attribute between value1 and value2" condition on this attribute.

Parameters:

value1 - First value.

value2 - Second value.

Returns:

Created condition.

createEqualCondition

protected FndSimpleCondition createEqualCondition(java.lang.Object value)

Create a 'attribute = value" condition on this attribute.

Parameters:

value - Value attribute should be equal to.

Returns:

Created condition.

createGreaterThanCondition

protected FndSimpleCondition createGreaterThanCondition(java.lang.Object value)

Create a "attribute > value" condition on this attribute.

Parameters:

value - Value this attribute should be greater than.

Returns:

Created condition.

createGreaterThanOrEqualCondition

protected FndSimpleCondition createGreaterThanOrEqualCondition(java.lang.Object value)

Create a "attribute >= value" condition on this attribute.

Parameters:

value - Value this attribute should be greater than or equal to.

Returns:

Created condition

createLessThanCondition

protected FndSimpleCondition createLessThanCondition(java.lang.Object value)

Create a "attribute < value" condition on this attribute.

Parameters:

value - Value this attribute should be less than.

Returns:

Created condition

createLessThanOrEqualCondition

protected FndSimpleCondition createLessThanOrEqualCondition(java.lang.Object value)

Create a "attribute <= value" condition on this attribute.

Parameters:

value - Value this attribute should be less than or equal to.

Returns:

Created condition.

createNotEqualCondition

protected FndSimpleCondition createNotEqualCondition(java.lang.Object value)

Create a "attribute <> value" condition on this attribute.

Parameters:

value - Value attribute should not be equal to.

Returns:

Created condition.

sortFieldIterator

public final FndAttribute.Iterator sortFieldIterator()

Returns an iterator over one attribute (this attribute).

Specified by:

sortFieldIterator in interface FndSortField

Returns:

iterator

descending

public final FndSortField descending()

Creates a new descending FndSortField. The new sort field will contain only this attribute and the sort direction marked as descending. See class FndQueryRecord description for example of usage in a query.

Specified by:

descending in interface FndSortField

Returns:

a new instance of FndSortField

See Also:

FndAbstractArray.sort

getSortDirection

public final FndSort.Direction getSortDirection()

Returns FndSort.ASCENDING, which is the default sort direction for an attribute.

Specified by:

getSortDirection in interface FndSortField

Returns:

FndSort.ASCENDING