com.highdeal.rangetable.hci

Class RangeTableRangeSetKeyModel

java.lang.Object

com.highdeal.rangetable.hci.RangeTableRangeSetKeyModel

All Implemented Interfaces:

IXMLMarshallable, XMLMapping, XMLMarshallable

public class RangeTableRangeSetKeyModel
extends java.lang.Object
implements IXMLMarshallable, XMLMapping

This Java class represents a range set key in a range set. It contains from 1 to 5 input columns.

See Also:

RangeTableRangeSetModel, RangeTableInColumnModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="RangeTableRangeSetKeyType">
   <xs:sequence>
     <xs:element name="inColumn" type="RangeTableRangeInColumnType" minOccurs="1" maxOccurs="5" />
   </xs:sequence>
 </xs:complexType>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME The tag name of the range set key of a range set

Constructor Summary

Constructors

Constructor and Description
RangeTableRangeSetKeyModel() Default range table range set key model.

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.Class<?>	getClass(java.lang.String nsUri, java.lang.String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
RangeTableInColumnModel	getInColumnByName(java.lang.String targetedName) Gets the column that has the specified name.
java.util.List<RangeTableInColumnModel>	getInColumns() Gets all the input columns contained in the range set.
java.lang.String[]	getInColumnValues() Gets the input column values.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
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 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 tag name of the range set key of a range set

See Also:

Constant Field Values

Constructor Detail

RangeTableRangeSetKeyModel

public RangeTableRangeSetKeyModel()

Default range table range set key model.

Method Detail

getInColumns

public java.util.List<RangeTableInColumnModel> getInColumns()

Gets all the input columns contained in the range set.

Returns:

A list that contains all the input columns of the range set

getInColumnByName

public RangeTableInColumnModel getInColumnByName(java.lang.String targetedName)

Gets the column that has the specified name.

Parameters:

targetedName - name of the column to retrieve

Returns:

the requested column (or null if it is not present)

getInColumnValues

public java.lang.String[] getInColumnValues()

Gets the input column values.

Returns:

the input column values

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

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

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Specified by:

marshalAttributes in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the object attributes into

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

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

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

Specified by:

marshalChildren in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the child objects into

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 IXMLMarshallable

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

getClass

public java.lang.Class<?> getClass(java.lang.String nsUri,
                                   java.lang.String tag,
                                   XMLAttributes atts)

Description copied from interface: XMLMapping

Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:

getClass in interface XMLMapping

Parameters:

nsUri - The unique resource identifier of the namespace of the XML tag

tag - The local part of the XML tag

atts - The attributes of the XML tag

Returns:

A Java class with a default constructor