oracle.ifs.core.util

Class AttributeValueTable

java.lang.Object

oracle.ifs.core.util.AttributeValueTable

public class AttributeValueTable
extends Object

An AttributeValueTable manages a table of AttributeValues, and performs transformations to and from it to other representations.

Version:

1.0

Author:

Dave Long

(Published)

Constructor Summary

Constructors

Constructor and Description
AttributeValueTable() Constructs an empty AttributeValueTable.
AttributeValueTable(AttributeValue[] values) Constructs an AttributeValueTable from an array of AttributeValues.
AttributeValueTable(AttributeValueTable avt) Constructs an AttributeValueTable from another AttributeValueTable.
AttributeValueTable(boolean caseSensitive) Constructs an empty AttributeValueTable, with case sensitivity specified
AttributeValueTable(List list) Constructs an AttributeValueTable from a list of AttributeValues.
AttributeValueTable(ParameterTable pt) Constructs an AttributeValueTable from a ParameterTable.
AttributeValueTable(Property[] props) Constructs an AttributeValueTable from an array of Property.
AttributeValueTable(PropertyBundle pb) Constructs an AttributeValueTable from a PropertyBundle.
AttributeValueTable(SimpleProperty[] props) Constructs an AttributeValueTable from a set of SimpleProperty.

Method Summary

Modifier and Type	Method and Description
void	captureSession(LibrarySessionInterface session) Use the specified session as this object's session context.
SimpleProperty[]	createSimpleProperties(LibraryObject refObj) Creates SimpleProperty objects
AttributeValue	get(String key) Gets a value matching the specified key.
AttributeValue	get(String[] keys) Gets a value matching one of the specified keys.
AttributeValue	getAttributeValue() Gets the representative value contained by this table.
AttributeValueGetter	getAttributeValueGetter() Gets the AttributeValueGetter, if any.
Boolean	getBoolean(String key) Gets a Boolean value matching the specified key.
boolean	getBoolean(String key, boolean defValue) Gets an boolean value matching the specified key Returns null if no value exists for the specified key, or if the value stored represents a null Boolean value.
Boolean[]	getBooleanArray(String key) Gets an Boolean array value matching the specified key.
AttributeValue	getBooleanValue(String key) Gets an AttributeValue representing the Boolean value matching the specified key.
Date	getDate(String key) Gets an Date value matching the specified key.
Date[]	getDateArray(String key) Gets a Date array value matching the specified key.
AttributeValue	getDateValue(String key) Gets an AttributeValue representing the Date value matching the specified key.
DirectoryObject	getDirectoryObject(String key, LibrarySession session) Gets a DirectoryObject value matching the specified key.
Double	getDouble(String key) Gets an Double value matching the specified key.
double	getDouble(String key, double defValue) Gets an double value matching the specified key Returns null if no value exists for the specified key, or if the value stored represents a null Double value.
Double[]	getDoubleArray(String key) Gets an Double array value matching the specified key.
AttributeValue	getDoubleValue(String key) Gets an AttributeValue representing the Double value matching the specified key.
AttributeValue	getFixedAttributeValue() Gets the "fixed value" for this table, if one was set.
List<AttributeValueTable>	getFixedTableList() Gets the "fixed list of AttributeValueTables" for this table, if one was set.
Integer	getInteger(String key) Gets an Integer value matching the specified key.
int	getInteger(String key, int defValue) Gets an int value matching the specified key Returns null if no value exists for the specified key, or if the value stored represents a null Integer value.
Integer[]	getIntegerArray(String key) Gets an Integer array value matching the specified key.
AttributeValue	getIntegerValue(String key) Gets an AttributeValue representing the Integer value matching the specified key.
String[]	getKeys() Gets all value keys in the table.
Long	getLong(String key) Gets an Long value matching the specified key.
long	getLong(String key, long defValue) Gets an long value matching the specified key Returns null if no value exists for the specified key, or if the value stored represents a null Long value.
Long[]	getLongArray(String key) Gets an Long array value matching the specified key.
AttributeValue	getLongValue(String key) Gets an AttributeValue representing the Long value matching the specified key.
PropertyBundleDefinition	getPropertyBundleDefinition(LibrarySession session) Gets all values in the table, represented as a PropertyBundleDefinition.
PropertyDefinition[]	getPropertyDefinitions(LibrarySession session) Gets all values in the table, represented as an array of PropertyDefinitions.
PublicObject	getPublicObject(String key, LibrarySession session) Gets a PublicObject value matching the specified key.
SchemaObject	getSchemaObject(String key, LibrarySession session) Gets a SchemaObject value matching the specified key.
LibrarySessionInterface	getSession() Gets the session context for this table, if any.
SimpleObject	getSimpleObject(String key, LibrarySession session) Gets a SimpleObject value matching the specified key.
String	getString(String key) Gets a String value matching the specified key.
String	getString(String[] keys) Gets a String value matching one of the specified keys.
String	getString(String[] keys, String defValue) Gets a String value matching one of the specified keys, or return the specified default value if none of the keys match a stored value or if the value stored is a null String.
String	getString(String key, String defValue) Gets a String value matching the specified key, or return the specified default value if the key does not match a stored value or if the value stored is a null String.
String[]	getStringArray(String key) Gets an String array value matching the specified key.
AttributeValue	getStringArrayValue(String key) Gets an AttributeValue representing the StringArray value matching the specified key.
AttributeValue	getStringValue(String key) Gets an AttributeValue representing the String value matching the specified key.
AttributeValue	getStringValue(String[] keys) Gets an AttributeValue representing the String value matching one of the specified keys.
SystemObject	getSystemObject(String key, LibrarySession session) Gets a SystemObject value matching the specified key.
AttributeValueTable	getTable(String key) Gets a table matching the specified key.
int	getTableCount() Gets the number of tables defined in the table.
String[]	getTableKeys() Gets all table keys in the table.
List<AttributeValueTable>	getTableList(String key) Gets a tablelist matching the specified key.
int	getTableListCount() Gets the number of tablelists defined in the table.
String[]	getTableListKeys() Gets all tablelist keys in the table.
List<AttributeValueTable>[]	getTableLists() Gets all tablelists (each represented by a List) in the tablelist map.
AttributeValueTable[]	getTables() Gets all tables (each represented by a AttributeValueTable) in the table map.
int	getValueCount() Gets the number of values defined in the table.
AttributeValue[]	getValues() Gets all values in the table.
boolean	isFixedAttributeValue() Checks if a "fixed value" has been set for this table.
boolean	isFixedTableList() Checks if a "fixed list of AttributeValueTables" has been set for this table.
void	put(AttributeValue av) Stores a new value, using an implicit key of the value's name.
void	put(AttributeValue[] values) Applies values from the specified array of AttributeValues.
void	put(AttributeValueTable avt) Applies the values from the specified table to the target one, overriding values previously in the target table with ones in the specified table.
void	put(List list) Applies values from the specified list of AttributeValues.
void	put(ParameterTable pt) Applies values from the specified ParameterTable.
void	put(Property[] props) Applies values from the specified array of Property objects.
void	put(PropertyBundle pb) Applies values from the specified PropertyBundle.
void	put(SimpleProperty[] props) Applies values from the specified array of SimpleProperty objects.
void	put(String key, AttributeValue av) Stores a new value, using an explicit key.
void	put(String key, boolean value) Stores a new boolean value, using an explicit key.
void	put(String key, double value) Stores a new double value, using an explicit key.
void	put(String key, int value) Stores a new integer value, using an explicit key.
void	put(String key, long value) Stores a new long value, using an explicit key.
void	put(String key, String value) Stores a new String value, using an explicit key.
void	put(String key, String[] value) Stores a new String array value, using an explicit key.
void	putTable(String key, AttributeValueTable avt) Stores a new table, using an explicit key.
void	putTableList(String key, AttributeValueTable table) Stores a new tablelist from the specified table, using an explicit key.
void	putTableList(String key, List<AttributeValueTable> list) Stores a new tablelist, using an explicit key.
AttributeValue	remove(String key) Removes a value from the target table.
AttributeValueTable	removeTable(String key) Removes a table from the target table.
List<AttributeValueTable>	removeTableList(String key) Removes a tablelist from the target table.
void	setAttributeValueGetter(AttributeValueGetter avGetter) Sets the AttributeValueGetter for this table.
void	setFixedAttributeValue(AttributeValue val) Sets a "fixed value" for this table.
void	setFixedTableList(List<AttributeValueTable> val) Sets a "fixed list of AttributeValueTables" for this table.
void	setSession(LibrarySessionInterface session) Sets the session context for this table.
String	toDisplayString(AttributeValue av, LibrarySessionInterface session) Provide String representation of the specified AttributeValue.
Map<Long,AttributeValue>	toLongAttributeValueMap() Generate a map, using the values as AttributeValues and Longs as keys.
Map<Long,AttributeValue>	toLongAttributeValueMap(LibrarySession session) Generate a map, using the values as AttributeValues and Longs as keys.
Map<Long,Double>	toLongDoubleMap() Generate a map, using the keys as Longs and the values as Doubles.
Map<Long,Double>	toLongDoubleMap(LibrarySession session) Generate a map, using the keys as Longs and the values as Doubles.
Map<Long,Long>	toLongLongMap() Generate a map, using the keys as Longs and the values as Longs.
Map<Long,Long>	toLongLongMap(LibrarySession session) Generate a map, using the keys as Longs and the values as Longs.
Map<Long,String>	toLongStringMap() Generate a map, using the keys as Longs and the values as Strings.
Map<Long,String>	toLongStringMap(LibrarySession session) Generate a map, using the keys as Longs and the values as Strings.
String	toString() Provide String representation of this object.
String	toString(LibrarySessionInterface session, String indent) Provide String representation of this object, using session context and indentation.
Map<String,AttributeValue>	toStringAttributeValueMap() Generate a map, using the values as AttributeValues and Strings as keys.
Map<String,AttributeValue>	toStringAttributeValueMap(LibrarySession session) Generate a map, using the values as AttributeValues and Strings as keys.
Map<String,Double>	toStringDoubleMap() Generate a map, using the values as Doubles.
Map<String,Double>	toStringDoubleMap(LibrarySession session) Generate a map, using the values as Doubles.
Map<String,Long>	toStringLongMap() Generate a map, using the values as Longs.
Map<String,Long>	toStringLongMap(LibrarySession session) Generate a map, using the values as Longs.
Map<String,String>	toStringStringMap() Generate a map, using the values as Strings.
Map<String,String>	toStringStringMap(LibrarySession session) Generate a map, using the values as Strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeValueTable

public AttributeValueTable()

Constructs an empty AttributeValueTable.

(Published)

AttributeValueTable

public AttributeValueTable(boolean caseSensitive)

Constructs an empty AttributeValueTable, with case sensitivity specified

Parameters:

caseSensitive - true if the keys are intended to be case sensitive; false for case insensitive (the default)

(Published)

AttributeValueTable

public AttributeValueTable(SimpleProperty[] props)
                    throws IfsException

Constructs an AttributeValueTable from a set of SimpleProperty.

Parameters:

props - the source SimpleProperty objects

Throws:

IfsException - if the operation fails

(Published)

AttributeValueTable

public AttributeValueTable(PropertyBundle pb)
                    throws IfsException

Constructs an AttributeValueTable from a PropertyBundle.

Parameters:

pb - the source PropertyBundle

Throws:

IfsException - if the operation fails

(Published)

AttributeValueTable

public AttributeValueTable(Property[] props)
                    throws IfsException

Constructs an AttributeValueTable from an array of Property.

Parameters:

props - the source Property objects

Throws:

IfsException - if the operation fails

(Published)

AttributeValueTable

public AttributeValueTable(List list)
                    throws IfsException

Constructs an AttributeValueTable from a list of AttributeValues.

Parameters:

list - the List of AttributeValues

Throws:

IfsException - if the operation fails

(Published)

AttributeValueTable

public AttributeValueTable(AttributeValue[] values)
                    throws IfsException

Constructs an AttributeValueTable from an array of AttributeValues.

Parameters:

values - the array of AttributeValues

Throws:

IfsException - if the operation fails

(Published)

AttributeValueTable

public AttributeValueTable(AttributeValueTable avt)
                    throws IfsException

Constructs an AttributeValueTable from another AttributeValueTable.

Parameters:

avt - the source AttributeValueTable

Throws:

IfsException - if the operation fails

(Published)

AttributeValueTable

public AttributeValueTable(ParameterTable pt)
                    throws IfsException

Constructs an AttributeValueTable from a ParameterTable.

Parameters:

pt - the source ParameterTable

Throws:

IfsException - if the operation fails

(Published)

Method Detail

getSession

public LibrarySessionInterface getSession()

Gets the session context for this table, if any.

The session context is used for certain data type conversions, such as from String to Date, where the session's Localizer is used in the conversion.

Returns:

the session context

(Published)

setSession

public void setSession(LibrarySessionInterface session)

Sets the session context for this table.

Parameters:

session - the session context

(Published)

captureSession

public void captureSession(LibrarySessionInterface session)

Use the specified session as this object's session context.

Parameters:

session - the session context

(Published)

getAttributeValueGetter

public AttributeValueGetter getAttributeValueGetter()

Gets the AttributeValueGetter, if any.

Returns:

the AttributeValueGetter

(Published)

setAttributeValueGetter

public void setAttributeValueGetter(AttributeValueGetter avGetter)

Sets the AttributeValueGetter for this table.

Parameters:

avGetter - the AttributeValueGetter

(Published)

setFixedAttributeValue

public void setFixedAttributeValue(AttributeValue val)

Sets a "fixed value" for this table.

Parameters:

val - the fixed value

(Published)

isFixedAttributeValue

public boolean isFixedAttributeValue()

Checks if a "fixed value" has been set for this table.

Returns:

true if a fixed value is set

(Published)

getFixedAttributeValue

public AttributeValue getFixedAttributeValue()

Gets the "fixed value" for this table, if one was set.

Returns:

the fixed value

(Published)

setFixedTableList

public void setFixedTableList(List<AttributeValueTable> val)

Sets a "fixed list of AttributeValueTables" for this table.

Parameters:

val - the fixed list of AttributeValueTable

(Published)

isFixedTableList

public boolean isFixedTableList()

Checks if a "fixed list of AttributeValueTables" has been set for this table.

Returns:

true if a fixed list of AttributeValueTable is set

(Published)

getFixedTableList

public List<AttributeValueTable> getFixedTableList()

Gets the "fixed list of AttributeValueTables" for this table, if one was set.

Returns:

the fixed list of AttributeValueTable

(Published)

getAttributeValue

public AttributeValue getAttributeValue()
                                 throws IfsException

Gets the representative value contained by this table.

This typically delegates to the AttributeValueGetter defined. If no AttributeValueGetter is defined, return the value for the "VALUE" key.

Returns:

the representative value

Throws:

IfsException - if the operation fails

(Published)

get

public AttributeValue get(String key)
                   throws IfsException

Gets a value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

IfsException - if the operation fails

(Published)

get

public AttributeValue get(String[] keys)
                   throws IfsException

Gets a value matching one of the specified keys.

Returns null if no value exists for any of the specified keys.

Parameters:

keys - the keys

Returns:

the value

Throws:

IfsException - if the operation fails

(Published)

getString

public String getString(String key)
                 throws IfsException

Gets a String value matching the specified key.

Returns null if no value exists for the specified key, or if the value stored represents a null String value.

Parameters:

key - the key

Returns:

the String value

Throws:

IfsException - if the operation fails

(Published)

getString

public String getString(String[] keys)
                 throws IfsException

Gets a String value matching one of the specified keys.

Returns null if no value exists for any of the specified keys, or if the value stored represents a null String value.

Parameters:

keys - the keys

Returns:

the String value

Throws:

IfsException - if the operation fails

(Published)

getStringValue

public AttributeValue getStringValue(String key)
                              throws IfsException

Gets an AttributeValue representing the String value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is String)

Throws:

IfsException - if the operation fails

(Published)

getStringValue

public AttributeValue getStringValue(String[] keys)
                              throws IfsException

Gets an AttributeValue representing the String value matching one of the specified keys.

Returns null if no value exists for any of the specified keys, or if the value stored represents a null String value.

Parameters:

keys - the keys

Returns:

the value (type is String)

Throws:

IfsException - if the operation fails

(Published)

getString

public String getString(String key,
                        String defValue)
                 throws IfsException

Gets a String value matching the specified key, or return the specified default value if the key does not match a stored value or if the value stored is a null String.

Returns the specified default value if no value exists for the specified key or if the value is null.

Parameters:

key - the key

defValue - the default value to return if the key does not match a stored value or if the stored value is null

Returns:

the String value

Throws:

IfsException - if the operation fails

(Published)

getString

public String getString(String[] keys,
                        String defValue)
                 throws IfsException

Gets a String value matching one of the specified keys, or return the specified default value if none of the keys match a stored value or if the value stored is a null String.

Returns the specified default value if no value exists for any of the specified keys, or if the value is null.

Parameters:

keys - the keys

defValue - the default value to return if the keys do not match a stored value or if the stored value is null

Returns:

the String value

Throws:

IfsException - if the operation fails

(Published)

getInteger

public Integer getInteger(String key)
                   throws IfsException

Gets an Integer value matching the specified key.

Returns null if no value exists for the specified key, or if the value stored represents a null Integer value.

Parameters:

key - the key

Returns:

the Integer value

Throws:

IfsException - if the operation fails

(Published)

getIntegerValue

public AttributeValue getIntegerValue(String key)
                               throws IfsException

Gets an AttributeValue representing the Integer value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is Integer)

Throws:

IfsException - if the operation fails

(Published)

getInteger

public int getInteger(String key,
                      int defValue)
               throws IfsException

Gets an int value matching the specified key

Returns null if no value exists for the specified key, or if the value stored represents a null Integer value.

Parameters:

key - the key

defValue - the default value to return if the key does not match a stored value

Returns:

the int value

Throws:

IfsException - if the operation fails

(Published)

getLong

public Long getLong(String key)
             throws IfsException

Gets an Long value matching the specified key.

Returns null if no value exists for the specified key, or if the value stored represents a null Long value.

Parameters:

key - the key

Returns:

the Long value

Throws:

IfsException - if the operation fails

(Published)

getLongValue

public AttributeValue getLongValue(String key)
                            throws IfsException

Gets an AttributeValue representing the Long value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is Long)

Throws:

IfsException - if the operation fails

(Published)

getLong

public long getLong(String key,
                    long defValue)
             throws IfsException

Gets an long value matching the specified key

Returns null if no value exists for the specified key, or if the value stored represents a null Long value.

Parameters:

key - the key

defValue - the default value to return if the key does not match a stored value

Returns:

the long value

Throws:

IfsException - if the operation fails

(Published)

getDouble

public Double getDouble(String key)
                 throws IfsException

Gets an Double value matching the specified key.

Returns null if no value exists for the specified key, or if the value stored represents a null Double value.

Parameters:

key - the key

Returns:

the Double value

Throws:

IfsException - if the operation fails

(Published)

getDoubleValue

public AttributeValue getDoubleValue(String key)
                              throws IfsException

Gets an AttributeValue representing the Double value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is Double)

Throws:

IfsException - if the operation fails

(Published)

getDouble

public double getDouble(String key,
                        double defValue)
                 throws IfsException

Gets an double value matching the specified key

Returns null if no value exists for the specified key, or if the value stored represents a null Double value.

Parameters:

key - the key

defValue - the default value to return if the key does not match a stored value

Returns:

the double value

Throws:

IfsException - if the operation fails

(Published)

getBoolean

public Boolean getBoolean(String key)
                   throws IfsException

Gets a Boolean value matching the specified key.

Returns null if no value exists for the specified key, or if the value stored represents a null Boolean value.

Parameters:

key - the key

Returns:

the Boolean value

Throws:

IfsException - if the operation fails

(Published)

getBooleanValue

public AttributeValue getBooleanValue(String key)
                               throws IfsException

Gets an AttributeValue representing the Boolean value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is Boolean)

Throws:

IfsException - if the operation fails

(Published)

getBoolean

public boolean getBoolean(String key,
                          boolean defValue)
                   throws IfsException

Gets an boolean value matching the specified key

Returns null if no value exists for the specified key, or if the value stored represents a null Boolean value.

Parameters:

key - the key

defValue - the default value to return if the key does not match a stored value

Returns:

the boolean value

Throws:

IfsException - if the operation fails

(Published)

getDate

public Date getDate(String key)
             throws IfsException

Gets an Date value matching the specified key.

Returns null if no value exists for the specified key, or if the value stored represents a null Date value.

Parameters:

key - the key

Returns:

the Date value

Throws:

IfsException - if the operation fails

(Published)

getDateValue

public AttributeValue getDateValue(String key)
                            throws IfsException

Gets an AttributeValue representing the Date value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is Date)

Throws:

IfsException - if the operation fails

(Published)

getStringArray

public String[] getStringArray(String key)
                        throws IfsException

Gets an String array value matching the specified key.

Returns null if no value exists for the specified key. Returns an empty array if the value stored represents a null String array value.

Parameters:

key - the key

Returns:

the String array value

Throws:

IfsException - if the operation fails

(Published)

getLongArray

public Long[] getLongArray(String key)
                    throws IfsException

Gets an Long array value matching the specified key.

Returns null if no value exists for the specified key. Returns an empty array if the value stored represents a null Long array value.

Parameters:

key - the key

Returns:

the Integer array value

Throws:

IfsException - if the operation fails

(Published)

getIntegerArray

public Integer[] getIntegerArray(String key)
                          throws IfsException

Gets an Integer array value matching the specified key.

Returns null if no value exists for the specified key. Returns an empty array if the value stored represents a null Integer array value.

Parameters:

key - the key

Returns:

the Integer array value

Throws:

IfsException - if the operation fails

(Published)

getDoubleArray

public Double[] getDoubleArray(String key)
                        throws IfsException

Gets an Double array value matching the specified key.

Returns null if no value exists for the specified key. Returns an empty array if the value stored represents a null Double array value.

Parameters:

key - the key

Returns:

the Double array value

Throws:

IfsException - if the operation fails

(Published)

getBooleanArray

public Boolean[] getBooleanArray(String key)
                          throws IfsException

Gets an Boolean array value matching the specified key.

Returns null if no value exists for the specified key. Returns an empty array if the value stored represents a null Boolean array value.

Parameters:

key - the key

Returns:

the Boolean array value

Throws:

IfsException - if the operation fails

(Published)

getDateArray

public Date[] getDateArray(String key)
                    throws IfsException

Gets a Date array value matching the specified key.

Returns null if no value exists for the specified key. Returns an empty array if the value stored represents a null Date array value.

Parameters:

key - the key

Returns:

the Date array value

Throws:

IfsException - if the operation fails

(Published)

getStringArrayValue

public AttributeValue getStringArrayValue(String key)
                                   throws IfsException

Gets an AttributeValue representing the StringArray value matching the specified key.

Returns null if no value exists for the specified key.

Parameters:

key - the key

Returns:

the value (type is StringArray)

Throws:

IfsException - if the operation fails

(Published)

getPublicObject

public PublicObject getPublicObject(String key,
                                    LibrarySession session)
                             throws IfsException

Gets a PublicObject value matching the specified key.

Returns null if no value exists for the specified key, or if the value represents a null PublicObject.

Parameters:

key - the key

session - the session context

Returns:

the PublicObject value

Throws:

IfsException - if the operation fails

(Published)

getDirectoryObject

public DirectoryObject getDirectoryObject(String key,
                                          LibrarySession session)
                                   throws IfsException

Gets a DirectoryObject value matching the specified key.

Returns null if no value exists for the specified key, or if the value represents a null DirectoryObject.

Parameters:

key - the key

session - the session context

Returns:

the DirectoryObject value

Throws:

IfsException - if the operation fails

(Published)

getSystemObject

public SystemObject getSystemObject(String key,
                                    LibrarySession session)
                             throws IfsException

Gets a SystemObject value matching the specified key.

Returns null if no value exists for the specified key, or if the value represents a null SystemObject.

Parameters:

key - the key

session - the session context

Returns:

the SystemObject value

Throws:

IfsException - if the operation fails

(Published)

getSimpleObject

public SimpleObject getSimpleObject(String key,
                                    LibrarySession session)
                             throws IfsException

Gets a SimpleObject value matching the specified key.

Returns null if no value exists for the specified key, or if the value represents a null SimpleObject.

Parameters:

key - the key

session - the session context

Returns:

the SimpleObject value

Throws:

IfsException - if the operation fails

(Published)

getSchemaObject

public SchemaObject getSchemaObject(String key,
                                    LibrarySession session)
                             throws IfsException

Gets a SchemaObject value matching the specified key.

Returns null if no value exists for the specified key, or if the value represents a null SchemaObject.

Parameters:

key - the key

session - the session context

Returns:

the SchemaObject value

Throws:

IfsException - if the operation fails

(Published)

getValues

public AttributeValue[] getValues()
                           throws IfsException

Gets all values in the table.

The returned array is sorted in the order the values were added.

Returns:

the values in the table

Throws:

IfsException - if the operation fails

(Published)

getPropertyBundleDefinition

public PropertyBundleDefinition getPropertyBundleDefinition(LibrarySession session)
                                                     throws IfsException

Gets all values in the table, represented as a PropertyBundleDefinition.

Parameters:

session - session context

Returns:

a PropertyBundleDefinition which reflects this table

Throws:

IfsException - if the operation fails

(Published)

getPropertyDefinitions

public PropertyDefinition[] getPropertyDefinitions(LibrarySession session)
                                            throws IfsException

Gets all values in the table, represented as an array of PropertyDefinitions.

Parameters:

session - session context

Returns:

a PropertyDefinition[] which reflects this table

Throws:

IfsException - if the operation fails

(Published)

getValueCount

public int getValueCount()
                  throws IfsException

Gets the number of values defined in the table.

Returns:

the count of values in the table

Throws:

IfsException - if the operation fails

(Published)

getKeys

public String[] getKeys()
                 throws IfsException

Gets all value keys in the table.

The returned array is sorted in the order the values were added.

Returns:

the value keys in the table

Throws:

IfsException - if the operation fails

(Published)

createSimpleProperties

public SimpleProperty[] createSimpleProperties(LibraryObject refObj)
                                        throws IfsException

Creates SimpleProperty objects

Parameters:

refObj - the referencing object

Returns:

the SimpleProperty objects created reflecting this table's contents

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                AttributeValue av)
         throws IfsException

Stores a new value, using an explicit key.

The AttributeValue's name may not match the key specified. The value stored in the table will override the value's name if necesary.

Parameters:

key - the key

av - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                String value)
         throws IfsException

Stores a new String value, using an explicit key.

Parameters:

key - the key

value - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                int value)
         throws IfsException

Stores a new integer value, using an explicit key.

Parameters:

key - the key

value - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                boolean value)
         throws IfsException

Stores a new boolean value, using an explicit key.

Parameters:

key - the key

value - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                long value)
         throws IfsException

Stores a new long value, using an explicit key.

Parameters:

key - the key

value - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                double value)
         throws IfsException

Stores a new double value, using an explicit key.

Parameters:

key - the key

value - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(String key,
                String[] value)
         throws IfsException

Stores a new String array value, using an explicit key.

Parameters:

key - the key

value - the value

Throws:

IfsException - if the operation fails

(Published)

put

public void put(AttributeValue av)
         throws IfsException

Stores a new value, using an implicit key of the value's name.

Parameters:

av - the value, with the key defined as the value's name

Throws:

IfsException - if the operation fails

(Published)

put

public void put(PropertyBundle pb)
         throws IfsException

Applies values from the specified PropertyBundle.

Parameters:

pb - the source PropertyBundle

Throws:

IfsException - if the operation fails

(Published)

put

public void put(Property[] props)
         throws IfsException

Applies values from the specified array of Property objects.

Parameters:

props - the source Property objects

Throws:

IfsException - if the operation fails

(Published)

put

public void put(SimpleProperty[] props)
         throws IfsException

Applies values from the specified array of SimpleProperty objects.

Parameters:

props - the source SimpleProperty objects

Throws:

IfsException - if the operation fails

(Published)

put

public void put(List list)
         throws IfsException

Applies values from the specified list of AttributeValues.

Parameters:

list - the List of AttributeValues

Throws:

IfsException - if the operation fails

(Published)

put

public void put(AttributeValue[] values)
         throws IfsException

Applies values from the specified array of AttributeValues.

Parameters:

values - the array of AttributeValues

Throws:

IfsException - if the operation fails

(Published)

put

public void put(ParameterTable pt)
         throws IfsException

Applies values from the specified ParameterTable.

Parameters:

pt - the source ParameterTable

Throws:

IfsException - if the operation fails

(Published)

put

public void put(AttributeValueTable avt)

Applies the values from the specified table to the target one, overriding values previously in the target table with ones in the specified table.

Parameters:

avt - the source table

(Published)

remove

public AttributeValue remove(String key)

Removes a value from the target table.

Parameters:

key - the value key

Returns:

the previous value, or null if it did not exist

(Published)

putTable

public void putTable(String key,
                     AttributeValueTable avt)
              throws IfsException

Stores a new table, using an explicit key.

Parameters:

key - the key

avt - the table

Throws:

IfsException - if the operation fails

(Published)

putTableList

public void putTableList(String key,
                         List<AttributeValueTable> list)
                  throws IfsException

Stores a new tablelist, using an explicit key.

Parameters:

key - the key

list - the tablelist

Throws:

IfsException - if the operation fails

(Published)

putTableList

public void putTableList(String key,
                         AttributeValueTable table)
                  throws IfsException

Stores a new tablelist from the specified table, using an explicit key.

Parameters:

key - the key

table - the table which will be the only entry in the list

Throws:

IfsException - if the operation fails

(Published)

getTable

public AttributeValueTable getTable(String key)
                             throws IfsException

Gets a table matching the specified key.

Returns null if no table exists for the specified key.

Parameters:

key - the key

Returns:

the table

Throws:

IfsException - if the operation fails

(Published)

getTableList

public List<AttributeValueTable> getTableList(String key)
                                       throws IfsException

Gets a tablelist matching the specified key.

Returns null if no tablelist exists for the specified key.

Parameters:

key - the key

Returns:

the table list

Throws:

IfsException - if the operation fails

(Published)

getTableCount

public int getTableCount()
                  throws IfsException

Gets the number of tables defined in the table.

Returns:

the count of tables in the table

Throws:

IfsException - if the operation fails

(Published)

getTableListCount

public int getTableListCount()
                      throws IfsException

Gets the number of tablelists defined in the table.

Returns:

the count of tablelists in the table

Throws:

IfsException - if the operation fails

(Published)

getTableKeys

public String[] getTableKeys()
                      throws IfsException

Gets all table keys in the table.

The returned array is sorted in the order the tables were added.

Returns:

the table keys in the table

Throws:

IfsException - if the operation fails

(Published)

getTableListKeys

public String[] getTableListKeys()
                          throws IfsException

Gets all tablelist keys in the table.

The returned array is sorted in the order the tablelists were added.

Returns:

the tablelist keys in the table

Throws:

IfsException - if the operation fails

(Published)

getTables

public AttributeValueTable[] getTables()
                                throws IfsException

Gets all tables (each represented by a AttributeValueTable) in the table map.

The returned array is sorted in the order the values were added.

Returns:

the tables in the table map

Throws:

IfsException - if the operation fails

(Published)

getTableLists

public List<AttributeValueTable>[] getTableLists()
                                          throws IfsException

Gets all tablelists (each represented by a List) in the tablelist map.

The returned array is sorted in the order the values were added.

Returns:

the tablelists in the tablelist map

Throws:

IfsException - if the operation fails

(Published)

removeTable

public AttributeValueTable removeTable(String key)

Removes a table from the target table.

Parameters:

key - the table key

Returns:

the previous table, or null if it did not exist

(Published)

removeTableList

public List<AttributeValueTable> removeTableList(String key)

Removes a tablelist from the target table.

Parameters:

key - the tablelist key

Returns:

the previous tablelist, or null if it did not exist

(Published)

toStringStringMap

public Map<String,String> toStringStringMap()
                                     throws IfsException

Generate a map, using the values as Strings.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringStringMap

public Map<String,String> toStringStringMap(LibrarySession session)
                                     throws IfsException

Generate a map, using the values as Strings.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringLongMap

public Map<String,Long> toStringLongMap()
                                 throws IfsException

Generate a map, using the values as Longs.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringLongMap

public Map<String,Long> toStringLongMap(LibrarySession session)
                                 throws IfsException

Generate a map, using the values as Longs.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringDoubleMap

public Map<String,Double> toStringDoubleMap()
                                     throws IfsException

Generate a map, using the values as Doubles.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringDoubleMap

public Map<String,Double> toStringDoubleMap(LibrarySession session)
                                     throws IfsException

Generate a map, using the values as Doubles.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringAttributeValueMap

public Map<String,AttributeValue> toStringAttributeValueMap()
                                                     throws IfsException

Generate a map, using the values as AttributeValues and Strings as keys.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toStringAttributeValueMap

public Map<String,AttributeValue> toStringAttributeValueMap(LibrarySession session)
                                                     throws IfsException

Generate a map, using the values as AttributeValues and Strings as keys.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongStringMap

public Map<Long,String> toLongStringMap()
                                 throws IfsException

Generate a map, using the keys as Longs and the values as Strings.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongStringMap

public Map<Long,String> toLongStringMap(LibrarySession session)
                                 throws IfsException

Generate a map, using the keys as Longs and the values as Strings.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongLongMap

public Map<Long,Long> toLongLongMap()
                             throws IfsException

Generate a map, using the keys as Longs and the values as Longs.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongLongMap

public Map<Long,Long> toLongLongMap(LibrarySession session)
                             throws IfsException

Generate a map, using the keys as Longs and the values as Longs.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongDoubleMap

public Map<Long,Double> toLongDoubleMap()
                                 throws IfsException

Generate a map, using the keys as Longs and the values as Doubles.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongDoubleMap

public Map<Long,Double> toLongDoubleMap(LibrarySession session)
                                 throws IfsException

Generate a map, using the keys as Longs and the values as Doubles.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongAttributeValueMap

public Map<Long,AttributeValue> toLongAttributeValueMap()
                                                 throws IfsException

Generate a map, using the values as AttributeValues and Longs as keys.

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toLongAttributeValueMap

public Map<Long,AttributeValue> toLongAttributeValueMap(LibrarySession session)
                                                 throws IfsException

Generate a map, using the values as AttributeValues and Longs as keys.

Parameters:

session - session context

Returns:

map representation of this instance

Throws:

IfsException - if the operation fails

(Published)

toString

public String toString()

Provide String representation of this object.

Overrides:

toString in class Object

Returns:

String representation of this instance

toString

public String toString(LibrarySessionInterface session,
                       String indent)

Provide String representation of this object, using session context and indentation.

Parameters:

session - session context

indent - indentation to use at the start of each line

Returns:

String representation of this instance

toDisplayString

public String toDisplayString(AttributeValue av,
                              LibrarySessionInterface session)

Provide String representation of the specified AttributeValue.

Parameters:

session - session context

Returns:

String representation of this instance