oracle.dss.metadataUtil
Class PropertyBag

java.lang.Object
  |
  +--oracle.dss.metadataUtil.PropertyBag

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MDObject

public class PropertyBag

extends java.lang.Object

implements java.io.Serializable

An object that can have variable properties. A PropertyBag contains a hashtable of properties. Methods in this class provide access to these properties.

See Also:

Serialized Form

Constructor Summary

PropertyBag()
Constructor.

Method Summary

int	getIntPropertyValue(java.lang.String name) Retrieves the value of an int property.
long	getLongPropertyValue(java.lang.String name) Retrieves the value of a long property.
java.lang.Object	getObjPropertyValue(java.lang.String name) Retrieves the value of an Object property.
int	getPropertyDataType(java.lang.String name) Retrieves the data type of a property in this PropertyBag.
java.util.Vector	getStringVectorPropertyValue(java.lang.String name) Retrieves the vector of values of a String vector property.
java.lang.String	getStrPropertyValue(java.lang.String name) Retrieves the value of a String property.
static PropertyBag	mergePropertyBags(PropertyBag firstBag, PropertyBag secondBag) Merges two PropertyBag objects.
void	removeProperty(java.lang.String name) Removes a property from this PropertyBag.
void	setIntPropertyValue(java.lang.String name, int value) Specifies the value of an int property.
void	setIntPropertyValue(java.lang.String name, int value, int flags) Specifies the value of an int property and the user-interface flags.
void	setLongPropertyValue(java.lang.String name, long value) Specifies the value of a long property.
void	setLongPropertyValue(java.lang.String name, long value, int flags) Specifies the value of a long property and the user-interface flags.
void	setObjPropertyValue(java.lang.String name, java.lang.Object value) Specifies the value of an Object property.
void	setObjPropertyValue(java.lang.String name, java.lang.Object value, int flags) Specifies the value of an Object property and the user-interface flags.
void	setProperty(java.lang.String name, java.lang.Object object, int dataType, int flags) Adds a property to this PropertyBag.
int	setPropertyBag(PropertyBag propertyBag, int keepRemoveFlag) Set properties in specified propertyBag to this propertyBag.
void	setStringVectorPropertyValue(java.lang.String name, java.util.Vector value) Specifies the values of a String vector property.
void	setStringVectorPropertyValue(java.lang.String name, java.util.Vector value, int flags) Specifies the values of a String vector property and the user-interface flags.
void	setStrPropertyValue(java.lang.String name, java.lang.String value) Specifies the value of a String property.
void	setStrPropertyValue(java.lang.String name, java.lang.String value, int flags) Specifies the value of a String property and the user-interface flags.
int	size() Retrieves size of this PropertyBag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyBag

public PropertyBag()

Constructor.

Method Detail

size

public int size()

Retrieves size of this PropertyBag. The size is the size of the internal vector of properties.

Returns:

The size of the vector of properties.

removeProperty

public void removeProperty(java.lang.String name)

Removes a property from this PropertyBag.

Parameters:

name - Name of the property to remove.

getPropertyDataType

public int getPropertyDataType(java.lang.String name)

Retrieves the data type of a property in this PropertyBag.

Parameters:

name - The name of the property whose data type you want.

Returns:

A constant that represents the data type of the name property. Possible values are listed in the See Also section.

See Also:

MDU.STRING, MDU.LONG, MDU.INTEGER, MDU.OBJ, MDU.STRING_VECTOR, MDU.ALL_DATATYPES

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object object,
                        int dataType,
                        int flags)

Adds a property to this PropertyBag. If a property already exists, then this method replaces the property value.

Parameters:

name - The name of the property to add.

object - The value of the property.

dataType - A constant that represents the data type of the property. Valid constants are:

• STRING
• LONG
• INTEGER
• OBJ
• STRING_VECTOR
• ALL_DATATYPES

flags - A constant that indicates how the property appears in the user interface. Valid constants are:

• UI_VISIBLE
• UI_WRITE
• UI_DELETE
• UI_ENCRYPT
• UI_ALL
• UI_NONE

See Also:

MDU.UI_VISIBLE, MDU.UI_WRITE, MDU.UI_DELETE, MDU.UI_ENCRYPT, MDU.UI_ALL, MDU.UI_NONE, MDU.STRING, MDU.LONG, MDU.INTEGER, MDU.OBJ, MDU.STRING_VECTOR, MDU.ALL_DATATYPES

getStrPropertyValue

public java.lang.String getStrPropertyValue(java.lang.String name)

Retrieves the value of a String property.

Parameters:

name - The name of the property whose value you want.

Returns:

The property value, or null if the property has no value.

setStrPropertyValue

public void setStrPropertyValue(java.lang.String name,
                                java.lang.String value)

Specifies the value of a String property. This method sets the user-interface flag to UI_NONE.

Parameters:

name - The name of the property to set.

value - The value to set for name.

setStrPropertyValue

public void setStrPropertyValue(java.lang.String name,
                                java.lang.String value,
                                int flags)

Specifies the value of a String property and the user-interface flags.

Parameters:

name - The name of the property to set.

value - The value to set for name.

flags - User-interface flags. Valid values are listed in the See Also section.

See Also:

MDU.UI_VISIBLE, MDU.UI_WRITE, MDU.UI_DELETE, MDU.UI_ENCRYPT, MDU.UI_ALL, MDU.UI_NONE

getLongPropertyValue

public long getLongPropertyValue(java.lang.String name)

Retrieves the value of a long property.

Parameters:

name - The name of the property whose value you want.

Returns:

The property value, or MDU.ILLEGAL_LONG_VALUE if the property is null.

See Also:

MDU.ILLEGAL_LONG_VALUE

setLongPropertyValue

public void setLongPropertyValue(java.lang.String name,
                                 long value)

Specifies the value of a long property. This method sets the user-interface flag to UI_NONE.

Parameters:

name - The name of the property to set.

value - The value to set for name.

setLongPropertyValue

public void setLongPropertyValue(java.lang.String name,
                                 long value,
                                 int flags)

Specifies the value of a long property and the user-interface flags.

Parameters:

name - The name of the property to set.

value - The value to set for name.

flags - User-interface flags. Valid values are listed in the See Also section.

See Also:

MDU.UI_VISIBLE, MDU.UI_WRITE, MDU.UI_DELETE, MDU.UI_ENCRYPT, MDU.UI_ALL, MDU.UI_NONE

getIntPropertyValue

public int getIntPropertyValue(java.lang.String name)

Retrieves the value of an int property.

Parameters:

name - The name of the property whose value you want.

Returns:

The property value, or MDU.ILLEGAL_INT_VALUE if the property value is null.

See Also:

MDU.ILLEGAL_INT_VALUE

setIntPropertyValue

public void setIntPropertyValue(java.lang.String name,
                                int value)

Specifies the value of an int property. This method sets the user-interface flag to UI_NONE.

Parameters:

name - The name of the property to set.

value - The value to set for name.

setIntPropertyValue

public void setIntPropertyValue(java.lang.String name,
                                int value,
                                int flags)

Specifies the value of an int property and the user-interface flags.

Parameters:

name - The name of the property to set.

value - The value to set for name.

flags - User-interface flags. Valid values are listed in the See Also section.

See Also:

MDU.UI_VISIBLE, MDU.UI_WRITE, MDU.UI_DELETE, MDU.UI_ENCRYPT, MDU.UI_ALL, MDU.UI_NONE

getObjPropertyValue

public java.lang.Object getObjPropertyValue(java.lang.String name)

Retrieves the value of an Object property.

Parameters:

name - The name of the property whose value you want.

Returns:

The property value, or null if the property has no value.

setObjPropertyValue

public void setObjPropertyValue(java.lang.String name,
                                java.lang.Object value)

Specifies the value of an Object property. This method sets the user-interface flag to UI_NONE.

Parameters:

name - The name of the property to set.

value - The value to set for name.

setObjPropertyValue

public void setObjPropertyValue(java.lang.String name,
                                java.lang.Object value,
                                int flags)

Specifies the value of an Object property and the user-interface flags.

Parameters:

name - The name of the property to set.

value - The value to set for name.

flags - User-interface flags. Valid values are listed in the See Also section.

See Also:

MDU.UI_VISIBLE, MDU.UI_WRITE, MDU.UI_DELETE, MDU.UI_ENCRYPT, MDU.UI_ALL, MDU.UI_NONE

getStringVectorPropertyValue

public java.util.Vector getStringVectorPropertyValue(java.lang.String name)

Retrieves the vector of values of a String vector property.

Parameters:

name - The name of the property whose values you want.

Returns:

The vector of property values, or null if no values have been set.

setStringVectorPropertyValue

public void setStringVectorPropertyValue(java.lang.String name,
                                         java.util.Vector value)

Specifies the values of a String vector property. This method sets the user-interface flag to UI_NONE.

Parameters:

name - The name of the property to set.

value - The values to set for name.

setStringVectorPropertyValue

public void setStringVectorPropertyValue(java.lang.String name,
                                         java.util.Vector value,
                                         int flags)

Specifies the values of a String vector property and the user-interface flags.

Parameters:

name - The name of the property to set.

value - The vector of values to set for name.

flags - User-interface flags. Valid values are listed in the See Also section.

See Also:

MDU.UI_VISIBLE, MDU.UI_WRITE, MDU.UI_DELETE, MDU.UI_ENCRYPT, MDU.UI_ALL, MDU.UI_NONE

setPropertyBag

public int setPropertyBag(PropertyBag propertyBag,
                          int keepRemoveFlag)

Set properties in specified propertyBag to this propertyBag.

Parameters:

propertyBag - propertyBag that needs to be set to this.

keepRemoveFlag - KEEP keep the existing properties REMOVE remove all existing properties and add new ones.

Returns:

SUCCESS FAILURE

See Also:

MDU.KEEP, MDU.REMOVE, MDU.SUCCESS, MDU.FAILURE

mergePropertyBags

public static PropertyBag mergePropertyBags(PropertyBag firstBag,
PropertyBag secondBag)

Merges two PropertyBag objects. If the two property bags contain the same property, then the value that is specified in the first property bag is used. The value in the second property bag is discarded.

Parameters:

firstBag - First property bag to merge.

secondbag - Second property bag to merge.

Returns:

A property bag that contains the properties in firstBag and the properties in secondBag.