com.highdeal.filter.hci

Class AttributeModificationModel

java.lang.Object

com.highdeal.filter.hci.AttributeModificationModel

All Implemented Interfaces:

XMLMarshallable

public class AttributeModificationModel
extends java.lang.Object
implements XMLMarshallable

This class represents a modification which can be done on an attribute; It aggregates an Attribute Description to identify the attribute which must be modified.

This class will describe the operator and store the operand which must be applied.

Available operators:

• UPDATE: Updates only existing attributes
• UNSET: Clears the specified attributes
• SET: Creates the "additionnal" or "parameter" attribute if it does not exist and sets the operand value
• REMOVE (forbidden with "main" group attribute - see AttributeDescriptionModel)
• ADD (with number attribute only)
• SUBTRACT (with number attribute only)
• MULTIPLY (with number attribute only)
• DIVIDE (with number attribute only)

Available operand types:

• BigDecimal for a TYPE_NUMBER attribute
• Date for a TYPE_DATE attribute
• String for a TYPE_STRING attribute
• BigDecimal.valueOf(0) or BigDecimal.valueOf(1) for a TYPE_BOOLEAN attribute

See Also:

ModificationModel, AttributeDescriptionModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="attributeModification">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="attributeDescription" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="operandType" type="OperandTypeType" use="required"/>
     <xs:attribute name="operator" type="OperatorType"  use="required"/>
     <xs:attribute name="operand" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="OperandTypeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="boolean"/> 
     <xs:enumeration value="number"/>  
     <xs:enumeration value="string"/> 
     <xs:enumeration value="date"/>  
   </xs:restriction> 
 </xs:simpleType>

<xs:simpleType name="OperatorType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="add"/>             <!-- Can be apply only on NUMBER attribute -->
     <xs:enumeration value="subtract"/>        <!-- Can be apply only on NUMBER attribute -->
     <xs:enumeration value="multiply"/>        <!-- Can be apply only on NUMBER attribute -->
     <xs:enumeration value="divide"/>          <!-- Can be apply only on NUMBER attribute -->
     <xs:enumeration value="update"/>          <!-- Updates the attribute only if it exists -->
     <xs:enumeration value="set"/>             <!-- Like an update but creates it if it does not exist -->
     <xs:enumeration value="remove"/>          <!-- Removes the attribute (reserved for additional attributes -->
     <xs:enumeration value="unset"/>           <!-- Sets no value to the attribute (attribute is null) -->
   </xs:restriction> 
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD Constant for ADD operator.
static int	DIVIDE Constant for DIVIDE operator.
static int	MULTIPLY Constant for MULTIPLY operator.
static int	REMOVE Constant for REMOVE operator.
static int	SET Constant for SET operator.
static int	SUBTRACT Constant for SUBTRACT operator.
static int	TYPE_BOOLEAN The boolean type for attribute description.
static int	TYPE_DATE The date type for attribute description.
static int	TYPE_NUMBER The number type for attribute description.
static int	TYPE_STRING The string type for attribute description.
static int	UNSET Constant for UNSET operator.
static int	UPDATE Constant for UPDATE operator.

Constructor Summary

Constructors

Constructor and Description
AttributeModificationModel() Empty constructor.
AttributeModificationModel(AttributeDescriptionModel att, java.lang.String description, java.lang.Object operand, int operator) Builds a complete AttributeModificationModel.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagname, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
AttributeDescriptionModel	getAttributeDescription() Gets the description of the related attribute.
java.lang.String	getDescription() Gets the description.
java.lang.Object	getOperand() Gets the operand.
int	getOperandType() Gets the operand type.
int	getOperator() Gets the operator.
boolean	isValid() Checks if types are valid and compatible with operator.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributeDescription(AttributeDescriptionModel ad) Set the description of the related attribute.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setDescription(java.lang.String desc) Sets the description.
void	setOperand(java.lang.Object op) Sets the operand.
void	setOperator(int op) Sets the operator.

Methods inherited from class java.lang.Object

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

Field Detail

SET

public static final int SET

Constant for SET operator.

See Also:

Constant Field Values

UPDATE

public static final int UPDATE

Constant for UPDATE operator.

See Also:

Constant Field Values

ADD

public static final int ADD

Constant for ADD operator. Reserved for TYPE_NUMBER attribute only.

See Also:

Constant Field Values

SUBTRACT

public static final int SUBTRACT

Constant for SUBTRACT operator. Reserved for TYPE_NUMBER attribute only.

See Also:

Constant Field Values

MULTIPLY

public static final int MULTIPLY

Constant for MULTIPLY operator. Reserved for TYPE_NUMBER attribute only.

See Also:

Constant Field Values

DIVIDE

public static final int DIVIDE

Constant for DIVIDE operator. Reserved for TYPE_NUMBER attribute only.

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

Constant for REMOVE operator.

See Also:

Constant Field Values

UNSET

public static final int UNSET

Constant for UNSET operator.

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

The boolean type for attribute description.

See Also:

Constant Field Values

TYPE_NUMBER

public static final int TYPE_NUMBER

The number type for attribute description.

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

The string type for attribute description.

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

The date type for attribute description.

See Also:

Constant Field Values

Constructor Detail

AttributeModificationModel

public AttributeModificationModel()

Empty constructor.

AttributeModificationModel

public AttributeModificationModel(AttributeDescriptionModel att,
                                  java.lang.String description,
                                  java.lang.Object operand,
                                  int operator)

Builds a complete AttributeModificationModel.

Method Detail

isValid

public boolean isValid()

Checks if types are valid and compatible with operator.

Returns:

true if the current object is corectly configured.

getAttributeDescription

public AttributeDescriptionModel getAttributeDescription()

Gets the description of the related attribute.

Returns:

an attribute description.

setAttributeDescription

public void setAttributeDescription(AttributeDescriptionModel ad)

Set the description of the related attribute.

Parameters:

ad - an attribute description.

getOperand

public java.lang.Object getOperand()

Gets the operand.

Returns:

the operand.

setOperand

public void setOperand(java.lang.Object op)

Sets the operand.

Parameters:

op - the operand.

getOperandType

public int getOperandType()

Gets the operand type. No set method for this attribute. The attribute is automatically set according to the operand object class name. Default value is string type.

Returns:

the type.

See Also:

TYPE_BOOLEAN, TYPE_NUMBER, TYPE_STRING, TYPE_DATE

getDescription

public java.lang.String getDescription()

Gets the description.

Returns:

the description.

setDescription

public void setDescription(java.lang.String desc)

Sets the description.

Parameters:

desc - the description.

getOperator

public int getOperator()

Gets the operator.

Returns:

the operator code.

setOperator

public void setOperator(int op)

Sets the operator.

Parameters:

op - the operator.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagname,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagname - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into