Enum DefaultXItemFieldNameConventions
- java.lang.Object
-
- java.lang.Enum<DefaultXItemFieldNameConventions>
-
- de.xima.fc.form.common.models.DefaultXItemFieldNameConventions
-
- All Implemented Interfaces:
IXItemFieldNameConventions
,Serializable
,Comparable<DefaultXItemFieldNameConventions>
public enum DefaultXItemFieldNameConventions extends Enum<DefaultXItemFieldNameConventions> implements IXItemFieldNameConventions
The defaultfield name conventions
suitable for most form items that consist of only a single input, select, or textarea field in the rendered form, with a name as configured in the form designer.- Since:
- 8.1.0
- Author:
- XIMA MEDIA GmbH
-
-
Enum Constant Summary
Enum Constants Enum Constant Description INSTANCE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<String>
findRelatedBaseNames(String baseName)
Given the base name of a form item, returns the set of additional related names that might be submitted.String
resolveRelatedBaseName(String relatedBaseName)
Given the base name of a request value, finds the base name of the form item that produced this request value.static DefaultXItemFieldNameConventions
valueOf(String name)
Returns the enum constant of this type with the specified name.static DefaultXItemFieldNameConventions[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INSTANCE
public static final DefaultXItemFieldNameConventions INSTANCE
-
-
Method Detail
-
values
public static DefaultXItemFieldNameConventions[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (DefaultXItemFieldNameConventions c : DefaultXItemFieldNameConventions.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DefaultXItemFieldNameConventions valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
findRelatedBaseNames
public Set<String> findRelatedBaseNames(String baseName)
Description copied from interface:IXItemFieldNameConventions
Given the base name of a form item, returns the set of additional related names that might be submitted.For example, when the form contains an autocomplete element with the name
sel1
, the form submission might include a value for the related namesel1_autocomplete
in addition to the value for the namesel1
. This method should then return a set with the one valuesel1_autocomplete
when called with the base namesel1
.This is the inverse operation of
resolveRelatedBaseName
. If this method is given a stringX
and returns a set of stringsY
, thenresolveRelatedBaseName
must returnX
if given any of the stringsY
.This method is never given a derived name for repeated form fields. Repeated form fields use the convention
tf1_dyn_fs1_0
(item base name tf1, container base name fs1, repetition ID 0).- Specified by:
findRelatedBaseNames
in interfaceIXItemFieldNameConventions
- Parameters:
baseName
- The base name of an item.- Returns:
- A set of related base names.
null
or the empty set when there are no related base name.
-
resolveRelatedBaseName
public String resolveRelatedBaseName(String relatedBaseName)
Description copied from interface:IXItemFieldNameConventions
Given the base name of a request value, finds the base name of the form item that produced this request value.For example, when the form contains an autocomplete element with the name
sel1
, the form submission might include a value for the related namesel1_autocomplete
in addition to the value for the namesel1
. This method should then returnsel1
when given the namesel1_autocomplete
.This method is never given a derived name for repeated form fields. Repeated form fields use the convention
tf1_dyn_fs1_0
(item base name tf1, container base name fs1, repetition ID 0).This is the inverse operation of
findRelatedBaseNames
. IffindRelatedBaseNames
is given a stringX
and returns a set of stringsY
, then this method must return. X
if given any of the stringsY
.- Specified by:
resolveRelatedBaseName
in interfaceIXItemFieldNameConventions
- Parameters:
relatedBaseName
- A related base name to resolve.- Returns:
- The resolved base name.
null
, the empty string, or the argument itself when the name is unknown to this conventions instance.
-
-