com.highdeal.filter.hci

Class SpecificModificationModel

java.lang.Object

com.highdeal.filter.hci.SpecificModificationModel

All Implemented Interfaces:

XMLMarshallable

public class SpecificModificationModel
extends java.lang.Object
implements XMLMarshallable

This Java class allows describing a unitary modification that does not concern an attribute.
As all used specific modifications must be known by the server system to be interpreted, the user cannot create new specific ones he can only use the specific modifications that are proposed by existing (concrete) modification models.

Like SpecificFormulaModel, each specific modification model is identified by a code.

This class provides a support for parameters management and can aggregate nested filter models.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="specificModification">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="ModificationModel" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="parameters" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJECT_NAME

Constructor Summary

Constructors

Constructor and Description
SpecificModificationModel() Empty contructor.
SpecificModificationModel(java.lang.String code) Builds a "pre-coded" specific modification.

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.
void	addParameter(java.lang.String param) Adds a parameter to the param list.
java.util.Properties	extractParamAsProperties() Extracts params for building a Properties structure from a param list like "param1 = value1, param2 = value2...".
java.util.Vector<java.lang.String>	extractParameters() Extracts parameters .from the CSV parameters String representation.
java.lang.String	getCode() Returns the mandatory specific modification code.
ModificationModel	getNestedModification() Returns the optional nested modification model.
java.lang.String	getParameters() Returns a CSV String of parameters.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCode(java.lang.String code) Sets the required code of the specific modification.
void	setNestedModification(ModificationModel nested) Sets the optional nested modification model.
void	setParameters(java.lang.String params) Sets the CSV String of params.

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_NAME

public static final java.lang.String OBJECT_NAME

See Also:

Constant Field Values

Constructor Detail

SpecificModificationModel

public SpecificModificationModel()

Empty contructor.

SpecificModificationModel

public SpecificModificationModel(java.lang.String code)

Builds a "pre-coded" specific modification.

Parameters:

code - The code of the specific modification

Method Detail

getCode

public java.lang.String getCode()

Returns the mandatory specific modification code.

Returns:

The code of the modification

setCode

public void setCode(java.lang.String code)

Sets the required code of the specific modification. Cannot be set to null.

Parameters:

code - The code of the specific modification

getParameters

public java.lang.String getParameters()

Returns a CSV String of parameters.

Returns:

The CSV list of optional parameters

setParameters

public void setParameters(java.lang.String params)

Sets the CSV String of params.

Parameters:

params - The CSV list of optional parameters

getNestedModification

public ModificationModel getNestedModification()

Returns the optional nested modification model.

Returns:

The nested modification model for modifying some aggregated objects

setNestedModification

public void setNestedModification(ModificationModel nested)

Sets the optional nested modification model.

extractParameters

public java.util.Vector<java.lang.String> extractParameters()

Extracts parameters .from the CSV parameters String representation.

Returns:

A vector of string parameters

addParameter

public void addParameter(java.lang.String param)

Adds a parameter to the param list.

Parameters:

param - The string representation of the added parameter

extractParamAsProperties

public java.util.Properties extractParamAsProperties()

Extracts params for building a Properties structure from a param list like "param1 = value1, param2 = value2...".

Returns:

A detailed structure

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