public class AttributeValue extends Object implements Cloneable, Serializable, Comparable, LooselyBoundedCacheable
An AttributeValue is instantiated any time a value needs to be represented.
AttributeValues are implicitly created in getting the value of an Attribute.
They may also be explicitly created using the newAttributeValue
factory methods, in order to set the value of an Attribute in a LibraryObject
or LibraryObjectDefinition.
In addition to the value itself, an AttributeValue tracks the data type, whether the value is an array-type, and whether the value is null. The class also provides methods to retrieve the value as various Java types, such as int, Integer, or String (not all of these are available for all AttributeValue data types). All of these conversion methods require a LibrarySession or S_LibrarySession argument. This session's Localizer is used to perform any needed localization (specifically, parsing and formatting numbers and dates).
AttributeValues also track the name of the Attribute whose value they
represent. After you use a newAttributeValue
method to create
an AttributeValue, you can invoke the setName
method to set its
name. This is optional, unless you want to include the AttributeValue in an
array passed to the LibraryObject.setAttributes(AttributeValue[])
method. Note that once an AttributeValue's name is set, it cannot be altered
except in limited ways using the ensureUpperCaseName
and
overrideName
methods.
Modifier and Type | Field and Description |
---|---|
static Long |
LONG_ZERO
Constant for a Long representation of zero (used to depict the
ID of a null object).
|
protected String |
m_Name
The name of this AttributeValue.
|
protected HashMap |
m_Options
The options describing the use of this AttributeValue.
|
static String |
OPTION_ARRAY_APPEND_MODE
Name of the option used to specify append mode when the AttributeValue
is used to append to an existing array value.
|
static String |
OPTION_ARRAY_PREVENT_DUPLICATES
Name of the option used to specify that the values defined for an array
Attribute will not be added if the value already exists in the existing
array value.
|
static String |
OPTION_ARRAY_REMOVE_MODE
Name of the option used to specify remove mode when the AttributeValue
is used to append to an existing array value.
|
static String |
OPTION_LITERAL_ARRAY_BIND_VALUE
Name of the option used to specify that this AttributeValue will be used
to represent a literal array to be used as a bind value.
|
static String |
OPTION_MAP_PUT_MODE
Name of the option used to specify "put" mode when the AttributeValue
is used to add or modify an existing map value.
|
static String |
OPTION_MAP_REMOVE_MODE
Name of the option used to specify "remove" mode when the AttributeValue
is used to remove from an existing map value.
|
static String |
OPTION_TRANSIENT
Name of the option used to indicate that an AttributeValue
is transient, and should not be resolved.
|
Modifier | Constructor and Description |
---|---|
protected |
AttributeValue()
Constructs a null AttributeValue of an unknown data type.
|
Modifier and Type | Method and Description |
---|---|
void |
added(Object id)
Called when an instance is added to the cache.
|
static Hashtable |
arrayToHashtable(AttributeValue[] attrVals)
Converts an array of AttributeValues to a hashtable, hashed by name.
|
boolean |
canPurge()
Gets whether the item can be purged from the
the BoundedCache.
|
Object |
clone()
Returns a clone of this AttributeValue.
|
int |
compareTo(Object o)
Compares two AttributeValues.
|
protected boolean |
convertToBoolean(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a boolean.
|
protected boolean[] |
convertToBooleanArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of booleans.
|
protected Boolean |
convertToBooleanObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a Boolean.
|
protected Boolean[] |
convertToBooleanObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of Booleans.
|
protected Date |
convertToDate(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a Date.
|
protected Date[] |
convertToDateArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of Dates.
|
protected DirectoryObjectInterface |
convertToDirectoryObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a DirectoryObject.
|
protected DirectoryObjectInterface[] |
convertToDirectoryObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of DirectoryObjects.
|
protected double |
convertToDouble(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a double.
|
protected double[] |
convertToDoubleArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of doubles.
|
protected Double |
convertToDoubleObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a Double.
|
protected Double[] |
convertToDoubleObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of Doubles.
|
protected int |
convertToInteger(LibrarySessionInterface session,
int index)
Converts this AttributeValue to an int.
|
protected int[] |
convertToIntegerArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of ints.
|
protected Integer |
convertToIntegerObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to an Integer.
|
protected Integer[] |
convertToIntegerObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of Integers.
|
protected long |
convertToLong(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a long.
|
protected long[] |
convertToLongArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of longs.
|
protected Long |
convertToLongObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a Long.
|
protected Long[] |
convertToLongObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of Longs.
|
protected Map |
convertToMap(LibrarySessionInterface session)
Converts this AttributeValue to a Map.
|
protected PublicObjectInterface |
convertToPublicObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a PublicObject.
|
protected PublicObjectInterface[] |
convertToPublicObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of PublicObjects.
|
protected SchemaObjectInterface |
convertToSchemaObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a SchemaObject.
|
protected SchemaObjectInterface[] |
convertToSchemaObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of SchemaObjects.
|
protected SimpleObjectInterface |
convertToSimpleObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a SimpleObject.
|
protected SimpleObjectInterface[] |
convertToSimpleObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of SimpleObjects.
|
protected String |
convertToString(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a String.
|
protected String[] |
convertToStringArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of Strings.
|
protected SystemObjectInterface |
convertToSystemObject(LibrarySessionInterface session,
int index)
Converts this AttributeValue to a SystemObject.
|
protected SystemObjectInterface[] |
convertToSystemObjectArray(LibrarySessionInterface session)
Converts this AttributeValue to an array of SystemObjects.
|
void |
ensureUpperCaseName()
Ensures the name of this AttributeValue (if any) is uppercase.
|
boolean |
getArrayAppendOption()
Gets indication of whether this AttributeValue should
append to an existing array value, when an update is performed
using this instance.
|
boolean |
getArrayPreventDuplicateValuesOption()
Gets indication of whether this AttributeValue will be used to
insert, append or replace an existing array value, ensuring that
no duplicate values are added.
|
boolean |
getArrayRemoveOption()
Gets indication of whether this AttributeValue should
contain values that will be removed from an existing array value,
when an update is performed using this instance.
|
boolean |
getBoolean(LibrarySessionInterface session)
Gets this AttributeValue's representation as a boolean.
|
boolean[] |
getBooleanArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of booleans.
|
boolean |
getBooleanArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of booleans.
|
Boolean |
getBooleanObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a Boolean.
|
Boolean[] |
getBooleanObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of Booleans.
|
Boolean |
getBooleanObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of Booleans.
|
int |
getDataType()
Gets the data type of this AttributeValue.
|
Date |
getDate(LibrarySessionInterface session)
Gets this AttributeValue's representation as a Date.
|
Date[] |
getDateArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of Dates.
|
Date |
getDateArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of Dates.
|
DirectoryObjectInterface |
getDirectoryObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a DirectoryObject.
|
DirectoryObjectInterface[] |
getDirectoryObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of DirectoryObjects.
|
DirectoryObjectInterface |
getDirectoryObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of DirectoryObjects.
|
double |
getDouble(LibrarySessionInterface session)
Gets this AttributeValue's representation as a double.
|
double[] |
getDoubleArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of doubles.
|
double |
getDoubleArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of doubles.
|
Double |
getDoubleObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a Double.
|
Double[] |
getDoubleObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of Doubles.
|
Double |
getDoubleObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of Doubles.
|
int |
getElementCount()
Gets the number of elements in an array-type AttributeValue.
|
int |
getInteger(LibrarySessionInterface session)
Gets this AttributeValue's representation as an int.
|
int[] |
getIntegerArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of ints.
|
int |
getIntegerArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of ints.
|
Integer |
getIntegerObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as an Integer.
|
Integer[] |
getIntegerObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of Integers.
|
Integer |
getIntegerObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of Integers.
|
LibraryObjectInterface |
getLibraryObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a scalar LibraryObject.
|
boolean |
getLiteralArrayBindValueOption()
Gets indication of whether this AttributeValue will be used to
represent a literal array to be used as a bind value.
|
long |
getLong(LibrarySessionInterface session)
Gets this AttributeValue's representation as a long.
|
long[] |
getLongArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of longs.
|
long |
getLongArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of longs.
|
Long |
getLongObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a Long.
|
Long[] |
getLongObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of Longs.
|
Long |
getLongObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of Longs.
|
Map |
getMap(LibrarySessionInterface session)
Gets this AttributeValue's representation as a Map.
|
boolean |
getMapPutOption()
Gets indication of whether this AttributeValue should
add to or modify an existing map value, when an update is performed
using this instance.
|
boolean |
getMapRemoveOption()
Gets indication of whether this AttributeValue should
remove from an existing map value, when an update is performed
using this instance.
|
String |
getName()
Gets the name of this AttributeValue.
|
Object |
getObject(LibrarySessionInterface session)
Gets the default object representation of this AttributeValue.
|
Object |
getOption(String name)
Return an option value.
|
PublicObjectInterface |
getPublicObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a PublicObject.
|
PublicObjectInterface[] |
getPublicObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of PublicObjects.
|
PublicObjectInterface |
getPublicObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of PublicObjects.
|
SchemaObjectInterface |
getSchemaObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a SchemaObject.
|
SchemaObjectInterface[] |
getSchemaObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of SchemaObjects.
|
SchemaObjectInterface |
getSchemaObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of SchemaObjects.
|
SimpleObjectInterface |
getSimpleObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a SimpleObject.
|
SimpleObjectInterface[] |
getSimpleObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of SimpleObjects.
|
SimpleObjectInterface |
getSimpleObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of SimpleObjects.
|
String |
getString(LibrarySessionInterface session)
Gets this AttributeValue's representation as a String.
|
String[] |
getStringArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of Strings.
|
String |
getStringArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of Strings.
|
SystemObjectInterface |
getSystemObject(LibrarySessionInterface session)
Gets this AttributeValue's representation as a SystemObject.
|
SystemObjectInterface[] |
getSystemObjectArray(LibrarySessionInterface session)
Gets this AttributeValue's representation as an array of SystemObjects.
|
SystemObjectInterface |
getSystemObjectArray(LibrarySessionInterface session,
int index)
Get the specified element of this AttributeValue's representation
as an array of SystemObjects.
|
boolean |
getTransientOption()
Gets indication of whether this AttributeValue
is transient, and should not be resolved.
|
static AttributeValue[] |
hashtableToArray(Hashtable hashtable)
Converts a hashtable of AttributeValues to an array.
|
boolean |
isArrayType()
Gets whether this AttributeValue is an array-type AttributeValue.
|
boolean |
isLibraryObjectArrayType()
Gets whether this AttributeValue is an array LibraryObject type
AttributeValue.
|
boolean |
isLibraryObjectScalarType()
Gets whether this AttributeValue is a scalar LibraryObject type
AttributeValue.
|
boolean |
isLibraryObjectType()
Gets whether this AttributeValue is a LibraryObject type AttributeValue,
either scalar or array.
|
boolean |
isMapType()
Gets whether this AttributeValue is a map-type AttributeValue.
|
boolean |
isNullValue()
Gets whether this AttributeValue is null.
|
static AttributeValue |
newAttributeValue()
Constructs a null AttributeValue of an unknown data type.
|
static AttributeValue |
newAttributeValue(AttributeValue av)
Constructs a new AttributeValue identical to the specified
AttributeValue except with no name.
|
static AttributeValue |
newAttributeValue(boolean value)
Constructs a new boolean AttributeValue.
|
static AttributeValue |
newAttributeValue(Boolean value)
Constructs a new boolean AttributeValue.
|
static AttributeValue |
newAttributeValue(boolean[] values)
Constructs a new array-type boolean AttributeValue.
|
static AttributeValue |
newAttributeValue(Boolean[] values)
Constructs a new array-type boolean AttributeValue.
|
static AttributeValue |
newAttributeValue(Date value)
Constructs a new date AttributeValue.
|
static AttributeValue |
newAttributeValue(Date[] values)
Constructs a new array-type date AttributeValue.
|
static AttributeValue |
newAttributeValue(DirectoryObjectInterface value)
Constructs a new DirectoryObject AttributeValue.
|
static AttributeValue |
newAttributeValue(DirectoryObjectInterface[] values)
Constructs a new array-type DirectoryObject AttributeValue.
|
static AttributeValue |
newAttributeValue(double value)
Constructs a new double AttributeValue.
|
static AttributeValue |
newAttributeValue(Double value)
Constructs a new double AttributeValue.
|
static AttributeValue |
newAttributeValue(double[] values)
Constructs a new array-type double AttributeValue.
|
static AttributeValue |
newAttributeValue(Double[] values)
Constructs a new array-type double AttributeValue.
|
static AttributeValue |
newAttributeValue(int value)
Constructs a new integer AttributeValue.
|
static AttributeValue |
newAttributeValue(int[] values)
Constructs a new array-type integer AttributeValue.
|
static AttributeValue |
newAttributeValue(Integer value)
Constructs a new integer AttributeValue.
|
static AttributeValue |
newAttributeValue(Integer[] values)
Constructs a new array-type integer AttributeValue.
|
static AttributeValue |
newAttributeValue(int attributeDataType,
long objectId,
Long attributeId,
int count)
Internal use only: Constructs an AttributeValue of specified map-type
data type.
|
static AttributeValue |
newAttributeValue(int attributeDataType,
long objectId,
Long attributeId,
Long priClassId,
int count)
Internal use only: Constructs an AttributeValue of specified array-type
data type.
|
static AttributeValue |
newAttributeValue(long value)
Constructs a new long AttributeValue.
|
static AttributeValue |
newAttributeValue(Long value)
Constructs a new long AttributeValue.
|
static AttributeValue |
newAttributeValue(long[] values)
Constructs a new array-type long AttributeValue.
|
static AttributeValue |
newAttributeValue(Long[] values)
Constructs a new array-type long AttributeValue.
|
static AttributeValue |
newAttributeValue(Long[] ids,
int attributeDataType)
Internal use only: Constructs a new AttributeValue of the specified data
type for the specified array of ids.
|
static AttributeValue |
newAttributeValue(Long[] ids,
Long primaryClassId,
int attributeDataType)
Internal use only: Constructs a new AttributeValue of the specified data
type for the specified array of ids.
|
static AttributeValue |
newAttributeValue(long id,
int attributeDataType)
Internal use only: Constructs a new AttributeValue of the specified data
type for the specified id.
|
static AttributeValue |
newAttributeValue(Long id,
int attributeDataType)
Internal use only: Constructs a new AttributeValue of the specified data
type for the specified id.
|
static AttributeValue |
newAttributeValue(long id,
Long primaryClassId,
int attrDataType)
Internal use only: Constructs a new AttributeValue of the specified data
type for the specified id and primary Class ID.
|
static AttributeValue |
newAttributeValue(Map map,
int attributeDataType)
Constructs a new Map AttributeValue for the specified data type.
|
static AttributeValue |
newAttributeValue(Object value)
Constructs a new AttributeValue for the specified object.
|
static AttributeValue |
newAttributeValue(PublicObjectInterface value)
Constructs a new PublicObject AttributeValue.
|
static AttributeValue |
newAttributeValue(PublicObjectInterface[] values)
Constructs a new array-type PublicObject AttributeValue.
|
static AttributeValue |
newAttributeValue(SchemaObjectInterface value)
Constructs a new SchemaObject AttributeValue.
|
static AttributeValue |
newAttributeValue(SchemaObjectInterface[] values)
Constructs a new array-type SchemaObject AttributeValue.
|
static AttributeValue |
newAttributeValue(SimpleObjectInterface value)
Constructs a new SimpleObject AttributeValue.
|
static AttributeValue |
newAttributeValue(SimpleObjectInterface[] values)
Constructs a new array-type SimpleObject AttributeValue.
|
static AttributeValue |
newAttributeValue(String value)
Constructs a new string AttributeValue.
|
static AttributeValue |
newAttributeValue(String[] values)
Constructs a new array-type string AttributeValue.
|
static AttributeValue |
newAttributeValue(SystemObjectInterface value)
Constructs a new SystemObject AttributeValue.
|
static AttributeValue |
newAttributeValue(SystemObjectInterface[] values)
Constructs a new array-type SystemObject AttributeValue.
|
static AttributeValue |
newNullAttributeValue(int attributeDataType)
Constructs a null AttributeValue of the specified data type.
|
static AttributeValue |
overrideName(String name,
AttributeValue av)
Overrides the name set for this AttributeValue by cloning
the AttributeValue if the name is already set.
|
void |
removed(Object id)
Called when an instance is removed to the cache.
|
void |
removeOption(String name)
Sets an option.
|
protected void |
resolve(LibrarySessionInterface session)
Ensures that the AttributeValue can be converted to a Java type.
|
void |
setArrayAppendOption(boolean opt)
Sets an option to indicate that this AttributeValue will be used to
append to an existing array value, when an update is performed
using this instance.
|
void |
setArrayPreventDuplicateValuesOption(boolean opt)
Sets an option to indicate that this AttributeValue will be used to
insert, append or replace an existing array value, ensuring that
no duplicate values are added.
|
void |
setArrayRemoveOption(boolean opt)
Sets an option to indicate that this AttributeValue will be used to
remove values from an existing array value whose values match
the values defined in this instance, when an update is performed
using this instance.
|
void |
setLiteralArrayBindValueOption(boolean opt)
Sets an option to indicate that this AttributeValue will be used to
represent a literal array to be used as a bind value.
|
void |
setMapPutOption(boolean opt)
Sets an option to indicate that this AttributeValue will be used
to add to or modify an existing map value, when an update is performed
using this instance.
|
void |
setMapRemoveOption(boolean opt)
Sets an option to indicate that this AttributeValue will be used to
to remove from an existing map value, when an update is performed
using this instance.
|
void |
setName(String name)
Sets the name of this AttributeValue.
|
void |
setOption(String name,
Object value)
Sets an option.
|
void |
setTransientOption(boolean opt)
Sets an option to indicate that this AttributeValue
is transient, and should not be resolved.
|
protected Boolean |
toBoolean(Double value,
Localizer localizer)
Converts a Double to a Boolean.
|
protected Boolean |
toBoolean(Integer value,
Localizer localizer)
Converts an Integer to a Boolean.
|
protected Boolean |
toBoolean(Long value,
Localizer localizer)
Converts a Long to a Boolean.
|
protected Boolean |
toBoolean(String value,
Localizer localizer)
Converts a String to a Boolean.
|
protected Date |
toDate(Date value,
Localizer localizer)
Converts a Date to a Date (creates a clone).
|
protected Date |
toDate(String value,
Localizer localizer)
Converts a String to a Date.
|
protected Double |
toDouble(Boolean value,
Localizer localizer)
Converts a Boolean to a Double.
|
protected Double |
toDouble(Number value,
Localizer localizer)
Converts a Number to a Double.
|
protected Double |
toDouble(String value,
Localizer localizer)
Converts a String to a Double.
|
protected Integer |
toInteger(Boolean value,
Localizer localizer)
Converts a Boolean to an Integer.
|
protected Integer |
toInteger(Number value,
Localizer localizer)
Converts a Number to an Integer.
|
protected Integer |
toInteger(String value,
Localizer localizer)
Converts a String to an Integer.
|
protected Long |
toLong(Boolean value,
Localizer localizer)
Converts a Boolean to a Long.
|
protected Long |
toLong(Date value,
Localizer localizer)
Converts a Date to a Long.
|
protected Long |
toLong(Number value,
Localizer localizer)
Converts a Number to a Long.
|
protected Long |
toLong(String value,
Localizer localizer)
Converts a String to a Long.
|
String |
toString()
Gets the default object representation of this AttributeValue as a
string.
|
protected String |
toString(Boolean value,
Localizer localizer)
Converts a Boolean to a String.
|
protected String |
toString(Date value,
Localizer localizer)
Converts a Date to a String.
|
protected String |
toString(Double value,
Localizer localizer)
Converts a Double to a String.
|
protected String |
toString(Integer value,
Localizer localizer)
Converts an Integer to a String.
|
String |
toString(LibrarySessionInterface sess)
Gets the default object representation of this AttributeValue as a
string.
|
protected String |
toString(Long value,
Localizer localizer)
Converts a Long to a String.
|
public static final Long LONG_ZERO
public static final String OPTION_TRANSIENT
public static final String OPTION_ARRAY_APPEND_MODE
public static final String OPTION_ARRAY_PREVENT_DUPLICATES
public static final String OPTION_ARRAY_REMOVE_MODE
public static final String OPTION_LITERAL_ARRAY_BIND_VALUE
public static final String OPTION_MAP_PUT_MODE
public static final String OPTION_MAP_REMOVE_MODE
protected String m_Name
protected HashMap m_Options
protected AttributeValue()
public static final AttributeValue newAttributeValue(int value) throws IfsException
value
- the integer valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Integer value) throws IfsException
value
- the integer valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(long value) throws IfsException
value
- the long valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Long value) throws IfsException
value
- the long valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(double value) throws IfsException
value
- the double valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Double value) throws IfsException
value
- the double valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(String value) throws IfsException
value
- the string valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Date value) throws IfsException
value
- the date valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(boolean value) throws IfsException
value
- the boolean valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Boolean value) throws IfsException
value
- the boolean valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(SchemaObjectInterface value) throws IfsException
value
- the SchemaObject valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(SystemObjectInterface value) throws IfsException
value
- the SystemObject valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(SimpleObjectInterface value) throws IfsException
value
- the SimpleObject valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(PublicObjectInterface value) throws IfsException
value
- the PublicObject valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(DirectoryObjectInterface value) throws IfsException
value
- the DirectoryObject valueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(int[] values) throws IfsException
values
- the integer valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Integer[] values) throws IfsException
values
- the integer valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(long[] values) throws IfsException
values
- the long valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Long[] values) throws IfsException
values
- the long valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(double[] values) throws IfsException
values
- the double valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Double[] values) throws IfsException
values
- the double valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(String[] values) throws IfsException
values
- the string valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Date[] values) throws IfsException
values
- the date valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(boolean[] values) throws IfsException
values
- the boolean valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Boolean[] values) throws IfsException
values
- the boolean valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(SchemaObjectInterface[] values) throws IfsException
values
- the SchemaObject valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(SystemObjectInterface[] values) throws IfsException
values
- the SystemObject valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(SimpleObjectInterface[] values) throws IfsException
values
- the SimpleObject valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(PublicObjectInterface[] values) throws IfsException
values
- the PublicObject valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(DirectoryObjectInterface[] values) throws IfsException
values
- the DirectoryObject valuesIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Map map, int attributeDataType) throws IfsException
The map specified must be consistent with the data type specified. For example, if the data type specified is for a String-String map, all keys and values in the map must be Strings, or a ClassCastException will occur.
map
- the map of valuesattributeDataType
- the Attribute data typeIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(long id, int attributeDataType) throws IfsException
For internal use only. Do not call this method.
id
- the idattributeDataType
- the Attribute data typeIfsException
- (IFS-10400) if attributeDataType
is not Attribute.ATTRIBUTEDATATYPE_SCHEMAOBJECT
,
Attribute.ATTRIBUTEDATATYPE_SYSTEMOBJECT
,
Attribute.ATTRIBUTEDATATYPE_PUBLICOBJECT
, or
Attribute.ATTRIBUTEDATATYPE_DIRECTORYOBJECT
public static final AttributeValue newAttributeValue(long id, Long primaryClassId, int attrDataType) throws IfsException
For internal use only. Do not call this method.
id
- the idprimaryClassId
- the primary class IDattrDataType
- the Attribute data typeIfsException
- (IFS-10400) if attributeDataType
is not Attribute.ATTRIBUTEDATATYPE_SIMPLEOBJECT
public static final AttributeValue newAttributeValue(Long id, int attributeDataType) throws IfsException
For internal use only. Do not call this method.
id
- the idattributeDataType
- the Attribute data typeIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Long[] ids, int attributeDataType) throws IfsException
For internal use only. Do not call this method.
ids
- the idsattributeDataType
- the Attribute data type (must be an array type)IfsException
- (IFS-10400) if attributeDataType
is not Attribute.ATTRIBUTEDATATYPE_SCHEMAOBJECT_ARRAY
,
Attribute.ATTRIBUTEDATATYPE_SYSTEMOBJECT_ARRAY
,
Attribute.ATTRIBUTEDATATYPE_PUBLICOBJECT_ARRAY
, or
Attribute.ATTRIBUTEDATATYPE_DIRECTORYOBJECT_ARRAY
public static final AttributeValue newAttributeValue(Long[] ids, Long primaryClassId, int attributeDataType) throws IfsException
For internal use only. Do not call this method.
ids
- the idsprimaryClassId
- the primary class IDattributeDataType
- the Attribute data type (must be an array type)IfsException
- (IFS-10400) if attributeDataType
is not Attribute.ATTRIBUTEDATATYPE_SIMPLEOBJECT_ARRAY
public static final AttributeValue newAttributeValue(int attributeDataType, long objectId, Long attributeId, Long priClassId, int count) throws IfsException
For internal use only. Do not call this method.
This variant is used to retrieve an array-type AttributeValue from the database. It defers loading the elements of the AttributeValue from the appropriate attribute value database table until they are needed.
attributeDataType
- the array-type data typeobjectId
- object IDattributeId
- Attribute IDpriClassId
- the class ID reflecting a ClassDomain settingcount
- the number of elements in this AttributeValueIfsException
- (IFS-10400) if attributeDataType
is invalidIfsException
- (IFS-10410) if attributeDataType
is not an array-typeIfsException
- (IFS-19001) if attributeId is nullpublic static final AttributeValue newAttributeValue(int attributeDataType, long objectId, Long attributeId, int count) throws IfsException
For internal use only. Do not call this method.
This variant is used to retrieve a map-type AttributeValue from the database. It defers loading the elements of the AttributeValue from the appropriate map value database table until they are needed.
attributeDataType
- the map-type data typeobjectId
- the ID of the LibraryObject for which
this AttributeValue represents the value
of one of its AttributesattributeId
- the ID of the Attributecount
- the number of elements in this AttributeValueIfsException
- (IFS-10400) if attributeDataType
is invalidIfsException
- (IFS-10410) if attributeDataType
is not a map-typeIfsException
- (IFS-19001) if attributeId is nullpublic static final AttributeValue newAttributeValue(AttributeValue av) throws IfsException
av
- the existing AttributeValueIfsException
- if the operation failspublic static final AttributeValue newAttributeValue(Object value) throws IfsException
value
- the objectIfsException
- (IFS-10403 or IFS-10404) if an
AttributeValue cannot be constructed for
value
's classpublic static final AttributeValue newAttributeValue() throws IfsException
IfsException
public static final AttributeValue newNullAttributeValue(int attributeDataType) throws IfsException
Data types are enumerated in oracle.ifs.beans.Attribute
.
newNullAttributeValue(Attribute.ATTRIBUTEDATATYPE_STRING)
is equivalent to newAttributeValue((String)null)
.
attributeDataType
- the Attribute data typeIfsException
- (IFS-10400) if attributeDataType
is invalidpublic final int getInteger(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an intpublic final Integer getIntegerObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an Integerpublic final long getLong(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a longpublic final Long getLongObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Longpublic final double getDouble(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a doublepublic final Double getDoubleObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Doublepublic final String getString(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Stringpublic final Date getDate(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Datepublic final boolean getBoolean(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a booleanpublic final Boolean getBooleanObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Booleanpublic final SchemaObjectInterface getSchemaObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SchemaObjectpublic final SystemObjectInterface getSystemObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SystemObjectpublic final SimpleObjectInterface getSimpleObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SimpleObjectpublic final PublicObjectInterface getPublicObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a PublicObjectpublic final DirectoryObjectInterface getDirectoryObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a DirectoryObjectpublic final LibraryObjectInterface getLibraryObject(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a LibraryObjectpublic final int[] getIntegerArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an int[]public final Integer[] getIntegerObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an Integer[]public final long[] getLongArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a long[]public final Long[] getLongObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Long[]public final double[] getDoubleArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a double[]public final Double[] getDoubleObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Double[]public final String[] getStringArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a String[]public final Date[] getDateArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Date[]public final boolean[] getBooleanArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a boolean[]public final Boolean[] getBooleanObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Boolean[]public final SchemaObjectInterface[] getSchemaObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SchemaObject[]public final SystemObjectInterface[] getSystemObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SystemObject[]public final SimpleObjectInterface[] getSimpleObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SimpleObject[]public final PublicObjectInterface[] getPublicObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a PublicObject[]public final DirectoryObjectInterface[] getDirectoryObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a DirectoryObject[]public final int getIntegerArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an int[]public final Integer getIntegerObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an Integer[]public final long getLongArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a long[]public final Long getLongObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Long[]public final double getDoubleArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a double[]public final Double getDoubleObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Double[]public final String getStringArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a String[]public final Date getDateArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Date[]public final boolean getBooleanArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a boolean[]public final Boolean getBooleanObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Boolean[]public final SchemaObjectInterface getSchemaObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SchemaObject[]public final SystemObjectInterface getSystemObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SystemObject[]public final SimpleObjectInterface getSimpleObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SimpleObject[]public final PublicObjectInterface getPublicObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a PublicObject[]public final DirectoryObjectInterface getDirectoryObjectArray(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a DirectoryObject[]public final Map getMap(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Mappublic final void setName(String name) throws IfsException
name
- the string nameIfsException
- if the operation failspublic static final AttributeValue overrideName(String name, AttributeValue av) throws IfsException
name
- the nameav
- the AttributeValueIfsException
- if the operation failspublic final void ensureUpperCaseName() throws IfsException
IfsException
- if the operation failspublic final String getName() throws IfsException
IfsException
public int getDataType() throws IfsException
Data types are enumerated in oracle.ifs.beans.Attribute
.
IfsException
public final boolean isArrayType() throws IfsException
IfsException
- if the operation failspublic final boolean isMapType() throws IfsException
IfsException
- if the operation failspublic final boolean isLibraryObjectType() throws IfsException
IfsException
- if the operation failspublic final boolean isLibraryObjectScalarType() throws IfsException
Equivalent to isLibraryObjectType() && !isArrayType()
.
IfsException
- if the operation failspublic final boolean isLibraryObjectArrayType() throws IfsException
Equivalent to isLibraryObjectType() && isArrayType()
.
IfsException
- if the operation failspublic boolean isNullValue() throws IfsException
IfsException
public int getElementCount() throws IfsException
IfsException
public Object getObject(LibrarySessionInterface session) throws IfsException
For example, the default object representation of a boolean AttributeValue is a Java Boolean.
session
- the sessionIfsException
- (IFS-10406) if there is a AttributeValue
conversion errorpublic final String toString()
Equivalent to getObject(null).toString()
. Unlike the
getString
method, the returned string is completely
unformatted and unlocalized.
public final String toString(LibrarySessionInterface sess)
Equivalent to getObject(sess).toString()
. Unlike the
getString
method, the returned string is completely
unformatted and unlocalized.
public static final AttributeValue[] hashtableToArray(Hashtable hashtable) throws IfsException
hashtable
- the hashtable of AttributeValuesIfsException
public static final Hashtable arrayToHashtable(AttributeValue[] attrVals) throws IfsException
AttributeValues whose name is unset are ignored.
attrVals
- an array of AttributeValuesIfsException
- if the operation failsprotected int convertToInteger(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an intprotected Integer convertToIntegerObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an Integerprotected long convertToLong(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a longprotected Long convertToLongObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Longprotected double convertToDouble(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a doubleprotected Double convertToDoubleObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Doubleprotected String convertToString(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Stringprotected Date convertToDate(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Dateprotected boolean convertToBoolean(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10405) if this AttributeValue is nullIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a booleanprotected Boolean convertToBooleanObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Booleanprotected SchemaObjectInterface convertToSchemaObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SchemaObjectprotected SystemObjectInterface convertToSystemObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SystemObjectprotected SimpleObjectInterface convertToSimpleObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SimpleObjectprotected PublicObjectInterface convertToPublicObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a PublicObjectprotected DirectoryObjectInterface convertToDirectoryObject(LibrarySessionInterface session, int index) throws IfsException
session
- the sessionindex
- the zero-based indexIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a DirectoryObjectprotected int[] convertToIntegerArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an int[]protected Integer[] convertToIntegerObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an Integer[]protected long[] convertToLongArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a long[]protected Long[] convertToLongObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Long[]protected double[] convertToDoubleArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a double[]protected Double[] convertToDoubleObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Double[]protected String[] convertToStringArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a String[]protected Date[] convertToDateArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Date[]protected boolean[] convertToBooleanArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a boolean[]protected Boolean[] convertToBooleanObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Boolean[]protected SchemaObjectInterface[] convertToSchemaObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SchemaObject[]protected SystemObjectInterface[] convertToSystemObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SystemObject[]protected SimpleObjectInterface[] convertToSimpleObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a SimpleObject[]protected PublicObjectInterface[] convertToPublicObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a PublicObject[]protected DirectoryObjectInterface[] convertToDirectoryObjectArray(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a DirectoryObject[]protected Map convertToMap(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Mapprotected final Integer toInteger(Number value, Localizer localizer) throws IfsException
value
- the Numberlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Integer toInteger(Boolean value, Localizer localizer) throws IfsException
value
- the Booleanlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Integer toInteger(String value, Localizer localizer) throws IfsException
value
- the Stringlocalizer
- the Localizer to useIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as an Integerprotected final Long toLong(Number value, Localizer localizer) throws IfsException
value
- the Numberlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Long toLong(Boolean value, Localizer localizer) throws IfsException
value
- the Booleanlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Long toLong(Date value, Localizer localizer) throws IfsException
value
- the Datelocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Long toLong(String value, Localizer localizer) throws IfsException
value
- the Stringlocalizer
- the Localizer to useIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Longprotected final Double toDouble(Number value, Localizer localizer) throws IfsException
value
- the Numberlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Double toDouble(Boolean value, Localizer localizer) throws IfsException
value
- the Booleanlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Double toDouble(String value, Localizer localizer) throws IfsException
value
- the Stringlocalizer
- the Localizer to useIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Doubleprotected final Boolean toBoolean(Integer value, Localizer localizer) throws IfsException
value
- the Integerlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Boolean toBoolean(Long value, Localizer localizer) throws IfsException
value
- the Longlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Boolean toBoolean(Double value, Localizer localizer) throws IfsException
value
- the Doublelocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Boolean toBoolean(String value, Localizer localizer) throws IfsException
value
- the Stringlocalizer
- the Localizer to useIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Booleanprotected final String toString(Integer value, Localizer localizer) throws IfsException
value
- the Integerlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final String toString(Long value, Localizer localizer) throws IfsException
value
- the Longlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final String toString(Double value, Localizer localizer) throws IfsException
value
- the Doublelocalizer
- the Localizer to useIfsException
- if the operation failsprotected final String toString(Boolean value, Localizer localizer) throws IfsException
value
- the Booleanlocalizer
- the Localizer to useIfsException
- if the operation failsprotected final String toString(Date value, Localizer localizer) throws IfsException
value
- the Datelocalizer
- the Localizer to useIfsException
- if the operation failsprotected final Date toDate(String value, Localizer localizer) throws IfsException
value
- the Stringlocalizer
- the Localizer to useIfsException
- (IFS-10406) if this AttributeValue cannot
be represented as a Dateprotected final Date toDate(Date value, Localizer localizer) throws IfsException
value
- the Datelocalizer
- the Localizer to useIfsException
- if the operation failspublic void setOption(String name, Object value)
name
- the option namevalue
- the option valuepublic void removeOption(String name)
name
- the option namevalue
- the option valuepublic Object getOption(String name)
name
- the name of the optionpublic void setTransientOption(boolean opt) throws IfsException
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic void setArrayAppendOption(boolean opt) throws IfsException
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic void setArrayPreventDuplicateValuesOption(boolean opt) throws IfsException
This does not remove any duplicates that may already exist.
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic void setArrayRemoveOption(boolean opt) throws IfsException
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic void setLiteralArrayBindValueOption(boolean opt) throws IfsException
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic void setMapPutOption(boolean opt) throws IfsException
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic void setMapRemoveOption(boolean opt) throws IfsException
opt
- whether the option should be set or unsetIfsException
- if the operation failspublic boolean getTransientOption()
public boolean getArrayAppendOption()
public boolean getArrayPreventDuplicateValuesOption()
public boolean getArrayRemoveOption()
public boolean getLiteralArrayBindValueOption()
opt
- whether the option is in effectIfsException
- if the operation failspublic boolean getMapPutOption()
public boolean getMapRemoveOption()
public Object clone()
public int compareTo(Object o)
compareTo
in interface Comparable
o
- the second AttributeValue to compare withpublic boolean canPurge() throws IfsException
The caller of this method indicates a desire to purge the object. The implementation should treat this as a purge request, but can return false if the item should not be purged.
canPurge
in interface LooselyBoundedCacheable
IfsException
- if operation fails.public void added(Object id)
added
in interface LooselyBoundedCacheable
id
- the id used for this entry in the cachepublic void removed(Object id)
removed
in interface LooselyBoundedCacheable
id
- the id used for this entry in the cacheprotected void resolve(LibrarySessionInterface session) throws IfsException
session
- the sessionIfsException
- if the operation failsCopyright © 2023. All rights reserved.