Class Field97B
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field97B
-
- All Implemented Interfaces:
JsonSerializable
,GenericField
,PatternContainer
,java.io.Serializable
@Generated public class Field97B extends Field implements java.io.Serializable, GenericField
SWIFT MT Field 97B.Model and parser for field 97B of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Qualifier:
String
- Component 2: DataSourceScheme:
String
- Component 3: AccountTypeCode:
String
- Component 4: AccountNumber:
String
Structure definition
- validation pattern:
:4!c/[8c]/4!c/35x
- parser pattern:
:S/[S]/S/S
- components pattern:
SSSS
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
ACCOUNT_NUMBER
Component number for the Account Number subfield.static java.lang.Integer
ACCOUNT_TYPE_CODE
Component number for the Account Type Code subfield.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.static java.lang.Integer
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield.static java.lang.String
F_97B
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 97B.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static java.lang.Integer
QUALIFIER
Component number for the Qualifier subfield.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field97B()
Default constructor.Field97B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field97B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
instead.int
componentsSize()
Returns the defined amount of components.
This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.static Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field97B
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field97B object.static Field97B
get(SwiftMessage msg)
Gets the first instance of Field97B in the given message.static Field97B
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.java.lang.String
getAccountNumber()
Gets the Account Number (component 4).java.lang.String
getAccountTypeCode()
Gets the Account Type Code (component 3).static java.util.List<Field97B>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field97B in the given message an empty list is returned if none found.static java.util.List<Field97B>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field97B from the given block an empty list is returned if none found.java.lang.String
getComponent1()
Gets the component 1 (Qualifier).java.lang.String
getComponent2()
Gets the component 2 (Data Source Scheme).java.lang.String
getComponent3()
Gets the component 3 (Account Type Code).java.lang.String
getComponent4()
Gets the component 4 (Account Number).java.util.List<java.lang.String>
getComponentLabels()
Returns english label for components.protected java.util.Map<java.lang.Integer,java.lang.String>
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.java.lang.String
getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.java.lang.String
getDataSourceScheme()
Gets the Data Source Scheme (component 2).java.lang.String
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).protected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.java.lang.String
getName()
Returns the field's name composed by the field number and the letter option (if any).java.lang.String
getQualifier()
Gets the Qualifier (component 1).java.lang.String
getValue()
Serializes the fields' components into the single string value (SWIFT format)java.lang.String
getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.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.static Field97B
newInstance(Field97B source)
Copy constructor.void
parse(java.lang.String value)
Parses the parameter value into the internal components structure.java.lang.String
parserPattern()
Returns the field parser pattern.Field97B
setAccountNumber(java.lang.String component4)
Set the Account Number (component 4).Field97B
setAccountTypeCode(java.lang.String component3)
Set the Account Type Code (component 3).Field97B
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).Field97B
setComponent2(java.lang.String component2)
Set the component 2 (Data Source Scheme).Field97B
setComponent3(java.lang.String component3)
Set the component 3 (Account Type Code).Field97B
setComponent4(java.lang.String component4)
Set the component 4 (Account Number).Field97B
setDataSourceScheme(java.lang.String component2)
Set the Data Source Scheme (component 2).Field97B
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).static Tag
tag(java.lang.String value)
Create a Tag with this field name and the given value.java.lang.String
typesPattern()
Returns the field component types pattern.java.lang.String
validatorPattern()
Returns the field validator pattern-
Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
-
-
-
-
Field Detail
-
SRU
public static final int SRU
Constant identifying the SRU to which this class belongs to.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Constant with the field name 97B.- See Also:
- Constant Field Values
-
F_97B
public static final java.lang.String F_97B
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
QUALIFIER
public static final java.lang.Integer QUALIFIER
Component number for the Qualifier subfield.
-
DATA_SOURCE_SCHEME
public static final java.lang.Integer DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield.
-
ACCOUNT_TYPE_CODE
public static final java.lang.Integer ACCOUNT_TYPE_CODE
Component number for the Account Type Code subfield.
-
ACCOUNT_NUMBER
public static final java.lang.Integer ACCOUNT_NUMBER
Component number for the Account Number subfield.
-
CONDITIONAL_QUALIFIER
public static final java.lang.Integer CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.
-
-
Constructor Detail
-
Field97B
public Field97B()
Default constructor. Creates a new field setting all components to null.
-
Field97B
public Field97B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.- Parameters:
value
- complete field value including separators and CRLF
-
Field97B
public Field97B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(String)
- Throws:
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field name- Since:
- 7.8
-
-
Method Detail
-
newInstance
public static Field97B newInstance(Field97B source)
Copy constructor. Initializes the components list with a deep copy of the source components list.- Parameters:
source
- a field instance to copy- Since:
- 7.7
-
tag
public static Tag tag(java.lang.String value)
Create a Tag with this field name and the given value. Shorthand fornew Tag(NAME, value)
- Since:
- 7.5
- See Also:
NAME
-
emptyTag
public static Tag emptyTag()
Create a Tag with this field name and an empty string as value. Shorthand fornew Tag(NAME, "")
- Since:
- 7.5
- See Also:
NAME
-
parse
public void parse(java.lang.String value)
Parses the parameter value into the internal components structure.Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
getValueDisplay
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.- Specified by:
getValueDisplay
in classField
- Parameters:
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is used- Returns:
- formatted component value or null if component number is invalid or not present
- Throws:
java.lang.IllegalArgumentException
- if component number is invalid for the field- Since:
- 7.8
-
componentsPattern
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
typesPattern
public java.lang.String typesPattern()
Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).- Specified by:
typesPattern
in interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
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 classField
- 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.
-
componentsSize
public int componentsSize()
Returns the defined amount of components.
This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.- Specified by:
componentsSize
in classField
- Since:
- 7.7
-
getComponentLabels
public java.util.List<java.lang.String> getComponentLabels()
Returns english label for components.
The index in the list is in sync with specific field component structure.- Specified by:
getComponentLabels
in classField
- Since:
- 7.8.4
- See Also:
Field.getComponentLabel(int)
-
getComponentMap
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
Returns a mapping between component numbers and their label in camel case format.- Specified by:
getComponentMap
in classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Qualifier).- Returns:
- the component 1
-
getQualifier
public java.lang.String getQualifier()
Gets the Qualifier (component 1).- Returns:
- the Qualifier from component 1
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Data Source Scheme).- Returns:
- the component 2
-
getDataSourceScheme
public java.lang.String getDataSourceScheme()
Gets the Data Source Scheme (component 2).- Returns:
- the Data Source Scheme from component 2
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Account Type Code).- Returns:
- the component 3
-
getAccountTypeCode
public java.lang.String getAccountTypeCode()
Gets the Account Type Code (component 3).- Returns:
- the Account Type Code from component 3
-
getComponent4
public java.lang.String getComponent4()
Gets the component 4 (Account Number).- Returns:
- the component 4
-
getAccountNumber
public java.lang.String getAccountNumber()
Gets the Account Number (component 4).- Returns:
- the Account Number from component 4
-
setComponent1
public Field97B setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).- Parameters:
component1
- the Qualifier to set- Returns:
- the field object to enable build pattern
-
setQualifier
public Field97B setQualifier(java.lang.String component1)
Set the Qualifier (component 1).- Parameters:
component1
- the Qualifier to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field97B setComponent2(java.lang.String component2)
Set the component 2 (Data Source Scheme).- Parameters:
component2
- the Data Source Scheme to set- Returns:
- the field object to enable build pattern
-
setDataSourceScheme
public Field97B setDataSourceScheme(java.lang.String component2)
Set the Data Source Scheme (component 2).- Parameters:
component2
- the Data Source Scheme to set- Returns:
- the field object to enable build pattern
-
setComponent3
public Field97B setComponent3(java.lang.String component3)
Set the component 3 (Account Type Code).- Parameters:
component3
- the Account Type Code to set- Returns:
- the field object to enable build pattern
-
setAccountTypeCode
public Field97B setAccountTypeCode(java.lang.String component3)
Set the Account Type Code (component 3).- Parameters:
component3
- the Account Type Code to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field97B setComponent4(java.lang.String component4)
Set the component 4 (Account Number).- Parameters:
component4
- the Account Number to set- Returns:
- the field object to enable build pattern
-
setAccountNumber
public Field97B setAccountNumber(java.lang.String component4)
Set the Account Number (component 4).- Parameters:
component4
- the Account Number to set- Returns:
- the field object to enable build pattern
-
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 interfaceGenericField
- 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 interfaceGenericField
- Returns:
- true if DSS is present, false otherwise.
- See Also:
getDSS()
-
getConditionalQualifier
public java.lang.String getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.- Specified by:
getConditionalQualifier
in interfaceGenericField
- Returns:
- for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this field.
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field97B get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.- Parameters:
block
- may be null or empty- Returns:
- null if not found o block is null or empty
-
get
public static Field97B get(SwiftMessage msg)
Gets the first instance of Field97B in the given message.- Parameters:
msg
- may be empty or null- Returns:
- null if not found or msg is empty or null
- See Also:
get(SwiftTagListBlock)
-
getAll
public static java.util.List<Field97B> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field97B in the given message an empty list is returned if none found.- Parameters:
msg
- may be empty or null in which case an empty list is returned- See Also:
getAll(SwiftTagListBlock)
-
getAll
public static java.util.List<Field97B> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field97B from the given block an empty list is returned if none found.- Parameters:
block
- may be empty or null in which case an empty list is returned
-
fromJson
public static Field97B fromJson(java.lang.String json)
This method deserializes the JSON data into a Field97B object.- Parameters:
json
- JSON structure including tuples with label and value for all field components- Returns:
- a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
- Since:
- 7.10.3
- See Also:
Field.fromJson(String)
-
-