com.highdeal.mappingtable.hci
Class MappingTableClassModel

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.mappingtable.hci.MappingTableClassModel

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMapping, XMLMarshallable, ICatalogObject

public class MappingTableClassModel
extends HCIModelAdapter
implements XMLMapping, ICatalogObject

This Java class represents a mapping table class that defines the scheme of mapping tables and subscriber mapping tables in master data.

It defines the structure of a mapping table, with the number and the type of input columns and the number and type of output columns.
This class is then referenced by the MappingTableModel to instantiate them (or in a SubscriberMappingTableModel).

Implementation Note

This product documentation describes the technical vision of the functional or business concepts (and objects).

Refer to the SAP CC Library (Application Help) for more information about the functional concept:

• mapping table classes in master data (pricing catalog of the service provider)

Related Operations

• CreateMappingTableClassOp
• SearchMappingTableClassOp
• DeleteMappingTableClassOp

See Also:

MappingTableModel, SubscriberMappingTableModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="mappingTableClass">
 	<xs:complexType>
 		<xs:sequence>
          <xs:element name="additionalInfo" type="AdditionalInfoType" minOccurs="0" maxOccurs="unbounded" />
 			<xs:element ref="inColumn" minOccurs="0" maxOccurs="unbounded"/>
 			<xs:element ref="outColumn" minOccurs="0" maxOccurs="unbounded"/>
 		</xs:sequence>
		<xs:attribute name="id" type="xs:string" />
 		<xs:attribute name="description" type="xs:string" />
 		<xs:attribute name="owner" type="xs:string" />
 	</xs:complexType>
 </xs:element>

Field Summary

static int	MAX_IN_COLUMN The maximum number of input columns: 4
static int	MAX_OUT_COLUMN The maximum number of output columns: 15
static java.lang.String	TAG_NAME The XML tag name of this data model: "mappingTableClass"

Constructor Summary

MappingTableClassModel()
Default mapping table class constructor.

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.
java.util.List<AdditionalInfoModel>	getAdditionalInfoList() Gets the list of information dedicated to external system.
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.
java.lang.String	getDescription() Gets the comprehensive description of the mapping table class.
java.lang.String	getId() Gets the mapping table identifier.
java.util.List<MappingTableClassInColumnModel>	getInColumns() Gets the definition of the input columns of the mapping table class.
java.util.List<MappingTableClassOutColumnModel>	getOutColumns() Gets the definition of the output columns of the mapping table class.
java.lang.String	getOwner() Gets the owner of the mapping table class.
java.lang.String	getTagName() Gets the XML tag of this 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.
void	setDescription(java.lang.String description) Sets the comprehensive description of the mapping table class.
void	setId(java.lang.String id) Sets the identifier of the mapping table class.
void	setOwner(java.lang.String owner) Sets the owner of the mapping table class.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Field Detail

MAX_IN_COLUMN

public static final int MAX_IN_COLUMN

The maximum number of input columns: 4

See Also:

Constant Field Values

MAX_OUT_COLUMN

public static final int MAX_OUT_COLUMN

The maximum number of output columns: 15

See Also:

Constant Field Values

TAG_NAME

public static final java.lang.String TAG_NAME

The XML tag name of this data model: "mappingTableClass"

See Also:

Constant Field Values

Constructor Detail

MappingTableClassModel

public MappingTableClassModel()

Default mapping table class constructor.

Method Detail

getId

public java.lang.String getId()

Gets the mapping table identifier.

Returns:

A string that contains the identifier of the mapping table class

setId

public void setId(java.lang.String id)

Sets the identifier of the mapping table class.

Parameters:

id - The identifier to set to this mapping table class

getDescription

public java.lang.String getDescription()

Gets the comprehensive description of the mapping table class.

Returns:

A string that contains the text description of the mapping table class

setDescription

public void setDescription(java.lang.String description)

Sets the comprehensive description of the mapping table class.

Parameters:

description - The description to set to this mapping table class

getOwner

public java.lang.String getOwner()

Gets the owner of the mapping table class.

Specified by:

getOwner in interface ICatalogObject

Returns:

A string that contains the owner of the mapping table class

setOwner

public void setOwner(java.lang.String owner)

Sets the owner of the mapping table class.

Parameters:

owner - The owner to set to this mapping table class

getInColumns

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

Gets the definition of the input columns of the mapping table class.

Returns:

A list that contains all the input columns

getOutColumns

public java.util.List<MappingTableClassOutColumnModel> getOutColumns()

Gets the definition of the output columns of the mapping table class.

Returns:

A list that contains all the output columns

getAdditionalInfoList

public java.util.List<AdditionalInfoModel> getAdditionalInfoList()

Gets the list of information dedicated to external system. The designer of the mapping table adds information allowing an external system to search its specifics mapping table. An additional information is a property defined by its name and its value.

Returns:

The list of information dedicated to external system

getTagName

public java.lang.String getTagName()

Gets the XML tag of this HCI model.

Specified by:

getTagName in interface ITagNameProvider

Returns:

A string containing the XML tag of mapping table model

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

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

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

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

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