com.highdeal.pnr.hci

Class TierTableOutAttributeModel

java.lang.Object

com.highdeal.pnr.hci.TierTableOutAttributeModel

All Implemented Interfaces:

XMLMarshallable

public class TierTableOutAttributeModel
extends Object
implements XMLMarshallable

This class represents an output attribute in a tier table and contains a name, a type, a description and a calculation mode.

See Also:

TierTableModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="tierTableOutAttribute">
   <xs:complexType>
     <xs:attribute name="name" type="xs:string" use="required"/>
     <xs:attribute name="type" type="xs:string" use="required"/>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="computationMode" type="ComputationModeType"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="ComputationModeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="unset"/>
     <xs:enumeration value="singleNonLinear"/>
     <xs:enumeration value="singleLinear"/>
     <xs:enumeration value="cumulativeNonLinear"/>
     <xs:enumeration value="cumulativeLinear"/>
   </xs:restriction>
 </xs:simpleType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TierTableOutAttributeModel.ComputationMode

Constructor Summary

Constructors

Constructor and Description
TierTableOutAttributeModel() Constructs an empty output attribute model.
TierTableOutAttributeModel(String name, String description, int type, TierTableOutAttributeModel.ComputationMode computationMode) Constructs an output attribute with a name, a description, a type and a default value.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
boolean	checkValidity() Returns true if the output attribute is valid.
TierTableOutAttributeModel	duplicate()
TierTableOutAttributeModel.ComputationMode	getComputationMode() Returns the calculation mode of the output attribute.
String	getDescription() Returns the description of the output attribute.
String	getName() Returns the name of the output attribute.
int	getType() Returns the type of the output attribute.
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	setComputationMode(TierTableOutAttributeModel.ComputationMode mode) Sets the calculation mode of the output attribute.
void	setDescription(String d) Sets the description of the output attribute.
void	setName(String n) Sets the name of the output attribute.
void	setType(int type) Sets the type of the output attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

TierTableOutAttributeModel

public TierTableOutAttributeModel()

Constructs an empty output attribute model.

TierTableOutAttributeModel

public TierTableOutAttributeModel(String name,
                                  String description,
                                  int type,
                                  TierTableOutAttributeModel.ComputationMode computationMode)

Constructs an output attribute with a name, a description, a type and a default value. (see setType(int) for type allowed values). (see setComputationMode(ComputationMode) for ComputationMode allowed values).

Parameters:

name - the name of the attribute.

description - the description of the attribute.

type - the type of the attribute.

computationMode - the mode of calculation for an attribute of type decimal.

Method Detail

getName

public String getName()

Returns the name of the output attribute.

Returns:

the name of the output attribute.

setName

public void setName(String n)

Sets the name of the output attribute.

Parameters:

n - the name of the output attribute.

getDescription

public String getDescription()

Returns the description of the output attribute.

Returns:

the description of the output attribute.

setDescription

public void setDescription(String d)

Sets the description of the output attribute.

Parameters:

d - the description of the output attribute.

getType

public int getType()

Returns the type of the output attribute. Returned types are :

• string
• number

Returns:

the type of the output attribute.

setType

public void setType(int type)

Sets the type of the output attribute. Allowed types are :

• string
• number

Parameters:

type - the type of the output attribute.

getComputationMode

public TierTableOutAttributeModel.ComputationMode getComputationMode()

Returns the calculation mode of the output attribute. Returned calculation modes are :

• single_non_linear
• single_linear
• cumulative_non_linear
• cumulative_linear

Returns:

the calculation mode of the output attribute.

setComputationMode

public void setComputationMode(TierTableOutAttributeModel.ComputationMode mode)

Sets the calculation mode of the output attribute. Allowed calculation modes are :

• single_non_linear
• single_linear
• cumulative_non_linear
• cumulative_linear

Parameters:

mode - the calculation mode of the output attribute.

checkValidity

public boolean checkValidity()

Returns true if the output attribute is valid. Attribute is valid if its name is not null or empty and if its type is valid (see setType(int).

Returns:

true if the attribute is valid, false otherwise.

duplicate

public TierTableOutAttributeModel duplicate()

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(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(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