com.highdeal.filter.hci

Class AttributeSet

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.filter.hci.AttributeSet

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class AttributeSet
extends HCIModelAdapter

This class represents a set of attributes of an HCI object.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="attributeSet">
   <xs:complexType>
    <xs:sequence>
      <xs:element ref="attribute" minOccurs="1" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="reference" type="xs:string"/>
  </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME The name of the tag element: attributeSet

Constructor Summary

Constructors

Constructor and Description
AttributeSet() Build an empty AttributeSet
AttributeSet(java.lang.String reference) Build an attribute set with a reference
AttributeSet(java.lang.String reference, java.util.List<Attribute> attributes) Build an attribute set with a reference and a list of attributes

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.
Attribute	getAttribute(java.lang.String attributeName) Gets an attribute by its name
java.util.List<Attribute>	getAttributeList() Gets the list of attribute
java.lang.String	getReference() Gets the reference of the HCI object
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
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 name of the tag element: attributeSet

See Also:

Constant Field Values

Constructor Detail

AttributeSet

public AttributeSet()

Build an empty AttributeSet

AttributeSet

public AttributeSet(java.lang.String reference)

Build an attribute set with a reference

Parameters:

reference - The reference(OID) of the related object

AttributeSet

public AttributeSet(java.lang.String reference,
                    java.util.List<Attribute> attributes)

Build an attribute set with a reference and a list of attributes

Parameters:

reference - The reference(OID) of the related object

attributes - The list of attributes

Method Detail

getAttributeList

public java.util.List<Attribute> getAttributeList()

Gets the list of attribute

Returns:

the list of attribute

getAttribute

public Attribute getAttribute(java.lang.String attributeName)

Gets an attribute by its name

Returns:

the attribute with the name specified, or null if no such attribute exists

getReference

public java.lang.String getReference()

Gets the reference of the HCI object

Returns:

the reference of the HCI object

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