planetj.property
Class PropertyGroup

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.property.PropertyGroup

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.util.Map, java.io.Serializable

Direct Known Subclasses:

AutoRunPropertyGroup, ConnectionReportPropertyGroup, DefaultPropertyGroup, DisplayColumnsPropertyGroup, FramePropertyGroup, OptionalSignonPropertyGroup, StoredProcedurePropertyGroup

public abstract class PropertyGroup

extends java.util.HashMap

implements java.lang.Comparable, java.lang.Cloneable

Contains any number of related Property objects. Subclasses must provide a default constructor.

See Also:

Serialized Form

Field Summary

static java.lang.String	ALL Value to denote that a property exists, and has all of its possible values.
static java.lang.String	ALL_FALSE A metaproperty which allows any number of boolean properties to be set to false in the following fashion: allFalse: property1, property2, property3, ...
static java.lang.String	ALL_TRUE A metaproperty which allows any number of boolean properties to be set to true in the following fashion: allTrue: property1, property2, property3, ...
static short	BOOLEAN_PROPERTY
static short	DATE_PROPERTY
static short	DOUBLE_PROPERTY
static short	FLOAT_PROPERTY
static short	INTEGER_PROPERTY
static short	JAVA_CLASS_PROPERTY
static short	LIST_PROPERTY
static short	MAP_PROPERTY
static java.lang.String	NONE Value to denote that a property exists, but it doesn't have a value.
static java.lang.String	ROW_COLLECTION_KEY
static short	STRING_PROPERTY

Constructor Summary

PropertyGroup()
PropertyGroup constructor comment.

PropertyGroup(int initialCapacity)
PropertyGroup constructor comment.

PropertyGroup(java.lang.String pName)
PropertyGroup constructor comment.

Method Summary

Property	add(Property pProperty) Adds a new Property to this PropertyGroup, replacing any previous Property with the same name
Property	addProperty(Property pProperty) Adds a new Property to this PropertyGroup, replacing any previous Property with the same name
Property	addProperty(java.lang.String pName, java.lang.Object pValue) Creates a new Property object based on a name and value.
java.lang.StringBuffer	append(java.lang.StringBuffer sb)
java.lang.Object	clone()
int	compareTo(java.lang.Object o) Compares this PropertyGroup with another by examining their names, or compares this PropertyGroup to a String (in this case this PropertyGroup's name is compared with the String)
int	compareTo(PropertyGroup pPG) Comapres this PropertyGroup with another by examining their names
int	compareTo(java.lang.String pName) Comapres the name of this PropertyGroup with a String.
boolean	containsProperty(java.lang.String propertyName)
void	copyUndefinedPropertiesFrom(PropertyGroup pg) Any properties defined in the other property group which are not defined in this property group are copied into this property group.
Property	createProperty(java.lang.String pName, java.lang.Object pValue) Creates a new Property object based on a name and value (the Property is not added to this PropertyGroup).
java.util.List	getAllMetapropertyNames() Gets a List containing the names of all the supported metaproperties.
abstract java.util.List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
java.util.List	getAllSetBooleanPropertyNames() Gets a List containing the names of all the boolean properties that have been set on this PropertyGroup.
java.util.List	getAllSetIntPropertyNames() Gets a List containing the names of all the int properties that have been set on this PropertyGroup.
java.util.List	getAllSetListPropertyNames() Gets a List containing the names of all the List properties that have been set on this PropertyGroup.
java.util.List	getAllSetPropertyNames() Gets a List containing the names of all the properties that have been set on this PropertyGroup.
java.util.List	getAllSetStringPropertyNames() Gets a List containing the names of all the String properties that have been set on this PropertyGroup.
boolean	getBooleanValue(java.lang.String pName) Gets the value of the Property with the specified name as a boolean.
java.util.Date	getDateValue(java.lang.String pName) Gets the value of the Property with the specified name as a Date.
double	getDoubleValue(java.lang.String pName) Gets the value of the Property with the specified name as a double.
float	getFloatValue(java.lang.String pName) Gets the value of the Property with the specified name as a float Float.NaN is returned if there is no property with the specified name.
int	getIntValue(java.lang.String pName) Gets the value of the Property with the specified name as an int.
java.lang.Class	getJavaClassValue(java.lang.String pName) Gets the value of the Property with the specified name as a Java class.
java.util.List	getListValue(java.lang.String pName) Gets the value of the Property with the specified name as a List
java.util.Map	getMapValue(java.lang.String name) Gets the value of the Property with the specified name as a Map
java.lang.String	getName() Gets the name of this PropertyGroup
Property	getProperty(java.lang.String pName) Gets the Property with the specified name
short	getPropertyType(java.lang.String pPropertyName) Gets the type of property for a specified property name.
abstract java.util.List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
java.lang.String	getStringValue(java.lang.String pName) Gets the value of the Property with the specified name as a String
java.lang.Object	getValue(java.lang.String pName) Gets the value of the Property with the specified name
boolean	isMergeableOnList(PropertyGroup pGroup, java.lang.String pMergeProperty) Tests if this PropertyGroup can be merged with another PropertyGroup on a property.
boolean	isMetaproperty(java.lang.String pPropertyName) Tests if a property is a metaproperty.
java.util.Iterator	iterator() Gets an Iterator for this PropertyGroup
PropertyGroup	mergeOnList(PropertyGroup pGroup, java.lang.String pMergeProperty) Merges this PropertyGroup into another PropertyGroup.
Property	put(Property p) Adds a Property object to this PropertyGroup
java.lang.Object	put(java.lang.String pName, java.lang.Object pValue) Sets the *VALUE* of a property in this PropertyGroup.
Property	put(java.lang.String pName, Property p) Adds a Property object to this PropertyGroup
void	setName(java.lang.String newName) Sets the name of this PropertyGroup
java.lang.String	toString()
java.lang.Object	updateProperty(java.lang.String pName, java.lang.Object pValue) Updates a Property's value.

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

NONE

public static final java.lang.String NONE

Value to denote that a property exists, but it doesn't have a value.

See Also:

Constant Field Values

ALL

public static final java.lang.String ALL

Value to denote that a property exists, and has all of its possible values.

See Also:

Constant Field Values

ALL_TRUE

public static final java.lang.String ALL_TRUE

A metaproperty which allows any number of boolean properties to be set to true in the following fashion:

allTrue: property1, property2, property3, ... propertyN-1, propertyN;

See Also:

Constant Field Values

ALL_FALSE

public static final java.lang.String ALL_FALSE

A metaproperty which allows any number of boolean properties to be set to false in the following fashion:

allFalse: property1, property2, property3, ... propertyN-1, propertyN;

See Also:

Constant Field Values

ROW_COLLECTION_KEY

public static final java.lang.String ROW_COLLECTION_KEY

See Also:

Constant Field Values

STRING_PROPERTY

public static final short STRING_PROPERTY

See Also:

Constant Field Values

LIST_PROPERTY

public static final short LIST_PROPERTY

See Also:

Constant Field Values

BOOLEAN_PROPERTY

public static final short BOOLEAN_PROPERTY

See Also:

Constant Field Values

INTEGER_PROPERTY

public static final short INTEGER_PROPERTY

See Also:

Constant Field Values

DOUBLE_PROPERTY

public static final short DOUBLE_PROPERTY

See Also:

Constant Field Values

DATE_PROPERTY

public static final short DATE_PROPERTY

See Also:

Constant Field Values

JAVA_CLASS_PROPERTY

public static final short JAVA_CLASS_PROPERTY

See Also:

Constant Field Values

MAP_PROPERTY

public static final short MAP_PROPERTY

See Also:

Constant Field Values

FLOAT_PROPERTY

public static final short FLOAT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

PropertyGroup

public PropertyGroup()

PropertyGroup constructor comment.

PropertyGroup

public PropertyGroup(int initialCapacity)

PropertyGroup constructor comment.

Parameters:

initialCapacity - int

PropertyGroup

public PropertyGroup(java.lang.String pName)

PropertyGroup constructor comment.

Method Detail

add

public Property add(Property pProperty)

Adds a new Property to this PropertyGroup, replacing any previous Property with the same name

Returns:

The Property that was replaced, or null if there was no such Property

addProperty

public Property addProperty(java.lang.String pName,
                            java.lang.Object pValue)

Creates a new Property object based on a name and value. The Property is then added to this PropertyGroup). Override this method if you want a subclass of Property returned.

addProperty

public Property addProperty(Property pProperty)

Adds a new Property to this PropertyGroup, replacing any previous Property with the same name

Returns:

The Property that was replaced, or null if there was no such Property

append

public java.lang.StringBuffer append(java.lang.StringBuffer sb)

clone

public java.lang.Object clone()

compareTo

public int compareTo(java.lang.Object o)

Compares this PropertyGroup with another by examining their names, or compares this PropertyGroup to a String (in this case this PropertyGroup's name is compared with the String)

Specified by:

compareTo in interface java.lang.Comparable

compareTo

public int compareTo(java.lang.String pName)

Comapres the name of this PropertyGroup with a String. Do not delete this method.

compareTo

public int compareTo(PropertyGroup pPG)

Comapres this PropertyGroup with another by examining their names

containsProperty

public boolean containsProperty(java.lang.String propertyName)

copyUndefinedPropertiesFrom

public void copyUndefinedPropertiesFrom(PropertyGroup pg)

Any properties defined in the other property group which are not defined in this property group are copied into this property group. If a property is present in both property groups then it is ignored.

createProperty

public Property createProperty(java.lang.String pName,
                               java.lang.Object pValue)

Creates a new Property object based on a name and value (the Property is not added to this PropertyGroup). Override this method if you want a subclass of Property returned.

getAllMetapropertyNames

public java.util.List getAllMetapropertyNames()

Gets a List containing the names of all the supported metaproperties. If subclasses override this method, they should include the metaproperties from the superclass in the returned List.

getAllPropertyNames

public abstract java.util.List getAllPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

getAllSetBooleanPropertyNames

public java.util.List getAllSetBooleanPropertyNames()

Gets a List containing the names of all the boolean properties that have been set on this PropertyGroup.

getAllSetIntPropertyNames

public java.util.List getAllSetIntPropertyNames()

Gets a List containing the names of all the int properties that have been set on this PropertyGroup.

getAllSetListPropertyNames

public java.util.List getAllSetListPropertyNames()

Gets a List containing the names of all the List properties that have been set on this PropertyGroup.

getAllSetPropertyNames

public java.util.List getAllSetPropertyNames()

Gets a List containing the names of all the properties that have been set on this PropertyGroup.

getAllSetStringPropertyNames

public java.util.List getAllSetStringPropertyNames()

Gets a List containing the names of all the String properties that have been set on this PropertyGroup.

getBooleanValue

public boolean getBooleanValue(java.lang.String pName)

Gets the value of the Property with the specified name as a boolean. If the property has not been explicitly set, the metaproperties are checked. If the property has not been set and is not in the metaproperties, false is returned.

getDateValue

public java.util.Date getDateValue(java.lang.String pName)

Gets the value of the Property with the specified name as a Date. Integer.MIN_VALUE is returned if there is no property with the specified name.

getDoubleValue

public double getDoubleValue(java.lang.String pName)

Gets the value of the Property with the specified name as a double. Double.NaN is returned if there is no property with the specified name.

getFloatValue

public float getFloatValue(java.lang.String pName)

Gets the value of the Property with the specified name as a float Float.NaN is returned if there is no property with the specified name.

getIntValue

public int getIntValue(java.lang.String pName)

Gets the value of the Property with the specified name as an int. Integer.MIN_VALUE is returned if there is no property with the specified name.

getJavaClassValue

public java.lang.Class getJavaClassValue(java.lang.String pName)

Gets the value of the Property with the specified name as a Java class. null is returned if there is no property with the specified name.

getListValue

public java.util.List getListValue(java.lang.String pName)

Gets the value of the Property with the specified name as a List

getMapValue

public java.util.Map getMapValue(java.lang.String name)

Gets the value of the Property with the specified name as a Map

getName

public java.lang.String getName()

Gets the name of this PropertyGroup

getProperty

public Property getProperty(java.lang.String pName)

Gets the Property with the specified name

Returns:

The Property with the specified name, or null if there was no such Property

getPropertyType

public final short getPropertyType(java.lang.String pPropertyName)

Gets the type of property for a specified property name.

getRequiredPropertyNames

public abstract java.util.List getRequiredPropertyNames()

Gets a List containing the names of all the required properties.

getStringValue

public java.lang.String getStringValue(java.lang.String pName)

Gets the value of the Property with the specified name as a String

getValue

public java.lang.Object getValue(java.lang.String pName)

Gets the value of the Property with the specified name

isMergeableOnList

public boolean isMergeableOnList(PropertyGroup pGroup,
                                 java.lang.String pMergeProperty)

Tests if this PropertyGroup can be merged with another PropertyGroup on a property. This is true if all the Properties in both groups have the same values, with the exception of the Property on which the merge is taking place, which must be a List Property. Merging two PropertyGroups creates a single PropertyGroup which is equivalent to the two merged PropertyGroups.

isMetaproperty

public boolean isMetaproperty(java.lang.String pPropertyName)

Tests if a property is a metaproperty. A metaproperty is a property which operates on other properties. If subclasses override this method, they should invoke it on the superclass if the property is not a recognized property of the subclass

iterator

public java.util.Iterator iterator()

Gets an Iterator for this PropertyGroup

mergeOnList

public PropertyGroup mergeOnList(PropertyGroup pGroup,
                                 java.lang.String pMergeProperty)

Merges this PropertyGroup into another PropertyGroup. This method merges two PropertyGroup objects by combining the values that each PropertyGroup has for a List Property into a single ListProperty; all other properties in the two PropertyGroups must have the same values. This method should only be invoked if the isMergeableOnList() method returns true for the two PropertyGroups. This object is not altered by this method.

Merging these two PropertyGroups:
GroupA {
prop1: value1;
prop2: value2A, value2B;
prop3: value3;
prop4: value4A, value4B, value4C;
}

GroupA {
prop1: value1;
prop2: value2C;
prop3: value3;
prop4: value4A, value4B, value4C;
}

on the prop2 property (this is the only property that can be merged on) would result in the following PropertyGroup:
GroupA {
prop1: value1;
prop2: value2A, value2B, value2C;
prop3: value3;
prop4: value4A, value4B, value4C;
}



Returns:

The PropertyGroup that was passed in as an argument. All of its properties, with the expection of the merge property, will not have been altered.

put

public java.lang.Object put(java.lang.String pName,
                            java.lang.Object pValue)

Sets the *VALUE* of a property in this PropertyGroup. The old *VALUE* is returned.

put

public Property put(java.lang.String pName,
                    Property p)

Adds a Property object to this PropertyGroup

put

public Property put(Property p)

Adds a Property object to this PropertyGroup

setName

public void setName(java.lang.String newName)

Sets the name of this PropertyGroup

toString

public java.lang.String toString()

updateProperty

public java.lang.Object updateProperty(java.lang.String pName,
                                       java.lang.Object pValue)

Updates a Property's value. If the property does not exist in this PropertyGroup, a new Property object is created.

Returns:

The old value of the property before it was updated