com.prowidesoftware.swift.model.field
Class Field98E

java.lang.Object
  com.prowidesoftware.swift.model.field.Field
      com.prowidesoftware.swift.model.field.Field98E

All Implemented Interfaces:

DateContainer, GenericField, PatternContainer, java.io.Serializable

public class Field98E
extends Field
implements java.io.Serializable, DateContainer, GenericField

Field 98E

validation pattern: :4!c//[,3n][/[N]]
parser pattern: :S//[,S][/[c]]
components pattern: SDTNCW

Components Data types

• component1: String
• component2: Calendar
• component3: Calendar
• component4: Number
• component5: Currency
• component6: Calendar

NOTE: this source code has been generated.

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

static java.lang.String	COMPONENTS_PATTERN
static java.lang.String	NAME
static java.lang.String	PARSER_PATTERN

Fields inherited from class com.prowidesoftware.swift.model.field.Field

components

Constructor Summary

Field98E()
Default constructor

Field98E(java.lang.String value)
Creates the field parsing the parameter value into fields' components

Method Summary

java.lang.String	componentsPattern()
java.util.List<java.util.Calendar>	dates() Get a calendar for every date found
java.lang.String	getComponent1() Get the component1
java.lang.String	getComponent1AsString() Deprecated.
java.lang.String	getComponent2() Get the component2
java.util.Calendar	getComponent2AsCalendar() Get the component2 as Calendar
java.lang.String	getComponent3() Get the component3
java.util.Calendar	getComponent3AsCalendar() Get the component3 as Calendar
java.lang.String	getComponent4() Get the component4
java.lang.Number	getComponent4AsNumber() Get the component4 as Number
java.lang.String	getComponent5() Get the component5
java.util.Currency	getComponent5AsCurrency() Get the component5 as Currency
java.lang.String	getComponent6() Get the component6
java.util.Calendar	getComponent6AsCalendar() Get the component6 as Calendar
java.lang.String	getConditionalQualifier() Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
java.lang.String	getDate() Get the Date (component2).
java.util.Calendar	getDateAsCalendar() Get the Date (component2) as Calendar
java.lang.String	getDecimals() Get the Decimals (component4).
java.lang.Number	getDecimalsAsNumber() Get the Decimals (component4) as Number
java.lang.String	getDSS() Returns the issuer code (or Data Source Scheme or DSS).
java.lang.String	getQualifier() Get the Qualifier (component1).
java.lang.String	getSign() Get the Sign (component5).
java.util.Currency	getSignAsCurrency() Get the Sign (component5) as Currency
java.lang.String	getTime() Get the Time (component3).
java.util.Calendar	getTimeAsCalendar() Get the Time (component3) as Calendar
java.lang.String	getUTCIndicator() Get the UTC Indicator (component6).
java.util.Calendar	getUTCIndicatorAsCalendar() Get the UTC Indicator (component6) as Calendar
java.lang.String	getValue() Serializes the fields' components into the single string value (SWIFT format)
boolean	isDSSPresent() Checks if the issuer code (or Data Source Scheme or DSS) is present.
boolean	isGeneric() Returns true if the field is a GENERIC FIELD as specified by the standard.
boolean	isOptional(int component) Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message. Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
java.lang.String	parserPattern()
void	setComponent1(java.lang.String component1) Set the component1.
void	setComponent2(java.util.Calendar component2) Set the component2.
void	setComponent2(java.lang.String component2) Set the component2.
void	setComponent3(java.util.Calendar component3) Set the component3.
void	setComponent3(java.lang.String component3) Set the component3.
void	setComponent4(java.lang.Number component4) Set the component4.
void	setComponent4(java.lang.String component4) Set the component4.
void	setComponent5(java.util.Currency component5) Set the component5.
void	setComponent5(java.lang.String component5) Set the component5.
void	setComponent6(java.util.Calendar component6) Set the component6.
void	setComponent6(java.lang.String component6) Set the component6.
void	setDate(java.util.Calendar component2) Set the Date (component2) as Calendar
void	setDate(java.lang.String component2) Set the Date (component2).
void	setDecimals(java.lang.Number component4) Set the Decimals (component4) as Number
void	setDecimals(java.lang.String component4) Set the Decimals (component4).
void	setQualifier(java.lang.String component1) Set the Qualifier (component1).
void	setSign(java.util.Currency component5) Set the Sign (component5) as Currency
void	setSign(java.lang.String component5) Set the Sign (component5).
void	setTime(java.util.Calendar component3) Set the Time (component3) as Calendar
void	setTime(java.lang.String component3) Set the Time (component3).
void	setUTCIndicator(java.util.Calendar component6) Set the UTC Indicator (component6) as Calendar
void	setUTCIndicator(java.lang.String component6) Set the UTC Indicator (component6).

Methods inherited from class com.prowidesoftware.swift.model.field.Field

appendInLines, appendInLines, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, isEmpty, joinComponents, joinComponents, joinComponents, joinComponents, setComponent, setComponents, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PARSER_PATTERN

public static final java.lang.String PARSER_PATTERN

See Also:

Constant Field Values

COMPONENTS_PATTERN

public static final java.lang.String COMPONENTS_PATTERN

See Also:

Constant Field Values

Constructor Detail

Field98E

public Field98E()

Default constructor

Field98E

public Field98E(java.lang.String value)

Creates the field parsing the parameter value into fields' components

Parameters:

value -

Method Detail

getValue

public java.lang.String getValue()

Serializes the fields' components into the single string value (SWIFT format)

Overrides:

getValue in class Field

Returns:

SWIFT formatted value

getComponent1

public java.lang.String getComponent1()

Get the component1

Returns:

the component1

getComponent1AsString

@Deprecated
public java.lang.String getComponent1AsString()

Deprecated.

Same as getComponent(1)

getQualifier

public java.lang.String getQualifier()

Get the Qualifier (component1).

Returns:

the Qualifier from component1

setComponent1

public void setComponent1(java.lang.String component1)

Set the component1.

Parameters:

component1 - the component1 to set

setQualifier

public void setQualifier(java.lang.String component1)

Set the Qualifier (component1).

Parameters:

component1 - the Qualifier to set

getComponent2

public java.lang.String getComponent2()

Get the component2

Returns:

the component2

getComponent2AsCalendar

public java.util.Calendar getComponent2AsCalendar()

Get the component2 as Calendar

Returns:

the component2 converted to Calendar or null if cannot be converted

getDate

public java.lang.String getDate()

Get the Date (component2).

Returns:

the Date from component2

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component2) as Calendar

Returns:

the Date from component2 converted to Calendar or null if cannot be converted

setComponent2

public void setComponent2(java.lang.String component2)

Set the component2.

Parameters:

component2 - the component2 to set

setComponent2

public void setComponent2(java.util.Calendar component2)

Set the component2.

Parameters:

component2 - the Calendar with the component2 content to set

setDate

public void setDate(java.lang.String component2)

Set the Date (component2).

Parameters:

component2 - the Date to set

setDate

public void setDate(java.util.Calendar component2)

Set the Date (component2) as Calendar

Parameters:

component2 - Calendar with the Date content to set

getComponent3

public java.lang.String getComponent3()

Get the component3

Returns:

the component3

getComponent3AsCalendar

public java.util.Calendar getComponent3AsCalendar()

Get the component3 as Calendar

Returns:

the component3 converted to Calendar or null if cannot be converted

getTime

public java.lang.String getTime()

Get the Time (component3).

Returns:

the Time from component3

getTimeAsCalendar

public java.util.Calendar getTimeAsCalendar()

Get the Time (component3) as Calendar

Returns:

the Time from component3 converted to Calendar or null if cannot be converted

setComponent3

public void setComponent3(java.lang.String component3)

Set the component3.

Parameters:

component3 - the component3 to set

setComponent3

public void setComponent3(java.util.Calendar component3)

Set the component3.

Parameters:

component3 - the Calendar with the component3 content to set

setTime

public void setTime(java.lang.String component3)

Set the Time (component3).

Parameters:

component3 - the Time to set

setTime

public void setTime(java.util.Calendar component3)

Set the Time (component3) as Calendar

Parameters:

component3 - Calendar with the Time content to set

getComponent4

public java.lang.String getComponent4()

Get the component4

Returns:

the component4

getComponent4AsNumber

public java.lang.Number getComponent4AsNumber()

Get the component4 as Number

Returns:

the component4 converted to Number or null if cannot be converted

getDecimals

public java.lang.String getDecimals()

Get the Decimals (component4).

Returns:

the Decimals from component4

getDecimalsAsNumber

public java.lang.Number getDecimalsAsNumber()

Get the Decimals (component4) as Number

Returns:

the Decimals from component4 converted to Number or null if cannot be converted

setComponent4

public void setComponent4(java.lang.String component4)

Set the component4.

Parameters:

component4 - the component4 to set

setComponent4

public void setComponent4(java.lang.Number component4)

Set the component4.

Parameters:

component4 - the Number with the component4 content to set

setDecimals

public void setDecimals(java.lang.String component4)

Set the Decimals (component4).

Parameters:

component4 - the Decimals to set

setDecimals

public void setDecimals(java.lang.Number component4)

Set the Decimals (component4) as Number

Parameters:

component4 - Number with the Decimals content to set

getComponent5

public java.lang.String getComponent5()

Get the component5

Returns:

the component5

getComponent5AsCurrency

public java.util.Currency getComponent5AsCurrency()

Get the component5 as Currency

Returns:

the component5 converted to Currency or null if cannot be converted

getSign

public java.lang.String getSign()

Get the Sign (component5).

Returns:

the Sign from component5

getSignAsCurrency

public java.util.Currency getSignAsCurrency()

Get the Sign (component5) as Currency

Returns:

the Sign from component5 converted to Currency or null if cannot be converted

setComponent5

public void setComponent5(java.lang.String component5)

Set the component5.

Parameters:

component5 - the component5 to set

setComponent5

public void setComponent5(java.util.Currency component5)

Set the component5.

Parameters:

component5 - the Currency with the component5 content to set

setSign

public void setSign(java.lang.String component5)

Set the Sign (component5).

Parameters:

component5 - the Sign to set

setSign

public void setSign(java.util.Currency component5)

Set the Sign (component5) as Currency

Parameters:

component5 - Currency with the Sign content to set

getComponent6

public java.lang.String getComponent6()

Get the component6

Returns:

the component6

getComponent6AsCalendar

public java.util.Calendar getComponent6AsCalendar()

Get the component6 as Calendar

Returns:

the component6 converted to Calendar or null if cannot be converted

getUTCIndicator

public java.lang.String getUTCIndicator()

Get the UTC Indicator (component6).

Returns:

the UTC Indicator from component6

getUTCIndicatorAsCalendar

public java.util.Calendar getUTCIndicatorAsCalendar()

Get the UTC Indicator (component6) as Calendar

Returns:

the UTC Indicator from component6 converted to Calendar or null if cannot be converted

setComponent6

public void setComponent6(java.lang.String component6)

Set the component6.

Parameters:

component6 - the component6 to set

setComponent6

public void setComponent6(java.util.Calendar component6)

Set the component6.

Parameters:

component6 - the Calendar with the component6 content to set

setUTCIndicator

public void setUTCIndicator(java.lang.String component6)

Set the UTC Indicator (component6).

Parameters:

component6 - the UTC Indicator to set

setUTCIndicator

public void setUTCIndicator(java.util.Calendar component6)

Set the UTC Indicator (component6) as Calendar

Parameters:

component6 - Calendar with the UTC Indicator content to set

dates

public java.util.List<java.util.Calendar> dates()

Description copied from interface: DateContainer

Get a calendar for every date found

Specified by:

dates in interface DateContainer

isOptional

public boolean isOptional(int component)

Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message.
Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.

Specified by:

isOptional in class Field

Parameters:

component - component number, first component of a field is referenced as 1

Returns:

true if the component is optional for this field, false otherwise

isGeneric

public boolean isGeneric()

Returns true if the field is a GENERIC FIELD as specified by the standard.

Specified by:

isGeneric in class Field

Returns:

true if the field is generic, false otherwise

getDSS

public java.lang.String getDSS()

Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.

Specified by:

getDSS in interface GenericField

Overrides:

getDSS in class Field

Returns:

DSS component value or null if the DSS is not set or not available for this field.

isDSSPresent

public boolean isDSSPresent()

Checks if the issuer code (or Data Source Scheme or DSS) is present.

Specified by:

isDSSPresent in interface GenericField

Overrides:

isDSSPresent in class Field

Returns:

true if DSS is present, false otherwise.

See Also:

getDSS()

getConditionalQualifier

public java.lang.String getConditionalQualifier()

Gets the conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.

Specified by:

getConditionalQualifier in interface GenericField

Overrides:

getConditionalQualifier in class Field

Returns:

for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this kind of field.

componentsPattern

public java.lang.String componentsPattern()

Specified by:

componentsPattern in interface PatternContainer

parserPattern

public java.lang.String parserPattern()

Specified by:

parserPattern in interface PatternContainer