oracle.ifs.common

Class AttributeValueArray

java.lang.Object

oracle.ifs.common.AttributeValue

oracle.ifs.common.AttributeValueArray

All Implemented Interfaces:

Serializable, Cloneable, Comparable, LooselyBoundedCacheable

Direct Known Subclasses:

AttributeValueBooleanArray, AttributeValueDateArray, AttributeValueDirectoryObjectArray, AttributeValueDoubleArray, AttributeValueIntegerArray, AttributeValueLongArray, AttributeValuePublicObjectArray, AttributeValueSchemaObjectArray, AttributeValueSimpleObjectArray, AttributeValueStringArray, AttributeValueSystemObjectArray

public class AttributeValueArray
extends AttributeValue

An AttributeValueArray represents the value of an array-type Attribute.

AttributeValueArray is an abstract class.

Version:

1.0

Author:

David Pitfield

See Also:

Serialized Form

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_AttributeId The Attribute id.
protected int	m_Count The number of elements in this AttributeValue.
protected long	m_ObjectId The LibraryObject ID.
protected Long	m_PrimaryClassId The primary Class ID, obtained from a ClassDomain setting for the Attribute.
protected oracle.ifs.common.SharedFlag	m_ResolvedFlag Whether the elements of this AttributeValueArray 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	AttributeValueArray() Constructs an AttrbuteValueArray.
protected	AttributeValueArray(long objectId, Long attributeId, Long priClassId, int count) Constructs an AttributeValueArray.

Method Summary

Modifier and Type	Method and Description
static String	getArrayTableCreateString(String tableName, String valueType) Gets the CREATE TABLE string for multi-value tables for the specified table name and SQL data type for the value.
String	getDatabaseObjectName() Gets the database object name of the array-type AttributeValue.
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 array-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, getElementCount, 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, isNullValue, 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 LibraryObject ID.

(Unpublished)

m_AttributeId

protected long m_AttributeId

The Attribute id.

(Unpublished)

m_PrimaryClassId

protected Long m_PrimaryClassId

The primary Class ID, obtained from a ClassDomain setting for the Attribute. This is null for all types except SimpleObject arrays.

(Unpublished)

m_Count

protected int m_Count

The number of elements in this AttributeValue.

(Unpublished)

m_ResolvedFlag

protected oracle.ifs.common.SharedFlag m_ResolvedFlag

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

(Unpublished)

Constructor Detail

AttributeValueArray

protected AttributeValueArray()
                       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

(Unpublished)

AttributeValueArray

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

Constructs an AttributeValueArray.

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.

Parameters:

objectId - The LibraryObject ID.

attributeId - The Attribute id.

priClassId - The primary Class ID

count - the number of elements in this AttributeValue

Throws:

IfsException - (IFS-19001) if attributeId is null

(Unpublished)

Method Detail

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

(Unpublished)

processResultSet

public AttributeValue processResultSet(ResultSet rset)
                                throws Exception

Processes the result set containing the elements of the array-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

(Unpublished)

loadElements

protected void loadElements(AttributeValue source)

Copies the elements from the specified AttributeValue to this AttributeValue.

Parameters:

source - the source AttributeValue

(Unpublished)

getDatabaseObjectName

public String getDatabaseObjectName()

Gets the database object name of the array-type AttributeValue.

Returns:

the database object name

(Unpublished)

getArrayTableCreateString

public static final String getArrayTableCreateString(String tableName,
                                                     String valueType)
                                              throws IfsException

Gets the CREATE TABLE string for multi-value tables for the specified table name and SQL data type for the value.

Parameters:

tableName - the name of the table being created

valueType - the SQL value, e.g. "NUMBER(20)"

Throws:

IfsException - (IFS-10400) if the specified type is not valid

(Unpublished)