com.ibm.commons.iloader.node
Interface IMember

All Known Subinterfaces:

IAttribute, ICollection

All Known Implementing Classes:

DataNode.ComputedField

public interface IMember

A base interface for defining properties in the DataNode model. This interface contains all of the common actions that will be required by simple and complex properties.

See Also:

DataNode

Field Summary

static int	TYPE_BOOLEAN Specifies that the property (IMember) is of type boolean
static int	TYPE_INTEGER Specifies that the property (IMember) is of type int
static int	TYPE_NUMBER Specifies that the property (IMember) is of type Number
static int	TYPE_OBJECT Specifies that the property (IMember) is of type Object
static int	TYPE_STRING Specifies that the property (IMember) is of type String

Method Summary

java.lang.String	getCategory() Get the category.
java.lang.String	getDefaultValue() Returns the default value of the property.
java.lang.String	getDescription() Get a description, for user help.
java.lang.String	getDisplayName() Get the attribute display name.
IPropertyEditor	getEditor() Returns a property editor that can be used to define this property.
java.lang.String	getName() Get the attribute name.
IClassDef	getParent() Get the class definition parent of this member.
IValidator	getScriptValidator(java.lang.Object obj) Returns a validator that will be associated with the IPropertyEditor that is associated with this property.
int	getType() Get the attribute data type.
IClassDef	getTypeDef() In the case of a member whose type is com.ibm.commons.iloader.node.IMember.TYPE_OBJECT this method will return the class that can be used to define a new Object.
boolean	isReadOnly() Returns whether or not a member is read-only.
boolean	isScriptable(IScript script) Defines whether or not the property's value can be a script value.
boolean	isVisible(java.lang.Object obj) Check if the member is visible.

Field Detail

TYPE_STRING

static final int TYPE_STRING

Specifies that the property (IMember) is of type String

See Also:

Constant Field Values

TYPE_INTEGER

static final int TYPE_INTEGER

Specifies that the property (IMember) is of type int

See Also:

Constant Field Values

TYPE_NUMBER

static final int TYPE_NUMBER

Specifies that the property (IMember) is of type Number

See Also:

Constant Field Values

TYPE_BOOLEAN

static final int TYPE_BOOLEAN

Specifies that the property (IMember) is of type boolean

See Also:

Constant Field Values

TYPE_OBJECT

static final int TYPE_OBJECT

Specifies that the property (IMember) is of type Object

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Get the attribute name.

Returns:

returns the name of the attribute

getDisplayName

java.lang.String getDisplayName()

Get the attribute display name.

Returns:

returns the name of the attribute as it is to appear in the user interface

getDescription

java.lang.String getDescription()

Get a description, for user help.

Returns:

returns a description of the property

getCategory

java.lang.String getCategory()

Get the category.

Returns:

returns the category that this property falls under, e.g. "Basics", "Data", etc..

getParent

IClassDef getParent()

Get the class definition parent of this member.

Returns:

returns the IClassDef parent of this IMember

See Also:

IClassDef

getType

int getType()

Get the attribute data type. Typically returns one of:

• com.ibm.commons.iloader.node.IMember.TYPE_STRING
• com.ibm.commons.iloader.node.IMember.TYPE_INTEGER
• com.ibm.commons.iloader.node.IMember.TYPE_NUMBER
• com.ibm.commons.iloader.node.IMember.TYPE_BOOLEAN
• com.ibm.commons.iloader.node.IMember.TYPE_OBJECT

Returns:

returns an int corresponding to the data type of the property

getTypeDef

IClassDef getTypeDef()

In the case of a member whose type is com.ibm.commons.iloader.node.IMember.TYPE_OBJECT this method will return the class that can be used to define a new Object.

isReadOnly

boolean isReadOnly()

Returns whether or not a member is read-only.

Returns:

returns true if the property is read-only

isVisible

boolean isVisible(java.lang.Object obj)

Check if the member is visible.

getDefaultValue

java.lang.String getDefaultValue()

Returns the default value of the property.

Returns:

returns a string

getEditor

IPropertyEditor getEditor()

Returns a property editor that can be used to define this property.

Returns:

returns a IPropertyEditor

See Also:

IPropertyEditor

isScriptable

boolean isScriptable(IScript script)

Defines whether or not the property's value can be a script value.

Returns:

returns true if the property's value can be set via a script

getScriptValidator

IValidator getScriptValidator(java.lang.Object obj)

Returns a validator that will be associated with the IPropertyEditor that is associated with this property.

Parameters:

obj -

Returns:

See Also:

#getEditor()}, {@link com.ibm.commons.iloader.node.validators.IValidator}