com.prowidesoftware.swift.model.field.OptionRPartyField Maven / Gradle / Ivy
Show all versions of pw-swift-core Show documentation
/*
* Copyright 2006-2023 Prowide
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.prowidesoftware.swift.model.field;
import com.prowidesoftware.deprecation.DeprecationUtils;
import com.prowidesoftware.deprecation.ProwideDeprecated;
import com.prowidesoftware.deprecation.TargetYear;
import java.util.*;
/**
* Party
*
* Subfields (components) Data types
*
* - Component 1: Qualifier:
String
* - Component 2: DataSourceScheme:
String
* - Component 3: ProprietaryCode:
String
*
*
* Structure definition
*
* - parser pattern:
:S/S/S
* - components pattern:
SSS
*
*
* @since 7.11.0
*/
public abstract class OptionRPartyField extends Field {
public static final String PARSER_PATTERN = ":S/S/S";
/**
* @deprecated Use {@link #typesPattern()} instead
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String COMPONENTS_PATTERN = "SSS";
/**
* Types pattern
*
* Contains a description of the type of each component
*/
public static final String TYPES_PATTERN = "SSS";
/**
* Component number for the Qualifier subfield
*/
public static final Integer QUALIFIER = 1;
/**
* Component number for the Data Source Scheme subfield
*/
public static final Integer DATA_SOURCE_SCHEME = 2;
/**
* Component number for the Proprietary Code subfield
*/
public static final Integer PROPRIETARY_CODE = 3;
/**
* Default constructor. Creates a new field setting all components to null.
*/
public OptionRPartyField() {
super(3);
}
/**
* Creates a new field and initializes its components with content from the parameter value.
*
* @param value complete field value including separators and CRLF
*/
public OptionRPartyField(final String value) {
super(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.
*
* @param value complete field value including separators and CRLF
* @since 7.8
*/
@Override
public void parse(final String value) {
init(3);
setComponent(1, SwiftParseUtils.getTokenFirst(value, ":", "/"));
setComponent(2, SwiftParseUtils.getTokenSecond(value, "/"));
setComponent(3, SwiftParseUtils.getTokenThirdLast(value, "/"));
}
/**
* Serializes the fields' components into the single string value (SWIFT format)
*/
@Override
public String getValue() {
final StringBuilder result = new StringBuilder();
result.append(":");
append(result, 1);
result.append("/");
append(result, 2);
result.append("/");
append(result, 3);
return result.toString();
}
/**
* Returns a localized suitable for showing to humans string of a field component.
*
* @param component number of the component to display
* @param locale optional locale to format date and amounts, if null, the default locale is used
* @return formatted component value or null if component number is invalid or not present
* @throws IllegalArgumentException if component number is invalid for the field
* @since 7.8
*/
@Override
public String getValueDisplay(int component, Locale locale) {
if (component < 1 || component > 3) {
throw new IllegalArgumentException("invalid component number " + component + " for field " + getName());
}
// default format (as is)
return getComponent(component);
}
/**
* @deprecated Use {@link #typesPattern()} instead
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
@Override
public final String componentsPattern() {
DeprecationUtils.phase3(getClass(), "componentsPattern()", "Use typesPattern() instead.");
return 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).
* @see #TYPES_PATTERN
* @return the static value of TYPES_PATTERN
*/
@Override
public final String typesPattern() {
return TYPES_PATTERN;
}
/**
* Returns the field parser pattern
*
* @return the static value of PARSER_PATTERN
*/
@Override
public final String parserPattern() {
return PARSER_PATTERN;
}
/**
* Returns the field validator pattern, that could vary er specific field
*/
@Override
public abstract String validatorPattern();
/**
* 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.
*
* @param component component number, first component of a field is referenced as 1
* @return true if the component is optional for this field, false otherwise
*/
@Override
public boolean isOptional(int component) {
return false;
}
/**
* Returns true if the field is a GENERIC FIELD as specified by the standard.
*
* @return true if the field is generic, false otherwise
*/
@Override
public boolean isGeneric() {
return true;
}
/**
* 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.
*
* @since 7.7
*/
@Override
public int componentsSize() {
return 3;
}
/**
* Returns english label for components.
*
* The index in the list is in sync with specific field component structure.
*
* @see #getComponentLabel(int)
* @since 7.8.4
*/
@Override
public List getComponentLabels() {
List result = new ArrayList<>();
result.add("Qualifier");
result.add("Data Source Scheme");
result.add("Proprietary Code");
return result;
}
/**
* Returns a mapping between component numbers and their label in camel case format.
*
* @since 7.10.3
*/
@Override
protected Map getComponentMap() {
Map result = new HashMap<>();
result.put(1, "qualifier");
result.put(2, "dataSourceScheme");
result.put(3, "proprietaryCode");
return result;
}
/**
* @see Field#getLabelMap()
* @since 9.3.12
*/
@Override
protected Map getLabelMap() {
if (super.labelMap != null && !super.labelMap.isEmpty()) {
// return cached map
return super.labelMap;
}
super.labelMap = new HashMap<>();
super.labelMap.put("qualifier", 1);
super.labelMap.put("datasourcescheme", 2);
super.labelMap.put("proprietarycode", 3);
return super.labelMap;
}
/**
* @return the specific field name (number and letter option)
*/
@Override
public abstract String getName();
/**
* Gets the component1 (Qualifier).
*
* @return the component1
*/
public String getComponent1() {
return getComponent(1);
}
/**
* Gets the Qualifier (component1).
*
* @return the Qualifier from component1
*/
public String getQualifier() {
return getComponent(1);
}
/**
* Gets the component2 (Data Source Scheme).
*
* @return the component2
*/
public String getComponent2() {
return getComponent(2);
}
/**
* Gets the Data Source Scheme (component2).
*
* @return the Data Source Scheme from component2
*/
public String getDataSourceScheme() {
return getComponent(2);
}
/**
* Gets the component3 (Proprietary Code).
*
* @return the component3
*/
public String getComponent3() {
return getComponent(3);
}
/**
* Gets the Proprietary Code (component3).
*
* @return the Proprietary Code from component3
*/
public String getProprietaryCode() {
return getComponent(3);
}
}