Package com.highdeal.pnr.hci

Class TranslationTableModel

java.lang.Object
com.highdeal.pnr.hci.TranslationTableModel
All Implemented Interfaces:
ITagNameProvider, XMLMarshallable, ICatalogObject
public class TranslationTableModel extends Object implements XMLMarshallable, ICatalogObject, ITagNameProvider
This Java class represents a translation table as seen when it comes from the back-end database system.

The order of the rows in a translation table is very important and determines the output result when searching in the translation table using any of the following criteria: STARTS_WITH, ENDS_WITH, or CONTAINS or IS_CONTAINED. Ensure that any table that you create or modify are sorted in the correct order.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="translationTable">
   <xs:complexType>
    <xs:sequence>
     <xs:element ref="inAttribute" minOccurs="0" maxOccurs="5"/>
     <xs:element ref="outAttribute" minOccurs="0" maxOccurs="15"/>
     <xs:element ref="tableInstance" minOccurs="0" maxOccurs="1"/>
     <xs:element ref="tableInstanceChronology" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="owner" type="xs:string" use="required"/>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="reference" type="xs:string"/>
     <xs:attribute name="useDates" type="xs:boolean" default="false" />
     <xs:attribute name="disallowDuplicateInputs" type="xs:boolean" default="false" />
   </xs:complexType>
 </xs:element>
 <xs:element name="tableInstanceChronology">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="chronology" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The value of that constant is the XML tag name of the Translation Table.
      See Also:

    • EQUALS

      public static final int EQUALS
      Equality comparison operator.
      See Also:

    • STARTS_WITH

      public static final int STARTS_WITH
      Starts with comparison operator.
      See Also:

    • ENDS_WITH

      public static final int ENDS_WITH
      Ends with comparison operator.
      See Also:

    • CONTAINS

      public static final int CONTAINS
      Contains comparison operator.
      See Also:

    • IS_CONTAINED

      public static final int IS_CONTAINED
      Is_contained comparison operator.
      See Also:

    • MAX_OUT_ATTRIBUTES

      public static final int MAX_OUT_ATTRIBUTES
      The maximum output attribute count.
      See Also:

    • MAX_IN_ATTRIBUTES

      public static final int MAX_IN_ATTRIBUTES
      The maximum input attribute count.
      See Also:

  • Constructor Details

    • TranslationTableModel

      public TranslationTableModel()
      Builds an empty TranslationTableModel.

    • TranslationTableModel

      public TranslationTableModel(String code, String description)
      Builds a TranslationTableModel from a code and a description.
      Parameters:
      code - The code
      description - The description

  • Method Details

    • getReference

      public String getReference()
      Gets the reference.
      Returns:
      The reference

    • setReference

      public void setReference(String r)
      Sets the reference.
      Parameters:
      r - The reference

    • getInstance

      public TranslationInstanceModel getInstance()
      Gets the instance.
      Returns:
      The instance

    • setInstance

      public void setInstance(TranslationInstanceModel i)
      Sets the instance.
      Parameters:
      i - The instance

    • getCode

      public String getCode()
      Gets the code.
      Returns:
      The code

    • setCode

      public void setCode(String c)
      Sets the code.
      Parameters:
      c - The code

    • getDescription

      public String getDescription()
      Gets the description.
      Returns:
      The description

    • setDescription

      public void setDescription(String d)
      Sets the description.
      Parameters:
      d - The description

    • setInAttributes

      public void setInAttributes(Vector<InAttributeModel> inAttributes)
      Sets the in attributes.
      Parameters:
      inAttributes - A vector of InAttributeModel representing the in attributes

    • getInAttributes

      public Vector<InAttributeModel> getInAttributes()
      Gets the in attributes.
      Returns:
      A vector of InAttributeModel representing the in attributes

    • setOutAttributes

      public void setOutAttributes(Vector<OutAttributeModel> outAttributes)
      Sets the out attributes.
      Parameters:
      outAttributes - A vector of OutAttributeModel representing the out attributes

    • getOutAttributes

      public Vector<OutAttributeModel> getOutAttributes()
      Gets the out attributes.
      Returns:
      A vector of OutAttributeModel representing the out attributes

    • addInAttribute

      public void addInAttribute(InAttributeModel attribute)
      Adds an in attribute.
      Parameters:
      attribute - The in attribute to add

    • removeInAttribute

      public void removeInAttribute(int index)
      Removes an in attribute.
      Parameters:
      index - The index of the in attribute to remove

    • addOutAttribute

      public void addOutAttribute(OutAttributeModel attribute)
      Adds an out attribute.
      Parameters:
      attribute - The out attribute to add

    • removeOutAttribute

      public void removeOutAttribute(int index)
      Removes an out attribute.
      Parameters:
      index - The index of the out attribute to remove

    • getOwner

      public String getOwner()
      Gets the owner.
      Specified by:
      getOwner in interface ICatalogObject
      Returns:
      The owner

    • setOwner

      public void setOwner(String p)
      Sets the owner.
      Parameters:
      p - The owner

    • getInstanceChronology

      public ChronologyModel getInstanceChronology()
      Gets the instance chronology.
      Returns:
      A instance chronology with TranslationInstanceModel elements

    • getUseDates

      public boolean getUseDates()
      Returns true if the translation table uses validity dates, false otherwise.
      Returns:
      true if the translation table uses validity dates, false otherwise

    • setUseDates

      public void setUseDates(boolean use)
      Sets whether the translation table use validity dates.
      Parameters:
      use - true if the translation table use validity dates, false otherwise

    • getDisallowDuplicateInputs

      public boolean getDisallowDuplicateInputs()
      Returns true if the translation table disallows duplicate input attributes.

      Duplicate input attributes exist when two rows, which are valid during a common period of time, have same input attributes.

      When duplicate input attributes are not allowed, then an exception is thrown by translation table creation or modification operations if such duplicate exists in the passed translation table.

      Returns:
      true if the translation table disallows duplicate input attributes

    • setDisallowDuplicateInputs

      public void setDisallowDuplicateInputs(boolean disallow)
      Sets whether the translation table disallows duplicate input attributes.
      Parameters:
      disallow - Indicates whether the translation table must disallow duplicate input attributes
      See Also:

    • checkValidity

      public boolean checkValidity()
      Returns true if the translation table is valid.
      Returns:
      true if the translation table is valid, false otherwise

    • getDuplicateInputsMap

      public HashMap<Integer,Integer> getDuplicateInputsMap()
      Returns a map which keys and values are rows indexes. Each key refers to a row which has duplicate input attributes with respect to the row refered by the corresponding value.
      Returns:
      A map of row indexes
      See Also:

    • getTagName

      public String getTagName()
      Description copied from interface: ITagNameProvider
      Gets the XML tag name of the HCI model.
      Specified by:
      getTagName in interface ITagNameProvider
      Returns:
      The XML tag name

    • 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(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(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