oracle.ifs.common

Class AttributeValueDirectoryObjectArray

java.lang.Object

oracle.ifs.common.AttributeValue

oracle.ifs.common.AttributeValueArray

oracle.ifs.common.AttributeValueDirectoryObjectArray

All Implemented Interfaces:

Serializable, Cloneable, Comparable, LooselyBoundedCacheable

public final class AttributeValueDirectoryObjectArray
extends AttributeValueArray

An AttributeValueDirectoryObjectArray represents the value of a DirectoryObject array-type Attribute in a LibraryObject.

Version:

1.0

Author:

David Pitfield

See Also:

Serialized Form

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_OBJECT_NAME The database object name of the array-type AttributeValue.
protected Long[]	m_Ids The DirectoryObject ids.
protected Long[]	m_MarshaledIds The array used to transport elements across the CORBA line.

Fields inherited from class oracle.ifs.common.AttributeValueArray

m_AttributeId, m_Count, m_ObjectId, m_PrimaryClassId, m_ResolvedFlag

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	AttributeValueDirectoryObjectArray(DirectoryObjectInterface[] values) Constructs an array-type DirectoryObject AttributeValue.
protected	AttributeValueDirectoryObjectArray(Long[] values) Constructs an array-type DirectoryObject AttributeValue.
protected	AttributeValueDirectoryObjectArray(long objectId, Long attributeId, Long priClassId, int count) Constructs an array-type DirectoryObject AttributeValue.

Method Summary

Modifier and Type	Method and Description
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 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 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.
String	getDatabaseObjectName() Gets the database object name of the array-type AttributeValue.
int	getDataType() Gets the data type of this AttributeValue.
int	getElementCount() Gets the number of elements in an array-type AttributeValue.
Object	getObject(LibrarySessionInterface session) Gets the default object representation of this 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 array-type AttributeValue.

Methods inherited from class oracle.ifs.common.AttributeValueArray

getArrayTableCreateString, resolve

Methods inherited from class oracle.ifs.common.AttributeValue

added, arrayToHashtable, canPurge, clone, compareTo, convertToBoolean, convertToBooleanArray, convertToBooleanObject, convertToBooleanObjectArray, convertToDate, convertToDateArray, convertToDouble, convertToDoubleArray, convertToDoubleObject, convertToDoubleObjectArray, convertToInteger, convertToIntegerArray, convertToIntegerObject, convertToIntegerObjectArray, convertToMap, convertToPublicObject, convertToPublicObjectArray, convertToSchemaObject, convertToSchemaObjectArray, convertToSimpleObject, convertToSimpleObjectArray, convertToSystemObject, convertToSystemObjectArray, ensureUpperCaseName, getArrayAppendOption, getArrayPreventDuplicateValuesOption, getArrayRemoveOption, getBoolean, getBooleanArray, getBooleanArray, getBooleanObject, getBooleanObjectArray, getBooleanObjectArray, 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, 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

DATABASE_OBJECT_NAME

public static final String DATABASE_OBJECT_NAME

The database object name of the array-type AttributeValue.

See Also:

Constant Field Values

(Unpublished)

m_Ids

protected transient Long[] m_Ids

The DirectoryObject ids.

This is transient to prevent it from being transported across the CORBA line.

(Unpublished)

m_MarshaledIds

protected Long[] m_MarshaledIds

The array used to transport elements across the CORBA line. We still this and m_Ids for backwards compatibility with AVs serialized using previous iFS versions (pre 9.0.3).

(Unpublished)

Constructor Detail

AttributeValueDirectoryObjectArray

protected AttributeValueDirectoryObjectArray(DirectoryObjectInterface[] values)
                                      throws IfsException

Constructs an array-type DirectoryObject AttributeValue.

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

Parameters:

values - the DirectoryObject values

Throws:

IfsException - if the operation fails

(Unpublished)

AttributeValueDirectoryObjectArray

protected AttributeValueDirectoryObjectArray(Long[] values)
                                      throws IfsException

Constructs an array-type DirectoryObject AttributeValue.

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

Parameters:

values - the Long values

Throws:

IfsException - if the operation fails

(Unpublished)

AttributeValueDirectoryObjectArray

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

Constructs an array-type DirectoryObject AttributeValue.

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 - object ID

attributeId - Attribute ID

priClassId - the class ID reflecting a ClassDomain setting

count - the number of elements in this AttributeValue

Throws:

IfsException - (IFS-19001) if attributeId is null

(Unpublished)

Method Detail

getDataType

public int getDataType()

Gets the data type of this AttributeValue.

Overrides:

getDataType in class AttributeValue

Returns:

the data type

(Published)

isNullValue

public boolean isNullValue()

Gets whether this AttributeValue is null.

Overrides:

isNullValue in class AttributeValue

Returns:

whether the AttributeValue is null

(Published)

getElementCount

public int getElementCount()

Gets the number of elements in an array-type AttributeValue.

Overrides:

getElementCount in class AttributeValue

Returns:

the number of elements, or 0 if the AttributeValue is null or not an array type

(Published)

getObject

public Object getObject(LibrarySessionInterface session)
                 throws IfsException

Gets the default object representation of this AttributeValue.

Overrides:

getObject in class AttributeValue

Parameters:

session - the session

Returns:

the default object representation

Throws:

IfsException - (IFS-10406) if there is a AttributeValue conversion error

(Published)

convertToLong

protected long convertToLong(LibrarySessionInterface session,
                             int index)
                      throws IfsException

Converts this AttributeValue to a long.

Overrides:

convertToLong in class AttributeValue

Parameters:

session - the session

index - the zero-based index

Returns:

the long value

Throws:

IfsException - (IFS-10406) if this AttributeValue cannot be represented as a long

(Unpublished)

convertToLongObject

protected Long convertToLongObject(LibrarySessionInterface session,
                                   int index)
                            throws IfsException

Converts this AttributeValue to a Long.

Overrides:

convertToLongObject in class AttributeValue

Parameters:

session - the session

index - the zero-based index

Returns:

the Long value

Throws:

IfsException - (IFS-10406) if this AttributeValue cannot be represented as a Long

(Unpublished)

convertToLongArray

protected long[] convertToLongArray(LibrarySessionInterface session)
                             throws IfsException

Converts this AttributeValue to an array of longs.

Overrides:

convertToLongArray in class AttributeValue

Parameters:

session - the session

Returns:

the long array; null if the AttributeValue is null

Throws:

IfsException - (IFS-10406) if this AttributeValue cannot be represented as a long[]

(Unpublished)

convertToLongObjectArray

protected Long[] convertToLongObjectArray(LibrarySessionInterface session)
                                   throws IfsException

Converts this AttributeValue to an array of Longs.

Overrides:

convertToLongObjectArray in class AttributeValue

Parameters:

session - the session

Returns:

the Long array; null if the AttributeValue is null

Throws:

IfsException - if the operation fails

(Unpublished)

convertToDirectoryObject

protected DirectoryObjectInterface convertToDirectoryObject(LibrarySessionInterface session,
                                                            int index)
                                                     throws IfsException

Converts this AttributeValue to a DirectoryObject.

Overrides:

convertToDirectoryObject in class AttributeValue

Parameters:

session - the session

index - the zero-based index

Returns:

the DirectoryObject value

Throws:

IfsException - (IFS-10406) if this AttributeValue cannot be represented as a DirectoryObject

(Unpublished)

convertToDirectoryObjectArray

protected DirectoryObjectInterface[] convertToDirectoryObjectArray(LibrarySessionInterface session)
                                                            throws IfsException

Converts this AttributeValue to an array of DirectoryObjects.

Overrides:

convertToDirectoryObjectArray in class AttributeValue

Parameters:

session - the session

Returns:

the DirectoryObject array; null if the AttributeValue is null

Throws:

IfsException - (IFS-10406) if this AttributeValue cannot be represented as a DirectoryObject[]

(Unpublished)

convertToString

protected String convertToString(LibrarySessionInterface session,
                                 int index)
                          throws IfsException

Converts this AttributeValue to a String.

Overrides:

convertToString in class AttributeValue

Parameters:

session - the session

index - the zero-based index

Returns:

the String value

Throws:

IfsException - (IFS-10406) if this AttributeValue cannot be represented as a String

(Unpublished)

convertToStringArray

protected String[] convertToStringArray(LibrarySessionInterface session)
                                 throws IfsException

Converts this AttributeValue to an array of Strings.

Overrides:

convertToStringArray in class AttributeValue

Parameters:

session - the session

Returns:

the String array; null if the AttributeValue is null

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.

Overrides:

processResultSet in class AttributeValueArray

Parameters:

rset - the result set

Returns:

a fully-resolved copy of this AttributeValue

Throws:

Exception - if the operation fails

(Unpublished)

loadElements

protected final void loadElements(AttributeValue source)

Copies the elements from the specified AttributeValue to this AttributeValue.

Overrides:

loadElements in class AttributeValueArray

Parameters:

source - the source AttributeValue

(Unpublished)

getDatabaseObjectName

public final String getDatabaseObjectName()

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

Overrides:

getDatabaseObjectName in class AttributeValueArray

Returns:

the database object name

(Unpublished)