oracle.ifs.common

Class AttributeValueStringStringMap

java.lang.Object

oracle.ifs.common.AttributeValue

oracle.ifs.common.AttributeValueMap

oracle.ifs.common.AttributeValueStringStringMap

All Implemented Interfaces:

Serializable, Cloneable, Comparable, LooselyBoundedCacheable

public final class AttributeValueStringStringMap
extends AttributeValueMap

An AttributeValueStringStringMap represents the value of a string-string map-type Attribute in a LibraryObject.

Version:

1.0

Author:

Dave Long

See Also:

Serialized Form

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_OBJECT_NAME The default table suffix (database object name) for this data type.

Fields inherited from class oracle.ifs.common.AttributeValueMap

m_AttributeId, m_Count, m_ObjectId, 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	AttributeValueStringStringMap() Constructs an AttributeValueStringStringMap.
protected	AttributeValueStringStringMap(long objectId, Long attributeId, int count) Constructs an string-string map-type AttributeValue.
protected	AttributeValueStringStringMap(Map map) Constructs a string-string map-type AttributeValue.

Method Summary

Modifier and Type	Method and Description
protected Map	convertToMap(LibrarySessionInterface session) Converts this AttributeValue to a Map.
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.
int	getDataType() Gets the data type of this AttributeValue.
static String	getMultiValueTableCreateString(String tableName, int dataLen, int dataScale) Gets the CREATE TABLE string for multi-value tables for the specified table name.
Object	getObject(LibrarySessionInterface session) Gets the default object representation of this 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 map-type AttributeValue.

Methods inherited from class oracle.ifs.common.AttributeValueMap

getElementCount, isNullValue, resolve

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, 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 default table suffix (database object name) for this data type.

See Also:

Constant Field Values

(Unpublished)

Constructor Detail

AttributeValueStringStringMap

protected AttributeValueStringStringMap()
                                 throws IfsException

Constructs an AttributeValueStringStringMap.

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

Throws:

IfsException - if the operation fails

AttributeValueStringStringMap

protected AttributeValueStringStringMap(Map map)
                                 throws IfsException

Constructs a string-string map-type AttributeValue.

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

Parameters:

map - the string-string map

Throws:

IfsException - if the operation fails

AttributeValueStringStringMap

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

Constructs an string-string map-type AttributeValue.

This variant is used to retrieve an map-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 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

Throws:

IfsException - (IFS-19001) if attributeId is null

Method Detail

getDataType

public int getDataType()

Gets the data type of this AttributeValue.

Overrides:

getDataType in class AttributeValue

Returns:

the data type

getObject

public Object getObject(LibrarySessionInterface session)
                 throws IfsException

Gets the default object representation of this AttributeValue.

This will return a Map.

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

convertToMap

protected Map convertToMap(LibrarySessionInterface session)
                    throws IfsException

Converts this AttributeValue to a Map.

Overrides:

convertToMap in class AttributeValue

Parameters:

session - the session

Returns:

the Map of the appropriate type; null if the AttributeValue is null

Throws:

IfsException - if the operation fails

convertToStringArray

protected String[] convertToStringArray(LibrarySessionInterface session)
                                 throws IfsException

Converts this AttributeValue to an array of Strings.

This will return the array of String values in the order in which they were specified when inserted.

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

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

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.

Overrides:

processResultSet in class AttributeValueMap

Parameters:

rset - the result set

Returns:

a fully-resolved copy of this AttributeValue

Throws:

Exception - if the operation fails

loadElements

protected final void loadElements(AttributeValue source)

Copies the elements from the specified AttributeValue to this AttributeValue.

Overrides:

loadElements in class AttributeValueMap

Parameters:

source - the source AttributeValue

getMultiValueTableCreateString

public static final String getMultiValueTableCreateString(String tableName,
                                                          int dataLen,
                                                          int dataScale)
                                                   throws IfsException

Gets the CREATE TABLE string for multi-value tables for the specified table name.

Parameters:

tableName - the name of the table being created

dataLen - the data length specified

dataScale - the data scale specified

Returns:

the CREATE TABLE string

Throws:

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

(Unpublished)