com.nitido.nim
Class Modifier

java.lang.Object
  com.nitido.nim.Modifier

public class Modifier
extends java.lang.Object

The Modifier class encapsulates a modification requests made to the data object inside a DataControl. A Modifier object is composed of a command and the key/values pair that the command will operate on.

Field Summary

protected int	_command Reference to the command representaion associated with this control
protected java.lang.String	_key Reference to the key of the object being modified in the DataControl.
protected java.io.Serializable[]	_values Array of objects associated to the key for which the operation will take place.
static int	ADD Constant representing and add operation on the data control.
static int	REMOVE Constant representing and remove operation on the data control.
static int	REPLACE Constant representing and replace operation on the data control.

Constructor Summary

Modifier(int command, java.lang.String key, java.io.Serializable value)
Instantitates a new Modifier object.

Modifier(int command, java.lang.String key, java.io.Serializable[] values)
Instantitates a new Modifier object.

Method Summary

java.util.Enumeration	enumerateValues() This method returns the enumeration of objects associated to the operation in this control object.
int	getCommand() This method returns the integer representation of the operation associated to this Modifier object.
java.lang.String	getKey() This method returns the key of the objects being modified by this control object.
java.io.Serializable[]	getValues() This method returns the list of objects associated to the operation in this control object.
void	setCommand(int command) This method sets the integer representation of the operation associated to this control object.
void	setKey(java.lang.String key) This method returns the key associated to the objects for which this control will operate on.
void	setValue(java.io.Serializable value) This method sets the objects associated to the operation in this control object.
void	setValues(java.io.Serializable[] values) This method sets the objects associated to the operation in this control object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ADD

public static final int ADD

Constant representing and add operation on the data control.

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

Constant representing and remove operation on the data control.

See Also:

Constant Field Values

REPLACE

public static final int REPLACE

Constant representing and replace operation on the data control.

See Also:

Constant Field Values

_command

protected int _command

Reference to the command representaion associated with this control

_key

protected java.lang.String _key

Reference to the key of the object being modified in the DataControl.

_values

protected java.io.Serializable[] _values

Array of objects associated to the key for which the operation will take place.

Constructor Detail

Modifier

public Modifier(int command,
                java.lang.String key,
                java.io.Serializable[] values)

Instantitates a new Modifier object.

Parameters:

command - The integer representation of the operation to be performed on the DataControl. This parameter must be one of the following pre-defined constants:

• Modifier.ADD
• Modifier.REMOVE
• Modifier.REPLACE

key - The key for which the operations in the DataControl will take place.

values - The array of objects to be associated with the given key.

Modifier

public Modifier(int command,
                java.lang.String key,
                java.io.Serializable value)

Instantitates a new Modifier object.

Parameters:

command - The integer representation of the operation to be performed on the DataControl. This parameter must be one of the following pre-defined constants:

• Modifier.ADD
• Modifier.REMOVE
• Modifier.REPLACE

key - The key for which the operations in the DataControl will take place.

value - The object to be associated with the given key.

Method Detail

getCommand

public int getCommand()

This method returns the integer representation of the operation associated to this Modifier object.

Returns:

The integer representation of the operation associated with this control object.

getKey

public java.lang.String getKey()

This method returns the key of the objects being modified by this control object.

Returns:

The key of the objects being modified by this control object.

getValues

public java.io.Serializable[] getValues()

This method returns the list of objects associated to the operation in this control object.

Returns:

The array of objects associated to the operation in this control object.

enumerateValues

public java.util.Enumeration enumerateValues()

This method returns the enumeration of objects associated to the operation in this control object.

Returns:

The enumeration of objects associated to the operation in this control object.

setCommand

public void setCommand(int command)

This method sets the integer representation of the operation associated to this control object.

Parameters:

command - The integer representation of the operation to be performed on the DataControl. This parameter must be one of the following pre-defined constants:

• Modifier.ADD
• Modifier.REMOVE
• Modifier.REPLACE

setKey

public void setKey(java.lang.String key)

This method returns the key associated to the objects for which this control will operate on.

Parameters:

key - The key for which the operations in the DataControl will take place.

setValues

public void setValues(java.io.Serializable[] values)

This method sets the objects associated to the operation in this control object.

Parameters:

values - The array of objects associated with the given key.

setValue

public void setValue(java.io.Serializable value)

This method sets the objects associated to the operation in this control object.

Parameters:

value - The object associated with the given key.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object