Package cl.obcom.desktopfx.layout
Class LayoutField
java.lang.Object
cl.obcom.desktopfx.layout.LayoutField
- All Implemented Interfaces:
Serializable
Data item whose value can be edited with a
LayoutMessage
. A
LayoutField
has a type
, a name, a length, a numeric scale
and a default value. The values of these properties have restrictions
depending on the type of the field. See FieldType
for details about
these restrictions.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionfinal Character
getChar
(LayoutMessage message, int index) Returns the first character of the string value of theindex
occurence of this field inmessage
.final Character
getChar
(LayoutMessage message, int index, boolean strict) Returns the first character of the string value of theindex
occurence of this field inmessage
.final Date
getDate
(LayoutMessage message, int index) Returns the date value of theindex
occurence of this field inmessage
.getDate
(LayoutMessage message, int index, boolean strict) Returns the date value of theindex
occurence of this field inmessage
.Returns the default value of this field.final String
Returns the defined default value of this field.final Double
getDouble
(LayoutMessage message, int index) Returns the double value of theindex
occurence of this field inmessage
.final Double
getDouble
(LayoutMessage message, int index, boolean strict) Returns the double value of theindex
occurence of this field inmessage
.int
Returns the length of the formatted values of this field.final Integer
getInteger
(LayoutMessage message, int index) Returns the integer value of theindex
occurence of this field inmessage
.final Integer
getInteger
(LayoutMessage message, int index, boolean strict) Returns the integer value of theindex
occurence of this field inmessage
.final Layout
Returns the layout of this field ornull
if undefined.final int
Returns the length of each occurrence of this field.final Locale
Returns the locale of this field.final Long
getLong
(LayoutMessage message, int index) Returns the long value of theindex
occurence of this field inmessage
.final Long
getLong
(LayoutMessage message, int index, boolean strict) Returns the long value of theindex
occurence of this field inmessage
.final String
getName()
Returns the name of this field.final BigDecimal
getNumber
(LayoutMessage message, int index) Returns the decimal value of theindex
occurence of this field inmessage
.getNumber
(LayoutMessage message, int index, boolean strict) Returns the decimal value of theindex
occurence of this field inmessage
.final int
Returns the number of occurrences of this field.final int
getOffset
(int index) Returns the offset position of theindex
occurence of this field in a message or it's parent list.final LayoutField
Returns the list field that contains this field.final int
getScale()
Returns the numeric scale of this field.final String
getString
(LayoutMessage message, int index) Returns the string value of theindex
occurence of this field inmessage
.getString
(LayoutMessage message, int index, boolean strict) Returns the string value of theindex
occurence of this field inmessage
.final String
getSubstring
(LayoutMessage message, int index) Returns a substring of theindex
occurence of this field inmessage
.final String
getSubstring
(LayoutMessage message, int index, boolean rtrim, boolean nodata) Returns a substring of theindex
occurence of this field inmessage
.final FieldType
getType()
Returns the type of this field.final Object
getValue
(LayoutMessage message, int index) Returns the object value of theindex
occurence of this field inmessage
.getValue
(LayoutMessage message, int index, boolean strict) Returns the object value of theindex
occurence of this field inmessage
.final boolean
Returnstrue
if numbers are formatted using group separators.final boolean
isNull
(LayoutMessage message, int index) Returnstrue
if the value of theindex
occurence of this field inmessage
is NULL.final void
setChar
(LayoutMessage message, int index, Character value) Changes the character value of theindex
occurence of this field inmessage
.final void
setChar
(LayoutMessage message, int index, Character value, boolean strict) Changes the character value of theindex
occurence of this field inmessage
.final void
setDate
(LayoutMessage message, int index, Date date) Changes the date value of theindex
occurence of this field inmessage
.void
setDate
(LayoutMessage message, int index, Date date, boolean strict) Changes the date value of theindex
occurence of this field inmessage
.void
setDefault
(LayoutMessage message, int index) Changes the value of theindex
occurence of this field inmessage
to its default value.final void
setDouble
(LayoutMessage message, int index, Double value) Changes the double value of theindex
occurence of this field inmessage
.final void
setDouble
(LayoutMessage message, int index, Double value, boolean strict) Changes the double value of theindex
occurence of this field inmessage
.void
setGroupingUsed
(boolean groupingUsed) Changes whether numbers are formatted using group separators.final void
setInteger
(LayoutMessage message, int index, Integer value) Changes the integer value of theindex
occurence of this field inmessage
.final void
setInteger
(LayoutMessage message, int index, Integer value, boolean strict) Changes the integer value of theindex
occurence of this field inmessage
.void
Changes the locale of this field.final void
setLong
(LayoutMessage message, int index, Long value) Changes the long value of theindex
occurence of this field inmessage
.final void
setLong
(LayoutMessage message, int index, Long value, boolean strict) Changes the long value of theindex
occurence of this field inmessage
.void
setNull
(LayoutMessage message, int index) Changes the value of theindex
occurence of this field inmessage
to NULL.final void
setNumber
(LayoutMessage message, int index, BigDecimal value) Changes the decimal value of theindex
occurence of this field inmessage
.void
setNumber
(LayoutMessage message, int index, BigDecimal value, boolean strict) Changes the decimal value of theindex
occurence of this field inmessage
.final void
setString
(LayoutMessage message, int index, String value) Changes the string value of theindex
occurence of this field inmessage
.void
setString
(LayoutMessage message, int index, String value, boolean strict) Changes the string value of theindex
occurence of this field inmessage
.final void
setSubstring
(LayoutMessage message, int index, String value) Replaces a substring of theindex
occurence of this field inmessage
.final void
setSubstring
(LayoutMessage message, int index, String value, boolean strict) Replaces a substring of theindex
occurence of this field inmessage
.final void
setValue
(LayoutMessage message, int index, Object value) Changes the object value of theindex
occurence of this field inmessage
.void
setValue
(LayoutMessage message, int index, Object value, boolean strict) Changes the object value of theindex
occurence of this field inmessage
.
-
Method Details
-
getType
Returns the type of this field.- Returns:
- the type of this field.
-
getLayout
Returns the layout of this field ornull
if undefined.- Returns:
- the layout of this field or
null
if undefined.
-
getName
Returns the name of this field.- Returns:
- the name of this field.
-
getLength
public final int getLength()Returns the length of each occurrence of this field.- Returns:
- the length of each occurrence of this field.
-
getScale
public final int getScale()Returns the numeric scale of this field.- Returns:
- the numeric scale of this field.
-
getOccurs
public final int getOccurs()Returns the number of occurrences of this field.- Returns:
- the number of occurrences of this field.
-
getFormattedLength
public int getFormattedLength()Returns the length of the formatted values of this field.- Returns:
- the length of the formatted values of this field.
-
getLocale
Returns the locale of this field. This locale is used by fields that are locale-sensitive (such as numeric fields) when they are converted to/from strings. Initially, a field uses the default JVM locale.- Returns:
- the locale of this field or
null
for default locale.
-
setLocale
Changes the locale of this field. This locale is used by fields that are locale-sensitive (such as numeric fields) when they are converted to/from strings. If suppliedlocale
isnull
, the default JVM locale is used.- Parameters:
locale
- the new layout locale (can be null).
-
isGroupingUsed
public final boolean isGroupingUsed()Returnstrue
if numbers are formatted using group separators.- Returns:
true
if numbers are formatted using group separators.
-
setGroupingUsed
public void setGroupingUsed(boolean groupingUsed) Changes whether numbers are formatted using group separators.- Parameters:
groupingUsed
- the new value of this property.
-
getDefinedDefault
Returns the defined default value of this field. If the field does not have a defined default value, it returnsnull
.- Returns:
- the default value of this field or
null
if the field does not have a defined default value.
-
getDefault
Returns the default value of this field. If the field does not have a defined default value, it returns the default value associatted with itstype
. This method never returnsnull
.- Returns:
- the default value of this field or the default value associatted
with its
type
.
-
setDefault
Changes the value of theindex
occurence of this field inmessage
to its default value. If the field's default value is invalid, then the type's default value is used.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.
-
getParent
Returns the list field that contains this field. If this field does not belong to a list, it returnsnull
. Fields of typeFieldType.LIST
always returnnull
because list fields cannot be defined (contained) within other lists.- Returns:
- the list field that contains this field or
null
.
-
getOffset
public final int getOffset(int index) Returns the offset position of theindex
occurence of this field in a message or it's parent list.- Parameters:
index
- the occurence index of the field.- Returns:
- the offset position of this field in a message or parent list.
- Throws:
IndexOutOfBoundsException
- ifindex
is out-of-bounds.
-
isNull
Returnstrue
if the value of theindex
occurence of this field inmessage
is NULL. The value is NULL if the first character of it's substring isNO-DATA
(0x1A). The substring begins atgetOffset
with a length given bygetLength()
- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
true
if the value of this field is NULL.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.
-
setNull
Changes the value of theindex
occurence of this field inmessage
to NULL. The value is set to NULL by replacing all characters of it's substring withNO-DATA
(0x1A).- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.
-
getSubstring
Returns a substring of theindex
occurence of this field inmessage
. The substring begins atgetOffset
with a length given bygetLength()
. Trailing spaces are removed. It returnsnull
if the first character of the substring isNO-DATA
(0x1A).- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the requiered substring or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.
-
getSubstring
Returns a substring of theindex
occurence of this field inmessage
. The substring begins atgetOffset
with a length given bygetLength()
. Ifrtrim
istrue
, trailing spaces are removed. It returnsnull
ifnodata
istrue
and the first character of the substring isNO-DATA
(0x1A). Ifnodata
isfalse
, the returned substring includesNO-DATA
(0x1A) characters.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.rtrim
- iftrue
remove trailing spaces.nodata
- iftrue
check for NO-DATA.- Returns:
- the requiered substring or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.
-
setSubstring
Replaces a substring of theindex
occurence of this field inmessage
. The substring begins atgetOffset(int)
method with a length given bygetLength()
. Ifvalue
isnull
, the substring is filled withNO-DATA
(0x1A) characters. Ifvalue
is shorter than the substring, the remaining space is filled with spaces. Ifvalue
is too long, it is truncated.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new character sequence of this field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.IllegalArgumentException
- if strict andvalue
is too long.
-
setSubstring
Replaces a substring of theindex
occurence of this field inmessage
. The substring begins atgetOffset(int)
method with a length given bygetLength()
. Ifvalue
isnull
, the substring is filled withNO-DATA
(0x1A) characters. Ifvalue
is shorter than the substring, the remaining space is filled with spaces. Ifvalue
is too long, it is truncated, unlessstrict
istrue
, in which case an exception is thrown.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new character sequence of this field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.IllegalArgumentException
- if strict andvalue
is too long.
-
getString
Returns the string value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the string value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.
-
getString
Returns the string value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the string value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.
-
setString
Changes the string value of theindex
occurence of this field inmessage
. The suppliedvalue
is formatted according to the type of this field, and the resulting text is stored inmessage
. Ifvalue
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the string representation of the field value.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- ifvalue
has an invalid format.
-
setString
Changes the string value of theindex
occurence of this field inmessage
. The suppliedvalue
is formatted according to the type of this field, and the resulting text is stored inmessage
. Ifvalue
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the string representation of the field value.strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- ifvalue
has an invalid format.
-
getChar
Returns the first character of the string value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the character value of the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.
-
getChar
Returns the first character of the string value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the character value of the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.
-
setChar
Changes the character value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new character value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- ifvalue
has an invalid format.
-
setChar
Changes the character value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new character value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- ifvalue
has an invalid format.
-
getNumber
Returns the decimal value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isNUMERIC
orSIGNED
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the decimal value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getNumber
Returns the decimal value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isNUMERIC
orSIGNED
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the decimal value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setNumber
Changes the decimal value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isNUMERIC
orSIGNED
. Ifdecimal
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- decimal value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setNumber
Changes the decimal value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isNUMERIC
orSIGNED
. Ifdecimal
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- decimal value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getDouble
Returns the double value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the double value of the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getDouble
Returns the double value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the double value of the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setDouble
Changes the double value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new double value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setDouble
Changes the double value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new double value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getInteger
Returns the integer value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the integer value of the the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getInteger
Returns the integer value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the integer value of the the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setInteger
Changes the integer value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new integer value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setInteger
Changes the integer value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new integer value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getLong
Returns the long value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the long value of the the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getLong
Returns the long value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the long value of the the field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setLong
Changes the long value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new long value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
setLong
Changes the long value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new long value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notNUMERIC
orSIGNED
.
-
getDate
Returns the date value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isDATE
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the date value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notDATE
.
-
getDate
Returns the date value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isDATE
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the date value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.UnsupportedOperationException
- if the type of this field is notDATE
.
-
setDate
Changes the date value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isDATE
. Ifdate
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.date
- the new date value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notDATE
.
-
setDate
Changes the date value of theindex
occurence of this field inmessage
. This method can only be used if the type of this field isDATE
. Ifdate
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.date
- the new date value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.UnsupportedOperationException
- if the type of this field is notDATE
.
-
getValue
Returns the object value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.- Returns:
- the object value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.
-
getValue
Returns the object value of theindex
occurence of this field inmessage
. It returnsnull
if the value of the field is NULL. Ifstrict
istrue
an exception is thrown ifmessage
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.strict
- iftrue
throws an exception if message is invalid.- Returns:
- the object value of this field or
null
. - Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if the field record data is invalid.
-
setValue
Changes the object value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new object value of the field (can be null).- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if suppliedvalue
is invalid.
-
setValue
Changes the object value of theindex
occurence of this field inmessage
. Ifvalue
isnull
, the value of the field is set to NULL. Ifstrict
istrue
an exception is thrown ifvalue
is invalid.- Parameters:
message
- the layout message editor.index
- the occurence index of the field.value
- the new object value of the field (can be null).strict
- iftrue
throws an exception if value is invalid.- Throws:
NullPointerException
- ifmessage
isnull
.IndexOutOfBoundsException
- ifindex
is out-of-bounds.ValueFormatException
- if suppliedvalue
is invalid.
-