com.highdeal.rangetable.hci

Class RangeTableRowModel

java.lang.Object

com.highdeal.rangetable.hci.RangeTableRowModel

All Implemented Interfaces:

IXMLMarshallable, XMLMapping, XMLMarshallable

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

This Java class represents a row in a range table or in a subscriber range table; A row includes a set of business data items as declared in the related range table class.

The upper bound is a number strictly positive. When the upper bound is not set, it is considered as unbounded.

See Also:

RangeTableModel, SubscriberRangeTableModel, CommonRangeTableModel, RangeTableColumnModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="RangeTableRowType">
   <xs:sequence>
     <xs:element name="column" type="RangeTableColumnType" minOccurs="1" maxOccurs="20" /> <!-- input/output data values in the row -->
   </xs:sequence>
   <xs:attribute name="upperBound" type="xs:decimal" use="optional" />
 </xs:complexType>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RANGE_TABLE_COLUMN_TAG_NAME
static java.lang.String	UPPER_BOUND__TAG_NAME

Constructor Summary

Constructors

Constructor and Description
RangeTableRowModel() Default range table row 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.
RangeTableColumnModel	getColumnByName(java.lang.String targetedName) Gets the column that has the specified name.
java.util.List<RangeTableColumnModel>	getColumns() Gets all the columns contained in the row.
java.math.BigDecimal	getUpperBound() Gets the upper bound of the row.
boolean	isUnbounded() Checks if this row is unbounded.
void	marshal(XMLOutputter output) Deprecated.
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.
void	setUnbounded() Sets this row as unbounded.
void	setUpperBound(java.math.BigDecimal upperBound) Sets the upper bound of the row.

Methods inherited from class java.lang.Object

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

Field Detail

RANGE_TABLE_COLUMN_TAG_NAME

public static final java.lang.String RANGE_TABLE_COLUMN_TAG_NAME

See Also:

Constant Field Values

UPPER_BOUND__TAG_NAME

public static final java.lang.String UPPER_BOUND__TAG_NAME

See Also:

Constant Field Values

Constructor Detail

RangeTableRowModel

public RangeTableRowModel()

Default range table row model.

Method Detail

getUpperBound

public java.math.BigDecimal getUpperBound()

Gets the upper bound of the row.

Returns:

The upper bound of the row

setUpperBound

public void setUpperBound(java.math.BigDecimal upperBound)

Sets the upper bound of the row.

Parameters:

upperBound - The upper bound of the row

isUnbounded

public boolean isUnbounded()

Checks if this row is unbounded.

Returns:

true if row is unbounded, false otherwise

setUnbounded

public void setUnbounded()

Sets this row as unbounded.

getColumns

public java.util.List<RangeTableColumnModel> getColumns()

Gets all the columns contained in the row.

Returns:

A list that contains all the column values of the row

getColumnByName

public RangeTableColumnModel getColumnByName(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)

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

@Deprecated
public void marshal(XMLOutputter output)

Deprecated.

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