com.highdeal.filter.hci

Class Attribute

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.filter.hci.Attribute

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class Attribute
extends HCIModelAdapter

This Java class represents an attribute of an object which contains a name, a type (boolean, number, string, or date) and an optional value.

See Also:

AttributeSet

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="attribute">
   <xs:complexType>
    <xs:attribute name="name" type="xs:string"/>
    <xs:attribute name="type" type="AttributeValueType"/>
    <xs:attribute name="value" type="xs:string"/>
  </xs:complexType>
  </xs:element>

<xs:simpleType name="AttributeValueType">
   <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>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME The XML element name of the data element: attribute

Constructor Summary

Constructors

Constructor and Description
Attribute() Build an empty attribute
Attribute(java.lang.String name, int type, java.lang.Object value) Build an attribute with a name, a type and a valid value.

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.
java.lang.String	getName() Gets the name of the attribute.
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
int	getType() Gets the type of the attribute (boolean, number, date, or string).
java.lang.Object	getValue() Gets the value of the attribute.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

The XML element name of the data element: attribute

See Also:

Constant Field Values

Constructor Detail

Attribute

public Attribute()

Build an empty attribute

Attribute

public Attribute(java.lang.String name,
                 int type,
                 java.lang.Object value)

Build an attribute with a name, a type and a valid value.

The value of the attribute must be a valid object class according to the attribute type:

• For the boolean type, the value must be java.lang.Boolean.
• For the number type, the value must be java.math.BigDecimal.
• For the date type, the value must be java.util.Date.
• For the string type, the value is the toString() of the object class.

Parameters:

name - The name of the attribute

type - The type of the attribute

value - The value of the attribute

Method Detail

getName

public java.lang.String getName()

Gets the name of the attribute.

Returns:

The name of the attribute

getType

public int getType()

Gets the type of the attribute (boolean, number, date, or string).

Returns:

The type of the attribute

getValue

public java.lang.Object getValue()

Gets the value of the attribute.

Returns:

The value of the attribute

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

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

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.

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.

Parameters:

cData - The character data to be added

getTagName

public java.lang.String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name