com.highdeal.pnr.hci
Class InAttributeModel

java.lang.Object
  com.highdeal.pnr.hci.InAttributeModel

All Implemented Interfaces:

XMLMarshallable

public class InAttributeModel
extends java.lang.Object
implements XMLMarshallable

This class represents an input attribute of a translation table and contains a name and a description.

See Also:

TranslationTableModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Constructor Summary

InAttributeModel()
Constructs an empty input attribute model.

InAttributeModel(java.lang.String name, java.lang.String description)
Constructs an input attribute with a name, and a description.

Method Summary

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.
boolean	checkValidity() Returns true if the name is valid.
java.lang.String	getDescription() Returns the description of the input attribute.
java.lang.String	getName() Returns the name of the input 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	setDescription(java.lang.String d) Sets the description of the input attribute.
void	setName(java.lang.String n) Sets the name of the input attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

InAttributeModel

public InAttributeModel()

Constructs an empty input attribute model.

InAttributeModel

public InAttributeModel(java.lang.String name,
                        java.lang.String description)

Constructs an input attribute with a name, and a description.

Parameters:

name - the name of the attribute.

description - the description of the attribute.

Method Detail

getName

public java.lang.String getName()

Returns the name of the input attribute.

Returns:

the name of the input attribute.

setName

public void setName(java.lang.String n)

Sets the name of the input attribute.

Parameters:

n - the name of the input attribute.

getDescription

public java.lang.String getDescription()

Returns the description of the input attribute.

Returns:

the description of the input attribute.

setDescription

public void setDescription(java.lang.String d)

Sets the description of the input attribute.

Parameters:

d - the description of the input attribute.

checkValidity

public boolean checkValidity()

Returns true if the name is valid. Name is valid if it is not null or empty .

Returns:

true if the name is valid, false otherwise.

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