org.norther.tammi.core.rt
Interface Variable

All Superinterfaces:

Cloneable, DynamicMBean, ReferableMBean

All Known Implementing Classes:

Account, MultiSelectionList, MultiSelectionTree, SearchBox, SingleSelectionList, SingleSelectionTree, VariableX, VariableY, VariableZ

public interface Variable
extends ReferableMBean, DynamicMBean, Cloneable

An interface to variables supporting dynamic attributes, operations and notifications exposed through the DynamicMBean interface.

Note that internal attributes of implemented interfaces have higher precedence than dynamic attributes in operations of the DynamicMBean interface, but typically they are not available in operations of the Variable interface.

Author:

Ilkka Priha

Field Summary

static String	ADD_VALIDATED_ELEMENT Add validated element method.
static String	ADD_VALIDATED_ELEMENT_DESCRIPTION Add validated element description.
static String	APPLY_ATTRIBUTE_EXPORTER Apply attribute exporter method.
static String	APPLY_ATTRIBUTE_EXPORTER_DESCRIPTION Apply attribute exporter description.
static String	APPLY_ATTRIBUTE_IMPORTER Apply attribute importer method.
static String	APPLY_ATTRIBUTE_IMPORTER_DESCRIPTION Apply attribute importer description.
static String	APPLY_ATTRIBUTE_VALIDATOR Apply attribute validator method.
static String	APPLY_ATTRIBUTE_VALIDATOR_DESCRIPTION Apply attribute validator description.
static String	ATTRIBUTE_INFO Attribute info method.
static String	ATTRIBUTE_INFO_DESCRIPTION Attribute info description.
static String	ATTRIBUTE_LENGTH Attribute length method.
static String	ATTRIBUTE_LENGTH_DESCRIPTION Attribute length description.
static String	ATTRIBUTE_LIST Attribute list method.
static String	ATTRIBUTE_LIST_DESCRIPTION Attribute list description.
static String	CLEAR_ATTRIBUTE_VALUES Clear attribute values method.
static String	CLEAR_ATTRIBUTE_VALUES_DESCRIPTION Clear attribute values description.
static String	CONTAINS_ATTRIBUTE Contains attribute method.
static String	CONTAINS_ATTRIBUTE_DESCRIPTION Contains attribute description.
static String	EXPORT_ATTRIBUTES Export attributes method.
static String	EXPORT_ATTRIBUTES_DESCRIPTION Export attributes description.
static String	GET_ATTRIBUTE_VALUE Get attribute value method.
static String	GET_ATTRIBUTE_VALUE_DESCRIPTION Get attribute value description.
static String	GET_VALIDATED_ELEMENT Get validated element method.
static String	GET_VALIDATED_ELEMENT_DESCRIPTION Get validated element description.
static String	GET_VALIDATED_VALUE Get validated value method.
static String	GET_VALIDATED_VALUE_DESCRIPTION Get validated value description.
static String	IMPORT_ATTRIBUTES Import attributes method.
static String	IMPORT_ATTRIBUTES_DESCRIPTION Import attributes description.
static String	REMOVE_VALIDATED_ELEMENT Remove valiadted element method.
static String	REMOVE_VALIDATED_ELEMENT_DESCRIPTION Remove validated element description.
static String	RESET_VALIDATED_VALUES Reset validated values method.
static String	RESET_VALIDATED_VALUES_DESCRIPTION Reset validated values description.
static String	SET_ATTRIBUTE_VALUE Set attribute value method.
static String	SET_ATTRIBUTE_VALUE_DESCRIPTION Set attribute value description.
static String	SET_VALIDATED_ELEMENT Set validated element method.
static String	SET_VALIDATED_ELEMENT_DESCRIPTION Set validated element description.
static String	SET_VALIDATED_VALUE Set validated value method.
static String	SET_VALIDATED_VALUE_DESCRIPTION Set validated value description.
static String	VALIDATE_ATTRIBUTE_VALUES Validate attribute values method.
static String	VALIDATE_ATTRIBUTE_VALUES_DESCRIPTION Validate attribute values description.
static String	VALIDATED_VALUES Validated values attribute.
static String	VALIDATED_VALUES_DESCRIPTION Validated values description.
static String	VARIABLE_ID Variable id attribute.
static String	VARIABLE_ID_DESCRIPTION Variable id description.
static String	VARIABLE_TYPE Variable type attribute.
static String	VARIABLE_TYPE_DESCRIPTION Variable type description.

Fields inherited from interface org.norther.tammi.core.base.ReferableMBean

DEFAULT_ID, ID, MBEAN, MBEAN_DESCRIPTION, TYPE

Method Summary

void	addValidatedElement(String name, int index, Object value) Adds an indexed element to an array attribute with validation.
void	addValidatedElement(String name, Object value) Adds an element to an array attribute with validation.
void	applyAttributeExporter(AttributeExporter exporter) Applies an attribute exporter.
void	applyAttributeImporter(AttributeImporter importer) Applies an attribute importer.
void	applyAttributeValidator(AttributeValidator validator) Applies an attribute validator.
VariableAttributeInfo	attributeInfo(String name) Returns attribute info for a named attribute.
VariableAttributeInfo	attributeInfo(String name, boolean unlocked) Returns optionally unlocked attribute info for a named attribute.
int	attributeLength(String name) Returns the length of an array attribute.
List	attributeList() Returns attribute info for all attributes in the definition order without internal attributes.
List	attributeList(boolean unlocked) Returns optionally unlocked attribute info for all attributes in the definition order without internal attributes.
List	attributeList(String group) Returns attribute info for attributes of the specified group in the definition order without internal attributes.
List	attributeList(String group, boolean unlocked) Returns optionally unlocked attribute info for attributes of the specified group in the definition order without internal attributes.
void	clearAttributeValues() Clears attribute values of the current attributes.
Object	clone() Clones this variable.
boolean	containsAttribute(String name) Checks whether the named attribute exists.
AttributeList	exportAttributes(Identity id, Object source, boolean foreign) Exports attribute values to another variable identified by the specified Identity and obtained from an external source by applying the exporter of this variable.
AttributeList	exportAttributes(Object target) Exports attribute values to another object.
AttributeList	exportAttributes(Object target, AttributeFilter filter) Exports filtered attribute values to another object.
AttributeList	exportAttributes(Variable other, Object source, boolean foreign) Exports attribute values to another variable obtained from an external source by applying the exporter of this variable.
Object	getAttribute(String name) Gets the value of the named internal or dynamic attribute without access checks and any variable specific validation.
AttributeList	getAttributes(String[] names) Gets the values of the named internal or dynamic attributes without access checks and any variable specific validation.
Object	getAttributeValue(String name) Gets the value of the named dynamic attribute without access checks and any variable specific validation.
Object	getValidatedElement(String name, int index) Gets the indexed element of an array attribute with validation.
Object	getValidatedValue(String name) Gets the value of a named dynamic attribute with validation.
Map	getValidatedValues() Gets attribute values as a map of name value bindings with validation.
Object	getVariableId() Gets the id of this variable corresponding its primary attributes.
String	getVariableType() Gets the type of this variable in the variable registry.
AttributeList	importAttributes(Identity id, Object source, boolean foreign) Imports attribute values from another variable identified by the specified Identity and obtained from an external source by applying the importer of this variable.
AttributeList	importAttributes(Object source) Imports attribute values from another object.
AttributeList	importAttributes(Object source, AttributeFilter filter) Imports filtered attribute values from another object.
AttributeList	importAttributes(Variable other, Object source, boolean foreign) Imports attribute values from another variable obtained from an external source by applying the importer of this variable.
Object	removeValidatedElement(String name, int index) Removes the indexed element from an array attribute.
boolean	removeValidatedElement(String name, Object value) Removes an element from an array attribute.
Map	resetValidatedValues(Map attributes) Resets attribute values in a map of name value bindings with validation.
void	setAttribute(Attribute attr) Sets the value of the given internal or dynamic attribute without access checks and any variable specific validation.
AttributeList	setAttributes(AttributeList attrs) Sets the values of the listed internal or dynamic attributes without access checks and any variable specific validation.
void	setAttributeValue(String name, Object value) Sets the value of the named dynamic attribute without access checks and any variable specific validation.
void	setValidatedElement(String name, int index, Object value) Sets the indexed element of an array attribute with validation.
void	setValidatedValue(String name, Object value) Sets the value of an attribute as a name value pair with validation.
void	setValidatedValues(Map attributes) Sets attribute values in a map of name value bindings with validation.
void	setVariableId(Object id) Sets the id of this variable corresponding its primary attributes.
Map	validateAttributeValues() Validates attribute values of the current attributes.
Map	validateAttributeValues(Map attributes) Validates attribute values in a map of name value bindings.

Methods inherited from interface org.norther.tammi.core.base.ReferableMBean

getMBean

Methods inherited from interface javax.management.DynamicMBean

getMBeanInfo, invoke

Field Detail

VALIDATED_VALUES

static final String VALIDATED_VALUES

Validated values attribute.

See Also:

Constant Field Values

VARIABLE_TYPE

static final String VARIABLE_TYPE

Variable type attribute.

See Also:

Constant Field Values

VARIABLE_ID

static final String VARIABLE_ID

Variable id attribute.

See Also:

Constant Field Values

GET_ATTRIBUTE_VALUE

static final String GET_ATTRIBUTE_VALUE

Get attribute value method.

See Also:

Constant Field Values

SET_ATTRIBUTE_VALUE

static final String SET_ATTRIBUTE_VALUE

Set attribute value method.

See Also:

Constant Field Values

RESET_VALIDATED_VALUES

static final String RESET_VALIDATED_VALUES

Reset validated values method.

See Also:

Constant Field Values

VALIDATE_ATTRIBUTE_VALUES

static final String VALIDATE_ATTRIBUTE_VALUES

Validate attribute values method.

See Also:

Constant Field Values

CLEAR_ATTRIBUTE_VALUES

static final String CLEAR_ATTRIBUTE_VALUES

Clear attribute values method.

See Also:

Constant Field Values

GET_VALIDATED_VALUE

static final String GET_VALIDATED_VALUE

Get validated value method.

See Also:

Constant Field Values

SET_VALIDATED_VALUE

static final String SET_VALIDATED_VALUE

Set validated value method.

See Also:

Constant Field Values

GET_VALIDATED_ELEMENT

static final String GET_VALIDATED_ELEMENT

Get validated element method.

See Also:

Constant Field Values

SET_VALIDATED_ELEMENT

static final String SET_VALIDATED_ELEMENT

Set validated element method.

See Also:

Constant Field Values

ADD_VALIDATED_ELEMENT

static final String ADD_VALIDATED_ELEMENT

Add validated element method.

See Also:

Constant Field Values

REMOVE_VALIDATED_ELEMENT

static final String REMOVE_VALIDATED_ELEMENT

Remove valiadted element method.

See Also:

Constant Field Values

ATTRIBUTE_LENGTH

static final String ATTRIBUTE_LENGTH

Attribute length method.

See Also:

Constant Field Values

CONTAINS_ATTRIBUTE

static final String CONTAINS_ATTRIBUTE

Contains attribute method.

See Also:

Constant Field Values

ATTRIBUTE_INFO

static final String ATTRIBUTE_INFO

Attribute info method.

See Also:

Constant Field Values

ATTRIBUTE_LIST

static final String ATTRIBUTE_LIST

Attribute list method.

See Also:

Constant Field Values

APPLY_ATTRIBUTE_VALIDATOR

static final String APPLY_ATTRIBUTE_VALIDATOR

Apply attribute validator method.

See Also:

Constant Field Values

APPLY_ATTRIBUTE_IMPORTER

static final String APPLY_ATTRIBUTE_IMPORTER

Apply attribute importer method.

See Also:

Constant Field Values

APPLY_ATTRIBUTE_EXPORTER

static final String APPLY_ATTRIBUTE_EXPORTER

Apply attribute exporter method.

See Also:

Constant Field Values

IMPORT_ATTRIBUTES

static final String IMPORT_ATTRIBUTES

Import attributes method.

See Also:

Constant Field Values

EXPORT_ATTRIBUTES

static final String EXPORT_ATTRIBUTES

Export attributes method.

See Also:

Constant Field Values

VALIDATED_VALUES_DESCRIPTION

static final String VALIDATED_VALUES_DESCRIPTION

Validated values description.

See Also:

Constant Field Values

VARIABLE_TYPE_DESCRIPTION

static final String VARIABLE_TYPE_DESCRIPTION

Variable type description.

See Also:

Constant Field Values

VARIABLE_ID_DESCRIPTION

static final String VARIABLE_ID_DESCRIPTION

Variable id description.

See Also:

Constant Field Values

GET_ATTRIBUTE_VALUE_DESCRIPTION

static final String GET_ATTRIBUTE_VALUE_DESCRIPTION

Get attribute value description.

See Also:

Constant Field Values

SET_ATTRIBUTE_VALUE_DESCRIPTION

static final String SET_ATTRIBUTE_VALUE_DESCRIPTION

Set attribute value description.

See Also:

Constant Field Values

RESET_VALIDATED_VALUES_DESCRIPTION

static final String RESET_VALIDATED_VALUES_DESCRIPTION

Reset validated values description.

See Also:

Constant Field Values

VALIDATE_ATTRIBUTE_VALUES_DESCRIPTION

static final String VALIDATE_ATTRIBUTE_VALUES_DESCRIPTION

Validate attribute values description.

See Also:

Constant Field Values

CLEAR_ATTRIBUTE_VALUES_DESCRIPTION

static final String CLEAR_ATTRIBUTE_VALUES_DESCRIPTION

Clear attribute values description.

See Also:

Constant Field Values

GET_VALIDATED_VALUE_DESCRIPTION

static final String GET_VALIDATED_VALUE_DESCRIPTION

Get validated value description.

See Also:

Constant Field Values

SET_VALIDATED_VALUE_DESCRIPTION

static final String SET_VALIDATED_VALUE_DESCRIPTION

Set validated value description.

See Also:

Constant Field Values

GET_VALIDATED_ELEMENT_DESCRIPTION

static final String GET_VALIDATED_ELEMENT_DESCRIPTION

Get validated element description.

See Also:

Constant Field Values

SET_VALIDATED_ELEMENT_DESCRIPTION

static final String SET_VALIDATED_ELEMENT_DESCRIPTION

Set validated element description.

See Also:

Constant Field Values

ADD_VALIDATED_ELEMENT_DESCRIPTION

static final String ADD_VALIDATED_ELEMENT_DESCRIPTION

Add validated element description.

See Also:

Constant Field Values

REMOVE_VALIDATED_ELEMENT_DESCRIPTION

static final String REMOVE_VALIDATED_ELEMENT_DESCRIPTION

Remove validated element description.

See Also:

Constant Field Values

ATTRIBUTE_LENGTH_DESCRIPTION

static final String ATTRIBUTE_LENGTH_DESCRIPTION

Attribute length description.

See Also:

Constant Field Values

CONTAINS_ATTRIBUTE_DESCRIPTION

static final String CONTAINS_ATTRIBUTE_DESCRIPTION

Contains attribute description.

See Also:

Constant Field Values

ATTRIBUTE_INFO_DESCRIPTION

static final String ATTRIBUTE_INFO_DESCRIPTION

Attribute info description.

See Also:

Constant Field Values

ATTRIBUTE_LIST_DESCRIPTION

static final String ATTRIBUTE_LIST_DESCRIPTION

Attribute list description.

See Also:

Constant Field Values

APPLY_ATTRIBUTE_VALIDATOR_DESCRIPTION

static final String APPLY_ATTRIBUTE_VALIDATOR_DESCRIPTION

Apply attribute validator description.

See Also:

Constant Field Values

APPLY_ATTRIBUTE_IMPORTER_DESCRIPTION

static final String APPLY_ATTRIBUTE_IMPORTER_DESCRIPTION

Apply attribute importer description.

See Also:

Constant Field Values

APPLY_ATTRIBUTE_EXPORTER_DESCRIPTION

static final String APPLY_ATTRIBUTE_EXPORTER_DESCRIPTION

Apply attribute exporter description.

See Also:

Constant Field Values

IMPORT_ATTRIBUTES_DESCRIPTION

static final String IMPORT_ATTRIBUTES_DESCRIPTION

Import attributes description.

See Also:

Constant Field Values

EXPORT_ATTRIBUTES_DESCRIPTION

static final String EXPORT_ATTRIBUTES_DESCRIPTION

Export attributes description.

See Also:

Constant Field Values

Method Detail

clone

Object clone()

Clones this variable. The new variable contains the same attributes as the original one. The attribute values themselves are not cloned.

Returns:

a clone of this variable.

getAttribute

Object getAttribute(String name)
                    throws AttributeNotFoundException,
                           ReflectionException,
                           MBeanException

Gets the value of the named internal or dynamic attribute without access checks and any variable specific validation.

Specified by:

getAttribute in interface DynamicMBean

Parameters:

name - the attribute name.

Returns:

the attribute value.

Throws:

AttributeNotFoundException - if the name is unknown.

ReflectionException - if a getter is not found.

MBeanException - if getting of the value fails.

setAttribute

void setAttribute(Attribute attr)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         ReflectionException,
                         MBeanException

Sets the value of the given internal or dynamic attribute without access checks and any variable specific validation.

Specified by:

setAttribute in interface DynamicMBean

Parameters:

attr - the attribute to set.

Throws:

AttributeNotFoundException - if the name is unknown.

InvalidAttributeValueException - if the value is invalid.

ReflectionException - if a getter is not found.

MBeanException - if getting of the value fails.

getAttributes

AttributeList getAttributes(String[] names)

Gets the values of the named internal or dynamic attributes without access checks and any variable specific validation.

Specified by:

getAttributes in interface DynamicMBean

Parameters:

names - an array of attribute names.

Returns:

a list of name-value pairs.

setAttributes

AttributeList setAttributes(AttributeList attrs)

Sets the values of the listed internal or dynamic attributes without access checks and any variable specific validation.

Specified by:

setAttributes in interface DynamicMBean

Parameters:

attrs - the attributes to set.

Returns:

a list of set name-value pairs.

getAttributeValue

Object getAttributeValue(String name)
                         throws AttributeNotFoundException

Gets the value of the named dynamic attribute without access checks and any variable specific validation.

Parameters:

name - the attribute name.

Returns:

the attribute value.

Throws:

AttributeNotFoundException - if the name is unknown.

setAttributeValue

void setAttributeValue(String name,
                       Object value)
                       throws AttributeNotFoundException,
                              InvalidAttributeValueException

Sets the value of the named dynamic attribute without access checks and any variable specific validation.

Parameters:

name - the attribute name.

value - the attribute value.

Throws:

AttributeNotFoundException - if the name is unknown.

InvalidAttributeValueException - if the value is invalid.

getValidatedValues

Map getValidatedValues()

Gets attribute values as a map of name value bindings with validation. Only dynamic attributes are included in the map.

Returns:

a map of attribute values.

setValidatedValues

void setValidatedValues(Map attributes)

Sets attribute values in a map of name value bindings with validation. Only known dynamic attributes are set, others skipped.

Parameters:

attributes - the attributes map.

resetValidatedValues

Map resetValidatedValues(Map attributes)

Resets attribute values in a map of name value bindings with validation. Only known dynamic attributes are set, others skipped.

Invalid attributes are returned in a map binding an invalid attribute name to a validation exception. An empty map indicates that all attributes were valid.

Note that if the attributes map does not contain any settable values, null is returned.

Parameters:

attributes - the attributes map.

Returns:

a map of invalid attributes, an empty map or null.

validateAttributeValues

Map validateAttributeValues(Map attributes)

Validates attribute values in a map of name value bindings. Only known dynamic attributes are validated, others skipped.

Invalid attributes are returned in a map binding an invalid attribute name to a validation exception. An empty map indicates that all attributes were valid.

Note that if the attributes map does not contain any settable values, null is returned.

Parameters:

attributes - the attributes map.

Returns:

a map of invalid attributes, an empty map or null.

validateAttributeValues

Map validateAttributeValues()

Validates attribute values of the current attributes. Only dynamic writable attributes are validated, others skipped.

Invalid attributes are returned in a map binding an invalid attribute name to a validation exception. An empty map indicates that all attributes were valid.

Returns:

a map of invalid attributes or an empty map.

clearAttributeValues

void clearAttributeValues()

Clears attribute values of the current attributes. Only dynamic writable attributes are cleared, others skipped.

getValidatedValue

Object getValidatedValue(String name)
                         throws AttributeNotFoundException

Gets the value of a named dynamic attribute with validation.

Parameters:

name - the attribute name.

Returns:

the attribute value.

Throws:

AttributeNotFoundException - if the name is unknown.

setValidatedValue

void setValidatedValue(String name,
                       Object value)
                       throws AttributeNotFoundException,
                              InvalidAttributeValueException

Sets the value of an attribute as a name value pair with validation. Only dynamic attributes can be set as a name value pair.

Parameters:

name - the attribute name.

value - the attribute value.

Throws:

AttributeNotFoundException - if the name is unknown.

InvalidAttributeValueException - if the value is invalid.

getValidatedElement

Object getValidatedElement(String name,
                           int index)
                           throws AttributeNotFoundException

Gets the indexed element of an array attribute with validation.

Parameters:

name - the attribute name.

index - the element index.

Returns:

the value of the element.

Throws:

AttributeNotFoundException - if the name is unknown.

setValidatedElement

void setValidatedElement(String name,
                         int index,
                         Object value)
                         throws AttributeNotFoundException,
                                InvalidAttributeValueException

Sets the indexed element of an array attribute with validation.

Parameters:

name - the attribute name.

index - the element index.

value - the value of the element.

Throws:

AttributeNotFoundException - if the name is unknown.

InvalidAttributeValueException - if the value is invalid.

addValidatedElement

void addValidatedElement(String name,
                         Object value)
                         throws AttributeNotFoundException,
                                InvalidAttributeValueException

Adds an element to an array attribute with validation.

Parameters:

name - the attribute name.

value - the value of the element.

Throws:

AttributeNotFoundException - if the name is unknown.

InvalidAttributeValueException - if the value is invalid.

addValidatedElement

void addValidatedElement(String name,
                         int index,
                         Object value)
                         throws AttributeNotFoundException,
                                InvalidAttributeValueException

Adds an indexed element to an array attribute with validation.

Parameters:

name - the attribute name.

index - the element index.

value - the value of the element.

Throws:

AttributeNotFoundException - if the name is unknown.

InvalidAttributeValueException - if the value is invalid.

removeValidatedElement

boolean removeValidatedElement(String name,
                               Object value)
                               throws AttributeNotFoundException

Removes an element from an array attribute.

Parameters:

name - the attribute name.

value - the value of the element.

Returns:

true if removed.

Throws:

AttributeNotFoundException - if the name is unknown.

removeValidatedElement

Object removeValidatedElement(String name,
                              int index)
                              throws AttributeNotFoundException

Removes the indexed element from an array attribute.

Parameters:

name - the attribute name.

index - the element index.

Returns:

the removed value of the element.

Throws:

AttributeNotFoundException - if the name is unknown.

attributeLength

int attributeLength(String name)
                    throws AttributeNotFoundException

Returns the length of an array attribute.

Parameters:

name - the attribute name.

Returns:

the attribute array length.

Throws:

AttributeNotFoundException - if the name is unknown.

containsAttribute

boolean containsAttribute(String name)

Checks whether the named attribute exists.

Parameters:

name - the name of the attribute.

Returns:

true if found, otherwise false.

attributeInfo

VariableAttributeInfo attributeInfo(String name)

Returns attribute info for a named attribute.

Parameters:

name - the name of the attribute.

Returns:

the attribute info or null if not found.

attributeInfo

VariableAttributeInfo attributeInfo(String name,
                                    boolean unlocked)

Returns optionally unlocked attribute info for a named attribute.

Parameters:

name - the name of the attribute.

unlocked - true for unlocked, false otherwise.

Returns:

the attribute info or null if not found.

attributeList

List attributeList()

Returns attribute info for all attributes in the definition order without internal attributes.

Returns:

a read-only list of VariableAttributeInfo instances.

attributeList

List attributeList(boolean unlocked)

Returns optionally unlocked attribute info for all attributes in the definition order without internal attributes.

Parameters:

unlocked - true for unlocked, false otherwise.

Returns:

a read-only list of VariableAttributeInfo instances.

attributeList

List attributeList(String group)

Returns attribute info for attributes of the specified group in the definition order without internal attributes.

Parameters:

group - the group.

Returns:

a list of VariableAttributeInfo instances.

attributeList

List attributeList(String group,
                   boolean unlocked)

Returns optionally unlocked attribute info for attributes of the specified group in the definition order without internal attributes.

Parameters:

group - the group.

unlocked - true for unlocked, false otherwise.

Returns:

a list of VariableAttributeInfo instances.

getVariableType

String getVariableType()

Gets the type of this variable in the variable registry.

Returns:

the variable type or null if not defined.

getVariableId

Object getVariableId()

Gets the id of this variable corresponding its primary attributes. The id may be a single value, an object array or null.

Returns:

the variable id or null if not defined.

setVariableId

void setVariableId(Object id)
                   throws AttributeNotFoundException,
                          InvalidAttributeValueException

Sets the id of this variable corresponding its primary attributes. The id may be a single value, an object array or null.

Parameters:

id - the variable id or null if not defined.

Throws:

AttributeNotFoundException - if the id is unknown.

InvalidAttributeValueException - if the id is invalid.

applyAttributeValidator

void applyAttributeValidator(AttributeValidator validator)

Applies an attribute validator.

Parameters:

validator - the attribute validator.

applyAttributeImporter

void applyAttributeImporter(AttributeImporter importer)

Applies an attribute importer.

Parameters:

importer - the attribute importer.

applyAttributeExporter

void applyAttributeExporter(AttributeExporter exporter)

Applies an attribute exporter.

Parameters:

exporter - the attribute exporter.

importAttributes

AttributeList importAttributes(Identity id,
                               Object source,
                               boolean foreign)

Imports attribute values from another variable identified by the specified Identity and obtained from an external source by applying the importer of this variable.

Parameters:

id - the identity.

source - the source object.

foreign - true for a foreign import, otherwise false.

Returns:

a list of imported attributes.

importAttributes

AttributeList importAttributes(Variable other,
                               Object source,
                               boolean foreign)

Imports attribute values from another variable obtained from an external source by applying the importer of this variable.

Parameters:

other - the other variable.

source - the source object.

foreign - true for a foreign import, otherwise false.

Returns:

a list of imported attributes.

importAttributes

AttributeList importAttributes(Object source)

Imports attribute values from another object. The object can be an object name of an MBean, a reference to another variable or any Java object. Attributes not compatible with attributes of this variable are not imported.

Note that attributes of compatible types are accepted directly without validation.

Parameters:

source - the source object.

Returns:

a list of imported attributes.

importAttributes

AttributeList importAttributes(Object source,
                               AttributeFilter filter)

Imports filtered attribute values from another object. The object can be an object name of an MBean, a reference to another variable or any Java object. Attributes not compatible with attributes of this variable are not imported.

Note that attributes of compatible types are accepted directly without validation.

Parameters:

source - the source object.

filter - the attribute filter to apply.

Returns:

a list of imported attributes.

exportAttributes

AttributeList exportAttributes(Identity id,
                               Object source,
                               boolean foreign)

Exports attribute values to another variable identified by the specified Identity and obtained from an external source by applying the exporter of this variable.

Parameters:

id - the identity.

source - the source object.

foreign - true for a foreign export, otherwise false.

Returns:

a list of exported attributes.

exportAttributes

AttributeList exportAttributes(Variable other,
                               Object source,
                               boolean foreign)

Exports attribute values to another variable obtained from an external source by applying the exporter of this variable.

Parameters:

other - the other variable.

source - the source object.

foreign - true for a foreign export, otherwise false.

Returns:

a list of exported attributes.

exportAttributes

AttributeList exportAttributes(Object target)

Exports attribute values to another object. The object can be an object name of an MBean, a reference to another variable or any Java object. Attributes not compatible with attributes of this variable are not exported.

Parameters:

tar