Class LayoutMessage

java.lang.Object
cl.netswitch.lib.layout.LayoutMessage
All Implemented Interfaces:
Serializable, Cloneable
public class LayoutMessage extends Object implements Serializable, Cloneable
Text message formatted according to a Layout specification.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    LayoutMessage()
    Constructs a new LayoutMessage instance.
    LayoutMessage(Layout layout)
    Constructs a new LayoutMessage instance with layout.
    LayoutMessage(String text)
    Constructs a new LayoutMessage instance with text.
    LayoutMessage(String text, Layout layout)
    Constructs a new LayoutMessage instance with arguments.

  • Method Summary

    Modifier and Type
    Method
    Description
    LayoutMessage
    clone()
    Returns a "deep" copy of this LayoutMessage.
    final void
    copyFrom(LayoutMessage source)
    Copies all the properties of source into this LayoutMessage.
    final boolean
    exists(String fieldName)
    Returns true if the field indexed by fieldName exists in the Layout of this message.
    final Character
    getChar(String fieldName)
    Returns the character value of the field identified by fieldName.
    final Character
    getChar(String fieldName, int index)
    Returns the character value of the field identified by fieldName and index.
    final Date
    getDate(String fieldName)
    Returns the date value of the field identified by fieldName.
    final Date
    getDate(String fieldName, int index)
    Returns the date value of the field identified by fieldName and index.
    static boolean
    getDefaultSignANSI()
    Returns true if, by default, numeric fields are stored using the ANSI format.
    static boolean
    getDefaultStrict()
    Returns true if, by default, message editing is strict.
    final Double
    getDouble(String fieldName)
    Returns the double value of the field identified by fieldName.
    final Double
    getDouble(String fieldName, int index)
    Returns the double value of the field identified by fieldName and index.
    final LayoutField
    getField(String fieldName)
    Returns the field identified by fieldName.
    final Integer
    getInteger(String fieldName)
    Returns the integer value of the field identified by fieldName.
    final Integer
    getInteger(String fieldName, int index)
    Returns the integer value of the field identified by fieldName and index.
    final Layout
    getLayout()
    Returns the current layout of this message.
    final Long
    getLong(String fieldName)
    Returns the long value of the field identified by fieldName.
    final Long
    getLong(String fieldName, int index)
    Returns the long value of the field identified by fieldName and index.
    final BigDecimal
    getNumber(String fieldName)
    Returns the decimal value of the field identified by fieldName.
    final BigDecimal
    getNumber(String fieldName, int index)
    Returns the decimal value of the field identified by fieldName and index.
    final int
    getOccurs(String fieldName)
    Returns the number of occurrences of the field identified by fieldName.
    final String
    getSequence(String fieldName)
    Returns the unformatted character sequence of the field identified by fieldName.
    final String
    getSequence(String fieldName, int index)
    Returns the unformatted character sequence of the field identified by fieldName and index.
    final String
    getString(String fieldName)
    Returns the string value of the field identified by fieldName.
    final String
    getString(String fieldName, int index)
    Returns the string value of the field identified by fieldName and index.
    final String
    getText()
    Returns the text of this message.
    final String
    getTextTrim()
    Returns the text of this message with trailing space characters removed.
    final void
    initFields()
    Changes the value of each field of this message to its default value.
    final void
    initFields(LayoutMessage source)
    Changes the value of each field of this message to the value of its corresponding field in source.
    final boolean
    isNull(int start, int end)
    Returns true if a substring is NULL.
    final boolean
    isNull(String fieldName)
    Returns true if the value of the field identified by fieldName is NULL.
    final boolean
    isNull(String fieldName, int index)
    Returns true if the value of the field identified by fieldName and index is NULL.
    final boolean
    isSignANSI()
    Returns true if numeric fields are stored using the ANSI format.
    final boolean
    isStrict()
    Returns true if message editing is strict.
    final void
    replace(int start, int end, String value)
    Replaces a substring with the supplied string value.
    final void
    setChar(String fieldName, int index, Character value)
    Changes the character value of the field identified by fieldName and index.
    final void
    setChar(String fieldName, Character value)
    Changes the character value of the field identified by fieldName.
    final void
    setDate(String fieldName, int index, Date value)
    Changes the date value of the field identified by fieldName and index.
    final void
    setDate(String fieldName, Date value)
    Changes the date value of the field identified by fieldName.
    static void
    setDefaultSignANSI(boolean signANSI)
    Defines if, by default, numeric fields are stored using the ANSI format.
    static void
    setDefaultStrict(boolean strict)
    Defines if, by default, message editing is strict.
    final void
    setDouble(String fieldName, int index, Double value)
    Changes the double value of the field identified by fieldName and index.
    final void
    setDouble(String fieldName, Double value)
    Changes the double value of the field identified by fieldName.
    final void
    setInteger(String fieldName, int index, Integer value)
    Changes the integer value of the field identified by fieldName and index.
    final void
    setInteger(String fieldName, Integer value)
    Changes the integer value of the field identified by fieldName.
    final void
    setLayout(Layout layout)
    Changes the layout of this message.
    final void
    setLong(String fieldName, int index, Long value)
    Changes the long value of the field identified by fieldName and index.
    final void
    setLong(String fieldName, Long value)
    Changes the long value of the field identified by fieldName.
    final void
    setNull(String fieldName)
    Changes the value of the field identified by fieldName to NULL.
    final void
    setNull(String fieldName, int index)
    Changes the value of the field identified by fieldName and index to NULL.
    final void
    setNumber(String fieldName, int index, BigDecimal value)
    Changes the decimal value of the field identified by fieldName and index.
    final void
    setNumber(String fieldName, BigDecimal value)
    Changes the decimal value of the field identified by fieldName.
    final void
    setSequence(String fieldName, int index, String value)
    Changes the unformatted character sequence of the field identified by fieldName and index.
    final void
    setSequence(String fieldName, String value)
    Changes the unformatted character sequence of the field identified by fieldName.
    final void
    setSignANSI(boolean signANSI)
    Defines whether numeric fields are stored in this message using the ANSI format.
    final void
    setStrict(boolean strict)
    Defines whether message editing is strict.
    final void
    setString(String fieldName, int index, String value)
    Changes the string value of the field identified by fieldName and index.
    final void
    setString(String fieldName, String value)
    Changes the string value of the field identified by fieldName.
    final void
    setText(String text)
    Changes the text of this message.
    final String
    substring(int start, int end)
    Returns a substring that begins at the specified start index and extends to index end-1.
    final Message
    toMessage()
    Returns a Message with the text and layout name of this message.
    String
    toString()
    Returns a string representation of this message.
    final String
    toXml()
    Returns the XML string representation of the data stored in this message.
    final String
    toXml(boolean omitXmlDeclaration, String encoding, boolean indent, int indentAmount)
    Returns the XML string representation of the data stored in this message.
    final Layout
    verifyLayout(String layoutName)
    Verifies that the name of the layout of this message matches the supplied layoutName.

    Methods inherited from class Object

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

  • Constructor Details

    • LayoutMessage

      public LayoutMessage()
      Constructs a new LayoutMessage instance.

    • LayoutMessage

      public LayoutMessage(String text)
      Constructs a new LayoutMessage instance with text.
      Parameters:
      text - the initial text of the message.

    • LayoutMessage

      public LayoutMessage(Layout layout)
      Constructs a new LayoutMessage instance with layout.
      Parameters:
      layout - the initial layout of the message.

    • LayoutMessage

      public LayoutMessage(String text, Layout layout)
      Constructs a new LayoutMessage instance with arguments.
      Parameters:
      text - the initial text of the message.
      layout - the initial layout of the message.

  • Method Details

    • isStrict

      public final boolean isStrict()
      Returns true if message editing is strict. See method setStrict for further details.
      Returns:
      true if message editing is strict.
      See Also:

    • setStrict

      public final void setStrict(boolean strict)
      Defines whether message editing is strict. If message editing is strict, any attempt to assign an invalid field value generates (throws) an exception. If message editing is not strict, certain invalid field values are permitted as described in the following table:
       
      Invalid Field Value Action Taken
      RUT value with incorrect parity character The RUT value is stored as supplied
      Numeric value longer than the length of the field The numeric value is silently truncated on the left
      Text value longer than the length of the field The text value is silently truncated on the right
      Negative value applied to an unsigned numeric field The numeric value is stored ignoring its sign
      Parameters:
      strict - if true the message will be strict.

    • getDefaultStrict

      public static boolean getDefaultStrict()
      Returns true if, by default, message editing is strict. If message editing is strict, any attempt to assign an invalid field value generates (throws) an exception. If message editing is not strict, certain invalid field values are permitted.

      When a new message is created, it uses this global value to initialize its behavior. This default behavior can be changed on individual messages using the setStrict method.

      Returns:
      true if, by default, message editing is strict.
      See Also:

    • setDefaultStrict

      public static void setDefaultStrict(boolean strict)
      Defines if, by default, message editing is strict. If message editing is strict, any attempt to assign an invalid field value generates (throws) an exception. If message editing is not strict, certain invalid field values are permitted.

      When a new message is created, it uses this global value to initialize its behavior. This default behavior can be changed on individual messages using the setStrict method.

      Parameters:
      strict - if true message editing is strict.
      See Also:

    • isSignANSI

      public final boolean isSignANSI()
      Returns true if numeric fields are stored using the ANSI format. Otherwise, numeric fields are stored using the TANDEM format.
      Returns:
      true if numeric fields are stored using the ANSI format.

    • setSignANSI

      public final void setSignANSI(boolean signANSI)
      Defines whether numeric fields are stored in this message using the ANSI format. If signANSI is true, numeric fields will be stored using the ANSI format. Otherwise, numeric fields will be stored using the TANDEM format.

      Note: this method does not change the representation of the numeric fields that are currently stored in this message. It defines how numeric fields will be stored in future calls to the setNumber or the setString methods.

      Parameters:
      signANSI - if true numeric fields will be stored using the ANSI mechanism. Otherwise, the TANDEM mechanism will be used.

    • getDefaultSignANSI

      public static boolean getDefaultSignANSI()
      Returns true if, by default, numeric fields are stored using the ANSI format. Otherwise, numeric fields are stored using the TANDEM format.

      When a new message is created, it uses this global value to initialize its behavior. This default behavior can be changed on individual messages using the setSignANSI method.

      Returns:
      true if, by default, numeric fields are stored using the ANSI format. Otherwise, the TANDEM format is used.

    • setDefaultSignANSI

      public static void setDefaultSignANSI(boolean signANSI)
      Defines if, by default, numeric fields are stored using the ANSI format. If signANSI is true, numeric fields will be stored using the ANSI format. Otherwise, numeric fields will be stored using the TANDEM mechanism.

      When a new message is created, it uses this global value to initialize its behavior. This default behavior can be changed on individual messages using the setSignANSI method.

      Parameters:
      signANSI - if true numeric fields will be stored, by default, using the ANSI format. Otherwise, the TANDEM format will be used.

    • getText

      public final String getText()
      Returns the text of this message.
      Returns:
      the text of this message.

    • getTextTrim

      public final String getTextTrim()
      Returns the text of this message with trailing space characters removed.
      Returns:
      the text of this message with trailing space characters removed.

    • setText

      public final void setText(String text)
      Changes the text of this message.
      Parameters:
      text - the new text of this message (can be null).

    • isNull

      public final boolean isNull(int start, int end)
      Returns true if a substring is NULL. A substring is said to be NULL if it's first character is NO-DATA (0x1A). The substring begins at the specified start index and extends to index end-1.
      Parameters:
      start - the start index of the substring.
      end - the end index of the substring.
      Returns:
      true if the substring is NULL.

    • substring

      public final String substring(int start, int end)
      Returns a substring that begins at the specified start index and extends to index end-1. It returns null if the first character of the substring is NO-DATA (0x1A). The trailing space characters of the substring are removed (right trimmed).
      Parameters:
      start - the start index of the substring.
      end - the end index of the substring.
      Returns:
      the requiered substring or null.

    • replace

      public final void replace(int start, int end, String value)
      Replaces a substring with the supplied string value. The substring begins at the specified start index and extends to index end-1. If needed, the capacity of the editor buffer is extended so the entire value can be stored. If value is null, the substring is filled with character NO-DATA (0x1A). If value is shorter than the substring, the remaining space is filled with spaces.
      Parameters:
      start - the start index of the substring.
      end - the end index of the substring.
      value - the replacement value (can be null).

    • getLayout

      public final Layout getLayout()
      Returns the current layout of this message. It returns null if the message has no defined layout.
      Returns:
      the layout of this message or null.

    • setLayout

      public final void setLayout(Layout layout)
      Changes the layout of this message. If layout is null, the message will have no defined layout.
      Parameters:
      layout - new layout of this message (can be null).

    • verifyLayout

      public final Layout verifyLayout(String layoutName)
      Verifies that the name of the layout of this message matches the supplied layoutName. This method throws IllegalArgumentException if this message has no defined layout, or if the layout names do not match.

      This convenience method is normally used in the implementation of methods that process transaction requests whose data must be sent from a client application with a particular structure (or layout).

      Parameters:
      layoutName - the name of the required layout.
      Returns:
      the verified layout of this message (never null).
      Throws:
      NullPointerException - if layoutName is null.
      IllegalArgumentException - if the layout names do not match.

    • initFields

      public final void initFields()
      Changes the value of each field of this message to its default value. The default value of a layout field is obtained using the getDefault method. If this message has no defined layout, nothing happens.

    • initFields

      public final void initFields(LayoutMessage source)
      Changes the value of each field of this message to the value of its corresponding field in source. Two fields are said to correspond if they have the same name and type. If a field has no corresponding field in source, then its value is set to its default value. If source is null or if source has no defined layout, then this methods operates as the initFields() method. If this message has no defined layout, nothing happens.
      Parameters:
      source - the message with corresponding fields (can be null).

    • getField

      public final LayoutField getField(String fieldName)
      Returns the field identified by fieldName. It returns null if this message does not have a defined layout, or if the field is not defined in the layout.
      Parameters:
      fieldName - name of the layout field.
      Returns:
      the field identified by fieldName or null.
      Throws:
      NullPointerException - if fieldName is null.

    • exists

      public final boolean exists(String fieldName)
      Returns true if the field indexed by fieldName exists in the Layout of this message. If returns false if this message does not have a defined layout, or if the field is not defined in the layout.
      Parameters:
      fieldName - the name of the layout field.
      Returns:
      true if the field is defined.
      Throws:
      NullPointerException - if fieldName is null.

    • getOccurs

      public final int getOccurs(String fieldName)
      Returns the number of occurrences of the field identified by fieldName.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the number of occurrences of the specified field.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • isNull

      public final boolean isNull(String fieldName)
      Returns true if the value of the field identified by fieldName is NULL. The value of a field is said to be NULL if the first character of it's sequence is NO-DATA (0x1A).
      Parameters:
      fieldName - name of the required field.
      Returns:
      true if the specified field is NULL.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • isNull

      public final boolean isNull(String fieldName, int index)
      Returns true if the value of the field identified by fieldName and index is NULL. The value of a field is said to be NULL if the first character of it's sequence is NO-DATA (0x1A).
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      true if the specified field is NULL.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setNull

      public final void setNull(String fieldName)
      Changes the value of the field identified by fieldName to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setNull

      public final void setNull(String fieldName, int index)
      Changes the value of the field identified by fieldName and index to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getSequence

      public final String getSequence(String fieldName)
      Returns the unformatted character sequence of the field identified by fieldName. It returns null if this sequence starts with character NO-DATA (0x1A). The trailing space characters of the returned string are removed (right trim).
      Parameters:
      fieldName - name of the required field.
      Returns:
      the character sequence of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getSequence

      public final String getSequence(String fieldName, int index)
      Returns the unformatted character sequence of the field identified by fieldName and index. It returns null if this sequence starts with character NO-DATA (0x1A). The trailing space characters of the returned string are removed (right trim).
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the character sequence of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setSequence

      public final void setSequence(String fieldName, String value)
      Changes the unformatted character sequence of the field identified by fieldName. If value is null, the sequence is filled with character NO-DATA (0x1A).
      Parameters:
      fieldName - name of the required field.
      value - the new character sequence of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setSequence

      public final void setSequence(String fieldName, int index, String value)
      Changes the unformatted character sequence of the field identified by fieldName and index. If value is null, the sequence is filled with character NO-DATA (0x1A).
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new character sequence of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getString

      public final String getString(String fieldName)
      Returns the string value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the string value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getString

      public final String getString(String fieldName, int index)
      Returns the string value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.

      If the field is a FieldType.LIST and index is -1, it returns a string containing all the occurrences of the list.

      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the string value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setString

      public final void setString(String fieldName, String value)
      Changes the string value of the field identified by fieldName. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new string value of the field (can be null)..
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setString

      public final void setString(String fieldName, int index, String value)
      Changes the string value of the field identified by fieldName and index. If value is null then the value of the field is set to NULL. See isNull for explanation of NULL value.

      If the field is a FieldType.LIST and index is -1, the string containing all the occurrences of this list field is updated with the supplied value.

      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new string value of the field (can be null)..
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getChar

      public final Character getChar(String fieldName)
      Returns the character value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the character value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getChar

      public final Character getChar(String fieldName, int index)
      Returns the character value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the character value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setChar

      public final void setChar(String fieldName, Character value)
      Changes the character value of the field identified by fieldName. If value is null the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new character value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setChar

      public final void setChar(String fieldName, int index, Character value)
      Changes the character value of the field identified by fieldName and index. If value is null the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new character value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getNumber

      public final BigDecimal getNumber(String fieldName)
      Returns the decimal value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the decimal value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getNumber

      public final BigDecimal getNumber(String fieldName, int index)
      Returns the decimal value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the decimal value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setNumber

      public final void setNumber(String fieldName, BigDecimal value)
      Changes the decimal value of the field identified by fieldName. If value is null the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new decimal value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setNumber

      public final void setNumber(String fieldName, int index, BigDecimal value)
      Changes the decimal value of the field identified by fieldName and index. If value is null then the field's data is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new decimal value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getDouble

      public final Double getDouble(String fieldName)
      Returns the double value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the double value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getDouble

      public final Double getDouble(String fieldName, int index)
      Returns the double value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the double value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setDouble

      public final void setDouble(String fieldName, Double value)
      Changes the double value of the field identified by fieldName. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new double value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setDouble

      public final void setDouble(String fieldName, int index, Double value)
      Changes the double value of the field identified by fieldName and index. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new double value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getInteger

      public final Integer getInteger(String fieldName)
      Returns the integer value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the integer value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getInteger

      public final Integer getInteger(String fieldName, int index)
      Returns the integer value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the integer value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setInteger

      public final void setInteger(String fieldName, Integer value)
      Changes the integer value of the field identified by fieldName. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new integer value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setInteger

      public final void setInteger(String fieldName, int index, Integer value)
      Changes the integer value of the field identified by fieldName and index. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new integer value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getLong

      public final Long getLong(String fieldName)
      Returns the long value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the long value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getLong

      public final Long getLong(String fieldName, int index)
      Returns the long value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the long value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setLong

      public final void setLong(String fieldName, Long value)
      Changes the long value of the field identified by fieldName. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new long value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setLong

      public final void setLong(String fieldName, int index, Long value)
      Changes the long value of the field identified by fieldName and index. If value is null, the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new long value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • getDate

      public final Date getDate(String fieldName)
      Returns the date value of the field identified by fieldName. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      Returns:
      the date value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • getDate

      public final Date getDate(String fieldName, int index)
      Returns the date value of the field identified by fieldName and index. It returns null if the value of the field is NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      Returns:
      the date value of the specified field or null.
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • setDate

      public final void setDate(String fieldName, Date value)
      Changes the date value of the field identified by fieldName. If value is null the value of the field is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      value - the new date value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.

    • setDate

      public final void setDate(String fieldName, int index, Date value)
      Changes the date value of the field identified by fieldName and index. If value is null then the field's data is set to NULL. See isNull for explanation of NULL value.
      Parameters:
      fieldName - name of the required field.
      index - index of the required field occurrence.
      value - the new date value of the field (can be null).
      Throws:
      NullPointerException - if fieldName is null.
      IllegalStateException - if no layout is defined.
      IllegalArgumentException - if the field does not exist.
      IndexOutOfBoundsException - if index is out-of-bounds.

    • toXml

      public final String toXml(boolean omitXmlDeclaration, String encoding, boolean indent, int indentAmount)
      Returns the XML string representation of the data stored in this message. If omitXmlDeclaration is true, the XML declaration header is not included. The encoding argument specifies the character encoding included in the XML declaration header (for example "UTF-8" or "ISO-8859-1"). If indent is true, the resulting XML will have whitespace included to indent the tree. The indentation amount is specified with indentAmount.

      Consider, for example, a layout named CONTACT with four fields called SERVICE, GROUP, USERNAME and USERCODE. The string returned by this method for a message with layout CONTACT would be smae as the following indented XML tree, except for the values of the fields which are shown in italics: 

      <CONTACT>
    <SERVICE>service</SERVICE>
    <GROUP>group</GROUP>
    <USERNAME>user</USERNAME>
    <USERCODE>12345</USERCODE>
</CONTACT>
      Parameters:
      omitXmlDeclaration - specifies whether to omit the XML declaration.
      encoding - the character encoding included in the XML declaration.
      indent - specifies whether to indent the XML representation.
      indentAmount - specifies the indentation amount.
      Returns:
      the XML representation of the data stored in this message.
      Throws:
      NullPointerException - if encoding is null.
      IllegalArgumentException - if indentAmount is negative.

    • toXml

      public final String toXml()
      Returns the XML string representation of the data stored in this message.

      This method has the same effect as calling toXml(true, "UTF-8", false, 0).

      Returns:
      the XML representation of the data stored in this message.

    • toString

      public String toString()
      Returns a string representation of this message.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this message.

    • copyFrom

      public final void copyFrom(LayoutMessage source)
      Copies all the properties of source into this LayoutMessage. The values of all properties in this LayoutMessage are replaced by copies of the values of corresponding source properties.
      Parameters:
      source - the source LayoutMessage to be copied.
      Throws:
      NullPointerException - if source is null.

    • clone

      public LayoutMessage clone()
      Returns a "deep" copy of this LayoutMessage.
      Overrides:
      clone in class Object
      Returns:
      a "deep" copy of this LayoutMessage.

    • toMessage

      public final Message toMessage()
      Returns a Message with the text and layout name of this message.
      Returns:
      a Message with the text and layout name of this message.