oracle.ifs.common

Class AttributeValueMap

java.lang.Object

oracle.ifs.common.AttributeValue

oracle.ifs.common.AttributeValueMap

All Implemented Interfaces:

Serializable, Cloneable, Comparable, LooselyBoundedCacheable

Direct Known Subclasses:

AttributeValueLongLongMap, AttributeValueLongStringMap, AttributeValueStringDoubleMap, AttributeValueStringLongMap, AttributeValueStringStringMap

public abstract class AttributeValueMap
extends AttributeValue

An AttributeValueMap represents the value of an map-type Attribute.

AttributeValueMap is an abstract class.

Version:

1.0

Author:

Dave Long

See Also:

Serialized Form

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_AttributeId The ID of the Attribute.
protected int	m_Count The number of elements in this AttributeValue's map.
protected long	m_ObjectId The ID of the LibraryObject for which this AttributeValue represents the value of one of its Attributes.
protected oracle.ifs.common.AttributeValueMap.SharedFlag	m_ResolvedFlag Whether the elements of this AttributeValueMap have been retrieved from the database.

Fields inherited from class oracle.ifs.common.AttributeValue

LONG_ZERO, m_Name, m_Options, OPTION_ARRAY_APPEND_MODE, OPTION_ARRAY_PREVENT_DUPLICATES, OPTION_ARRAY_REMOVE_MODE, OPTION_LITERAL_ARRAY_BIND_VALUE, OPTION_MAP_PUT_MODE, OPTION_MAP_REMOVE_MODE, OPTION_TRANSIENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttributeValueMap() Constructs an AttrbuteValueArray.
protected	AttributeValueMap(long objectId, Long attributeId, int count) Constructs an AttributeValueMap.

Method Summary

Modifier and Type	Method and Description
int	getElementCount() Gets the number of elements in a map-type AttributeValue.
boolean	isNullValue() Gets whether this AttributeValue is null.
protected void	loadElements(AttributeValue source) Copies the elements from the specified AttributeValue to this AttributeValue.
AttributeValue	processResultSet(ResultSet rset) Processes the result set containing the elements of the map-type AttributeValue.
protected void	resolve(LibrarySessionInterface session) Ensures that the elements of this AttributeValue have been loaded from the database.

Methods inherited from class oracle.ifs.common.AttributeValue

added, arrayToHashtable, canPurge, clone, compareTo, convertToBoolean, convertToBooleanArray, convertToBooleanObject, convertToBooleanObjectArray, convertToDate, convertToDateArray, convertToDirectoryObject, convertToDirectoryObjectArray, convertToDouble, convertToDoubleArray, convertToDoubleObject, convertToDoubleObjectArray, convertToInteger, convertToIntegerArray, convertToIntegerObject, convertToIntegerObjectArray, convertToLong, convertToLongArray, convertToLongObject, convertToLongObjectArray, convertToMap, convertToPublicObject, convertToPublicObjectArray, convertToSchemaObject, convertToSchemaObjectArray, convertToSimpleObject, convertToSimpleObjectArray, convertToString, convertToStringArray, convertToSystemObject, convertToSystemObjectArray, ensureUpperCaseName, getArrayAppendOption, getArrayPreventDuplicateValuesOption, getArrayRemoveOption, getBoolean, getBooleanArray, getBooleanArray, getBooleanObject, getBooleanObjectArray, getBooleanObjectArray, getDataType, getDate, getDateArray, getDateArray, getDirectoryObject, getDirectoryObjectArray, getDirectoryObjectArray, getDouble, getDoubleArray, getDoubleArray, getDoubleObject, getDoubleObjectArray, getDoubleObjectArray, getInteger, getIntegerArray, getIntegerArray, getIntegerObject, getIntegerObjectArray, getIntegerObjectArray, getLibraryObject, getLiteralArrayBindValueOption, getLong, getLongArray, getLongArray, getLongObject, getLongObjectArray, getLongObjectArray, getMap, getMapPutOption, getMapRemoveOption, getName, getObject, getOption, getPublicObject, getPublicObjectArray, getPublicObjectArray, getSchemaObject, getSchemaObjectArray, getSchemaObjectArray, getSimpleObject, getSimpleObjectArray, getSimpleObjectArray, getString, getStringArray, getStringArray, getSystemObject, getSystemObjectArray, getSystemObjectArray, getTransientOption, hashtableToArray, isArrayType, isLibraryObjectArrayType, isLibraryObjectScalarType, isLibraryObjectType, isMapType, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newAttributeValue, newNullAttributeValue, overrideName, removed, removeOption, setArrayAppendOption, setArrayPreventDuplicateValuesOption, setArrayRemoveOption, setLiteralArrayBindValueOption, setMapPutOption, setMapRemoveOption, setName, setOption, setTransientOption, toBoolean, toBoolean, toBoolean, toBoolean, toDate, toDate, toDouble, toDouble, toDouble, toInteger, toInteger, toInteger, toLong, toLong, toLong, toLong, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

m_ObjectId

protected long m_ObjectId

The ID of the LibraryObject for which this AttributeValue represents the value of one of its Attributes.

m_AttributeId

protected long m_AttributeId

The ID of the Attribute.

m_Count

protected int m_Count

The number of elements in this AttributeValue's map.

m_ResolvedFlag

protected oracle.ifs.common.AttributeValueMap.SharedFlag m_ResolvedFlag

Whether the elements of this AttributeValueMap have been retrieved from the database.

Constructor Detail

AttributeValueMap

protected AttributeValueMap()
                     throws IfsException

Constructs an AttrbuteValueArray.

This variant is used when the user explicitly creates an AttributeValue using the static factory methods of AttributeValue.

Throws:

IfsException - if the operation fails

AttributeValueMap

protected AttributeValueMap(long objectId,
                            Long attributeId,
                            int count)
                     throws IfsException

Constructs an AttributeValueMap.

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.

Parameters:

objectId - the ID of the LibraryObject for which this AttributeValue represents the value of one of its Attributes

attributeId - the ID of the Attribute

count - the number of elements in this AttributeValue's map

Throws:

IfsException - (IFS-19001) if attributeId is null

Method Detail

isNullValue

public boolean isNullValue()

Gets whether this AttributeValue is null.

Overrides:

isNullValue in class AttributeValue

Returns:

whether the AttributeValue is null

getElementCount

public int getElementCount()

Gets the number of elements in a map-type AttributeValue.

Overrides:

getElementCount in class AttributeValue

Returns:

the number of elements, or 0 if the AttributeValue is null

resolve

protected final void resolve(LibrarySessionInterface session)
                      throws IfsException

Ensures that the elements of this AttributeValue have been loaded from the database.

Overrides:

resolve in class AttributeValue

Parameters:

session - the session

Throws:

IfsException - if the operation fails

processResultSet

public AttributeValue processResultSet(ResultSet rset)
                                throws Exception

Processes the result set containing the elements of the map-type AttributeValue.

For internal use only. Do not use this method.

The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.

Parameters:

rset - the result set

Returns:

a fully-resolved copy of this AttributeValue

Throws:

Exception - if the operation fails

loadElements

protected void loadElements(AttributeValue source)

Copies the elements from the specified AttributeValue to this AttributeValue.

Parameters:

source - the source AttributeValue