com.metamatrix.common.object
Class PropertiedObjectEditorImpl

java.lang.Object
  com.metamatrix.common.object.PropertiedObjectEditorImpl

All Implemented Interfaces:

PropertiedObjectEditor, PropertyAccessPolicy

Direct Known Subclasses:

PropertiedObjectsEditorImpl

public class PropertiedObjectEditorImpl
extends java.lang.Object
implements PropertiedObjectEditor

Field Summary

Fields inherited from interface com.metamatrix.common.object.PropertiedObjectEditor

NO_VALUE

Fields inherited from interface com.metamatrix.common.object.PropertyAccessPolicy

DEFAULT_READ_ONLY_PRIVILEGE

Constructor Summary

PropertiedObjectEditorImpl()
Create an empty property definition object with all defaults.

PropertiedObjectEditorImpl(PropertyAccessPolicy policy)

Method Summary

protected PropertiedObjectImpl	assertPropertiedObject(PropertiedObject obj)
java.util.List	getAllowedValues(PropertiedObject obj, PropertyDefinition def) Get the allowed values for the property on the specified object.
PropertyAccessPolicy	getPolicy()
java.util.List	getPropertyDefinitions(PropertiedObject obj) Obtain the list of PropertyDefinitions that apply to the specified object's type.
java.lang.Object	getValue(PropertiedObject obj, PropertyDefinition def) Obtain from the specified PropertiedObject the property value that corresponds to the specified PropertyDefinition.
boolean	isReadOnly(PropertiedObject obj) Return whether this editor may be used to set property values on the specified PropertiedObject.
boolean	isReadOnly(PropertiedObject obj, PropertyDefinition def)
boolean	isValidValue(PropertiedObject obj, PropertyDefinition def, java.lang.Object value) Return whether the specified value is considered valid.
void	reset(PropertiedObject obj)
void	setPolicy(PropertyAccessPolicy policy)
void	setReadOnly(PropertiedObject obj, boolean readOnly)
void	setReadOnly(PropertiedObject obj, PropertyDefinition def, boolean readOnly)
void	setValue(PropertiedObject obj, PropertyDefinition def, java.lang.Object value) Set on the specified PropertiedObject the value defined by the specified PropertyDefinition.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiedObjectEditorImpl

public PropertiedObjectEditorImpl(PropertyAccessPolicy policy)

PropertiedObjectEditorImpl

public PropertiedObjectEditorImpl()

Create an empty property definition object with all defaults.

Method Detail

assertPropertiedObject

protected PropertiedObjectImpl assertPropertiedObject(PropertiedObject obj)

getPropertyDefinitions

public java.util.List getPropertyDefinitions(PropertiedObject obj)

Obtain the list of PropertyDefinitions that apply to the specified object's type.

Specified by:

getPropertyDefinitions in interface PropertiedObjectEditor

Parameters:

obj - the propertied object for which the PropertyDefinitions are to be obtained; may not be null

Returns:

an unmodifiable list of the PropertyDefinition objects that define the properties for the object; never null but possibly empty

Throws:

java.lang.AssertionError - if obj is null

getAllowedValues

public java.util.List getAllowedValues(PropertiedObject obj,
                                       PropertyDefinition def)

Get the allowed values for the property on the specified object. By default, this implementation simply returns the allowed values in the supplied PropertyDefinition instance.

Specified by:

getAllowedValues in interface PropertiedObjectEditor

Parameters:

obj - the propertied object whose property value is to be obtained; may not be null

def - the reference to the PropertyDefinition describing the property whose value is to be returned; may not be null

Returns:

the unmodifiable list of allowed values for this property, or an empty set if the values do not have to conform to a fixed set.

See Also:

#hasAllowedValues

getValue

public java.lang.Object getValue(PropertiedObject obj,
                                 PropertyDefinition def)

Obtain from the specified PropertiedObject the property value that corresponds to the specified PropertyDefinition. The return type and cardinality (including whether the value may be null) depend upon the PropertyDefinition. If the property definition allows multiple values (i.e., its maximum multiplicity is greater than 1), the returned Object will be an Object[] containing Objects of the type prescribed by the PropertyDefinition.

Specified by:

getValue in interface PropertiedObjectEditor

Parameters:

obj - the propertied object whose property value is to be obtained; may not be null

def - the reference to the PropertyDefinition describing the property whose value is to be returned; may not be null

Returns:

the value for the property, which will be an object array if the property is multi-valued; the result may be null if the multiplicity includes "0", or the result may be the NO_VALUE reference if the specified object does not contain the specified PropertyDefinition

Throws:

java.lang.AssertionError - if either of obj or def is null

isValidValue

public boolean isValidValue(PropertiedObject obj,
                            PropertyDefinition def,
                            java.lang.Object value)

Return whether the specified value is considered valid. The value is not valid if the propertied object does not have the specified property definition, or if it does but the value is inconsistent with the requirements of the property definition. If the property is multi-valued, the value is expected to be an instance of Object[].

Specified by:

isValidValue in interface PropertiedObjectEditor

Parameters:

obj - the propertied object whose property value is to be validated; may not be null

def - the reference to the PropertyDefinition describing the property whose value is to be validated; may not be null

value - the proposed value for the property, which must be an object array if the property is multi-valued, and which may be null if the multiplicity includes "0"

Returns:

true if the value is considered valid, or false otherwise.

Throws:

java.lang.AssertionError - if either of obj or def is null, or if the property is multi-valued and the value is not an instance of Object[].

setValue

public void setValue(PropertiedObject obj,
                     PropertyDefinition def,
                     java.lang.Object value)

Set on the specified PropertiedObject the value defined by the specified PropertyDefinition.

Specified by:

setValue in interface PropertiedObjectEditor

Parameters:

obj - the propertied object whose property value is to be set; may not be null

def - the reference to the PropertyDefinition describing the property whose value is to be changed; may not be null

value - the proposed value for the property, which must be an object array if the property is multi-valued, and which may be null if the multiplicity includes "0"

Throws:

java.lang.IllegalArgumentException - if the value does not correspond to the PropertyDefinition requirements.

java.lang.AssertionError - if either of obj or def is null, or if the property is multi-valued and the value is not an instance of Object[].

getPolicy

public PropertyAccessPolicy getPolicy()

Specified by:

getPolicy in interface PropertiedObjectEditor

setPolicy

public void setPolicy(PropertyAccessPolicy policy)

Specified by:

setPolicy in interface PropertiedObjectEditor

isReadOnly

public boolean isReadOnly(PropertiedObject obj)

Description copied from interface: PropertiedObjectEditor

Return whether this editor may be used to set property values on the specified PropertiedObject.

Specified by:

isReadOnly in interface PropertiedObjectEditor

Specified by:

isReadOnly in interface PropertyAccessPolicy

Parameters:

obj - the propertied object; may not be null

Returns:

true if the object may not be modified, or false otherwise.

isReadOnly

public boolean isReadOnly(PropertiedObject obj,
                          PropertyDefinition def)

Specified by:

isReadOnly in interface PropertyAccessPolicy

setReadOnly

public void setReadOnly(PropertiedObject obj,
                        PropertyDefinition def,
                        boolean readOnly)

Specified by:

setReadOnly in interface PropertyAccessPolicy

setReadOnly

public void setReadOnly(PropertiedObject obj,
                        boolean readOnly)

Specified by:

setReadOnly in interface PropertyAccessPolicy

reset

public void reset(PropertiedObject obj)

Specified by:

reset in interface PropertyAccessPolicy