|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyGroup
An interface that represents a group of properties. Properties may be logically grouped together for usability reasons. For example, when specifying connection properties to an EIS it is logical to group the user name and password properties together.
Property groups may also contain nested property groups.
Method Summary | |
---|---|
String |
convertToString()
Returns a String representation of this PropertyGroup instance that must be treated without processing similar to XML CDATA. |
PropertyDescriptor[] |
getProperties()
Returns the contents of the group. |
PropertyDescriptor |
getProperty(String propertyName)
Returns the property or property group with the given name. |
void |
populateFromString(String value)
Populates the PropertyGroup instance with the String argument. |
Methods inherited from interface commonj.connector.metadata.discovery.properties.PropertyDescriptor |
---|
addPropertyChangeListener, clone, getDescription, getDisplayName, getID, getName, isEnabled, removePropertyChangeListener |
Method Detail |
---|
PropertyDescriptor[] getProperties()
PropertyDescriptor
s. The caller should check the
runtime type of the array elements to determine if they are Property or
PropertyGroup instances.
null
array of properties. A property group
should typically never be empty. However in cases where one
becomes empty due to property removal, this method should return
an empty array instead of null
.PropertyDescriptor getProperty(String propertyName)
null
if the property is not part of the group. This method
only returns the direct contents of this property group. In other words,
if this property group contains nested property groups and one desires to
retrieve a property within a nested group, then this method can only be
called to get the nested group. Additional calls are then made on the
nested group instance to get its properties.
propertyName
- -
the non null
name of the property to retrieve.
null
if the requested property is not part of the property group.String convertToString()
void populateFromString(String value) throws MetadataException
convertToString()
.
The provider must be able to support older versions of its String representation that were returned from convertToString.
value
- - a String value representing the serialized form of the PropertyGroup
MetadataException
- -
thrown if any error occurs in the population - the property group
instance is in an unusable state
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |