ifs.fnd.record

Class FndText

java.lang.Object

ifs.fnd.record.FndAttribute

ifs.fnd.record.FndQueryableAttribute

ifs.fnd.record.FndAbstractText

ifs.fnd.record.FndAbstractString

ifs.fnd.record.FndText

All Implemented Interfaces:

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

Direct Known Subclasses:

FndGenericReference

public class FndText
extends FndAbstractString

FndText data type for attributes.

See Also:

Serialized Form

Nested Class Summary

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

FndAttribute.Iterator

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOB
static int	LONG
static int	NORMAL

Fields inherited from class ifs.fnd.record.FndAttribute

meta, rec, value

Constructor Summary

Constructors

Constructor and Description
FndText() Create a new instance.
FndText(FndAttributeMeta meta) Create a new instance based on specified meta data.
FndText(FndAttributeMeta meta, boolean isClob) Create a new instance based on specified meta data.
FndText(FndAttributeMeta meta, int storage) Create a new FndText attribute.
FndText(FndAttributeMeta meta, java.lang.String value) Create a new instance based on specified meta data.
FndText(java.lang.String name) Create a new instance, also specifying attribute name.
FndText(java.lang.String name, boolean isClob) Create a new instance, also specifying attribute name.
FndText(java.lang.String name, int storage) Create a new FndText attribute.
FndText(java.lang.String name, java.lang.String value) Create a new instance, also specifying attribute name and initial value.

Method Summary

Modifier and Type	Method and Description
void	assign(FndText from) Sets the value of the attribute from another attribute.
int	compareTo(FndAttribute attr) Compares two attributes.
FndSimpleCondition	createBetweenCondition(java.lang.String value1, java.lang.String value2) See createBetweenCondition method description.
FndSimpleCondition	createEqualCondition(java.lang.String value) See createEqualCondition method description.
FndSimpleCondition	createEqualIgnoreCaseCondition(java.lang.String value) Create a "attribute = value" condition on this attribute ignoring case.
FndSimpleCondition	createGreaterThanCondition(java.lang.String value) See createGreaterThanCondition method description.
FndSimpleCondition	createGreaterThanOrEqualCondition(java.lang.String value) See createGreaterThanOrEqualCondition method description.
FndSimpleCondition	createLessThanCondition(java.lang.String value) See createLessThanCondition method description.
FndSimpleCondition	createLessThanOrEqualCondition(java.lang.String value) See createLessThanOrEqualCondition method description.
FndSimpleCondition	createLikeCondition(java.lang.String value) Create a "attribute like value" condition on this attribute.
FndSimpleCondition	createLikeIgnoreCaseCondition(java.lang.String value) Create a "attribute like value" condition on this attribute ignoring case.
FndSimpleCondition	createNotEqualCondition(java.lang.String value) See createNotEqualCondition method description.
FndSimpleCondition	createNotEqualIgnoreCaseCondition(java.lang.String value) Create a "attribute <> value" condition on this attribute ignoring case.
FndSimpleCondition	createNotLikeCondition(java.lang.String value) Create a "attribute not like value" condition on this attribute.
FndSimpleCondition	createNotLikeIgnoreCaseCondition(java.lang.String value) Create a "attribute not like value" condition on this attribute ignoring case.
protected void	formatValueToXml(FndXmlSerializer s) Formats this attribute's value to the xml stream.
protected FndSqlType	getSqlType() Get SQL type for attribute.
java.lang.String	getTrimmedValue() Gets trimmed value of the attribute.
java.lang.String	getTrimmedValue(java.lang.String defaultValue) Gets trimmed value of the attribute.
java.lang.String	getValue() Gets value of the attribute.
java.lang.String	getValue(java.lang.String defaultValue) Return the value of the attribute.
boolean	isLong() Check if this is a long text or not (with CLOB storage).
protected FndAttribute	newAttribute(FndAttributeMeta meta) Creates a new attribute based on meta-data.
protected void	setSqlValue(FndSqlData data, int colNr) Get value from database and set on this attribute
void	setValue(FndText field) Copies value from another FndText.
void	setValue(java.lang.String value) Sets the value of the attribute.
protected FndSqlValue	toFndSqlValue() Return a FndSqlValue based on the value of this attribute
static FndText	valueOf(java.lang.String value) Returns an FndText attribute holding the value represented by the specified String.

Methods inherited from class ifs.fnd.record.FndAbstractString

createBetweenCondition, createEqualCondition, createEqualIgnoreCaseCondition, createGreaterThanCondition, createGreaterThanOrEqualCondition, createLessThanCondition, createLessThanOrEqualCondition, createLikeCondition, createLikeIgnoreCaseCondition, createNotEqualCondition, createNotLikeCondition, createNotLikeIgnoreCaseCondition, isLengthPrefixed, parseXmlString, setLengthPrefixed

Methods inherited from class ifs.fnd.record.FndAbstractText

setValue

Methods inherited from class ifs.fnd.record.FndQueryableAttribute

createInCondition, createIsNotNullCondition, createIsNullCondition, createNotInCondition, getCount

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, clone, cloneValue, copy, createBetweenCondition, createEqualCondition, createGreaterThanCondition, createGreaterThanOrEqualCondition, createLessThanCondition, createLessThanOrEqualCondition, createNotEqualCondition, descending, exclude, exist, formatAttributeToXml, formatValue, getColumns, getInnerTypes, getInvalidValueInfo, getLength, 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, isNull, isPartOfPrimaryKey, isQuery, isSet, isUpdateAllowed, isVector, parse, parseBuffer, parseDatabaseString, parseString, set, setDirty, setDirty, setExistent, setInvalidValueInfo, setMandatory, setName, setNonExistent, setNull, setParentRecord, setQuery, setState, setType, setUpdateAllowed, sortFieldIterator, toDatabaseString, toString, unset, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL

public static final int NORMAL

See Also:

Constant Field Values

LONG

public static final int LONG

See Also:

Constant Field Values

CLOB

public static final int CLOB

See Also:

Constant Field Values

Constructor Detail

FndText

public FndText()

Create a new instance.

FndText

public FndText(java.lang.String name)

Create a new instance, also specifying attribute name.

Parameters:

name - attribute name

FndText

public FndText(java.lang.String name,
               boolean isClob)

Create a new instance, also specifying attribute name.

Parameters:

name - attribute name

isClob - boolean flag indicating storage to use for the attribute (FndText.CLOB/FndText.NORMAL)

FndText

public FndText(java.lang.String name,
               int storage)

Create a new FndText attribute.

Parameters:

name - Attribute name.

storage - Storage to use for attribute, FndText.CLOB/FndText.LONG/FndText.NORMAL.

FndText

public FndText(java.lang.String name,
               java.lang.String value)

Create a new instance, also specifying attribute name and initial value.

Parameters:

name - attribute name

value - initial attribute value

FndText

public FndText(FndAttributeMeta meta)

Create a new instance based on specified meta data.

Parameters:

meta - attribute meta data

FndText

public FndText(FndAttributeMeta meta,
               boolean isClob)

Create a new instance based on specified meta data.

Parameters:

meta - attribute meta data

isClob - boolean flag indicating storage to use for the attribute (FndText.CLOB/FndText.NORMAL)

FndText

public FndText(FndAttributeMeta meta,
               int storage)

Create a new FndText attribute.

Parameters:

meta - Attribute meta-data.

storage - Storage to use for attribute, FndText.CLOB/FndText.LONG/FndText.NORMAL.

FndText

public FndText(FndAttributeMeta meta,
               java.lang.String value)

Create a new instance based on specified meta data. Also set initial attribute value.

Parameters:

meta - meta data

value - initial value

Method Detail

newAttribute

protected FndAttribute newAttribute(FndAttributeMeta meta)

Creates a new attribute based on meta-data.

Overrides:

newAttribute in class FndAttribute

Parameters:

meta - Meta-data to base the attribute on

Returns:

The created attribute

getValue

public java.lang.String getValue()

Gets value of the attribute.

Returns:

Value

getValue

public java.lang.String getValue(java.lang.String defaultValue)

Return the value of the attribute. If value is null, return defaultValue.

Parameters:

defaultValue - Value to return if attribute value is null.

Returns:

Attribute value.

getTrimmedValue

public java.lang.String getTrimmedValue()

Gets trimmed value of the attribute. If value is an empty String, null is returned.

Returns:

Value

getTrimmedValue

public java.lang.String getTrimmedValue(java.lang.String defaultValue)

Gets trimmed value of the attribute. If value is an empty String, null is returned. If trimmed value is null or empty, return trimmed defaultValue.

Parameters:

defaultValue - Value to return if attribute value is null.

Returns:

Value

setValue

public void setValue(java.lang.String value)
              throws ApplicationException

Sets the value of the attribute.

Parameters:

value - Value

Throws:

ApplicationException - Out of range

setValue

public void setValue(FndText field)
              throws ApplicationException

Copies value from another FndText.

Parameters:

field - Attribute to copy from

Throws:

ApplicationException - Out of range

assign

public void assign(FndText from)
            throws SystemException,
                   ApplicationException

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.

Parameters:

from - Attribute to copy value from

Throws:

SystemException - Thrown if cloning fails

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

compareTo

public int compareTo(FndAttribute attr)

Compares two attributes. Used for sorting.

Overrides:

compareTo in class FndAttribute

Parameters:

attr - Attribute to compare with

Returns:

0 if equal

formatValueToXml

protected void formatValueToXml(FndXmlSerializer s)
                         throws ParseException

Formats this attribute's value to the xml stream.

Overrides:

formatValueToXml in class FndAbstractString

Parameters:

s - XML serializer to append the value to

Throws:

ParseException

toFndSqlValue

protected FndSqlValue toFndSqlValue()

Return a FndSqlValue based on the value of this attribute

Overrides:

toFndSqlValue in class FndAttribute

setSqlValue

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

Get value from database and set on this attribute

Overrides:

setSqlValue in class FndAttribute

Parameters:

data - an instance of FndSqlData interface to get value from

colNr - column/parameter index number

Throws:

IfsException

getSqlType

protected FndSqlType getSqlType()

Description copied from class: FndAttribute

Get SQL type for attribute.

Overrides:

getSqlType in class FndAttribute

isLong

public boolean isLong()

Check if this is a long text or not (with CLOB storage).

Overrides:

isLong in class FndAttribute

Returns:

true if this is a long attribute

createBetweenCondition

public FndSimpleCondition createBetweenCondition(java.lang.String value1,
                                                 java.lang.String value2)

See createBetweenCondition method description.

See class FndSimpleCondition for example of usage.

createEqualCondition

public FndSimpleCondition createEqualCondition(java.lang.String value)

See createEqualCondition method description.

See class FndSimpleCondition for example of usage.

createGreaterThanCondition

public FndSimpleCondition createGreaterThanCondition(java.lang.String value)

See createGreaterThanCondition method description.

See class FndSimpleCondition for example of usage.

createGreaterThanOrEqualCondition

public FndSimpleCondition createGreaterThanOrEqualCondition(java.lang.String value)

See createGreaterThanOrEqualCondition method description.

See class FndSimpleCondition for example of usage.

createLessThanCondition

public FndSimpleCondition createLessThanCondition(java.lang.String value)

See createLessThanCondition method description.

See class FndSimpleCondition for example of usage.

createLessThanOrEqualCondition

public FndSimpleCondition createLessThanOrEqualCondition(java.lang.String value)

See createLessThanOrEqualCondition method description.

See class FndSimpleCondition for example of usage.

createNotEqualCondition

public FndSimpleCondition createNotEqualCondition(java.lang.String value)

See createNotEqualCondition method description.

See class FndSimpleCondition for example of usage.

createLikeCondition

public FndSimpleCondition createLikeCondition(java.lang.String value)

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

See class FndSimpleCondition for example of usage.

Parameters:

value - Value to compare attribute to. Use wildcards '%' and '_'.

Returns:

Created condition.

createNotLikeCondition

public FndSimpleCondition createNotLikeCondition(java.lang.String value)

Create a "attribute not like value" condition on this attribute.

See class FndSimpleCondition for example of usage.

Parameters:

value - Value to compare attribute to. Use wildcards '%' and '_'.

Returns:

Created condition.

createLikeIgnoreCaseCondition

public FndSimpleCondition createLikeIgnoreCaseCondition(java.lang.String value)

Create a "attribute like value" condition on this attribute ignoring case.

See class FndSimpleCondition for example of usage.

Parameters:

value - Value to compare attribute to. Use wildcards '%' and '_'.

Returns:

Created condition.

createNotLikeIgnoreCaseCondition

public FndSimpleCondition createNotLikeIgnoreCaseCondition(java.lang.String value)

Create a "attribute not like value" condition on this attribute ignoring case.

See class FndSimpleCondition for example of usage.

Parameters:

value - Value to compare attribute to. Use wildcards '%' and '_'.

Returns:

Created condition.

createEqualIgnoreCaseCondition

public FndSimpleCondition createEqualIgnoreCaseCondition(java.lang.String value)

Create a "attribute = value" condition on this attribute ignoring case.

See class FndSimpleCondition for example of usage.

Parameters:

value - Value to compare attribute to.

Returns:

Created condition.

createNotEqualIgnoreCaseCondition

public FndSimpleCondition createNotEqualIgnoreCaseCondition(java.lang.String value)

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

See class FndSimpleCondition for example of usage.

Parameters:

value - Value to compare attribute to.

Returns:

Created condition.

valueOf

public static FndText valueOf(java.lang.String value)
                       throws ParseException

Returns an FndText attribute holding the value represented by the specified String.

Parameters:

value - the string to be parsed

Returns:

a new instance of FndText with the specified value

Throws:

ParseException - if the specified String has invalid format