java.lang.Object
- de.xima.fc.mdl.savedata.ASaveFormData

All Implemented Interfaces:

IFormDataAdapter, Serializable

Direct Known Subclasses:

GenericSaveFormData
```
public abstract class ASaveFormData
extends Object
implements IFormDataAdapter
```
Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,String>`	`aliasFieldMap`	Reverses Mapping zwischen Alias und Feldname
`protected Map<String,IFormContainerMetaData>`	`dynContainerMap`
`protected Set<String>`	`dynFieldSet`	A collection that contains all form elements that are repeated elements (dynamic).
`protected Map<String,String>`	`fieldAliasMap`
`protected Map<String,IFormContainerMetaData>`	`fieldContainerMap`
`protected Map<String,IFieldMetaData>`	`fieldMetaDataMap`
`protected Map<String,List<String>>`	`fieldNotesRead`	Deprecated.
`protected Map<String,List<String>>`	`fieldNotesUnread`	Deprecated.
`protected Map<String,List<String[]>>`	`fieldValuesMap`
`protected Map<String,String>`	`metaDataMap`
`protected HashSet<String>`	`questionFieldSet`
`protected Map<String,List<String>>`	`requestDataMap`
`protected Set<String>`	`sendElements`

Constructor Summary

Constructors
Constructor Description

ASaveFormData()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addMultiValue(String fieldName, List<String[]> values)`	Adds the given values to the values of the form element.
`void`	`addSingleValue(String fieldName, String... value)`	Adds the given values to the values of the form element.
`Object`	`aliasValue(String alias)`
`String`	`asStringValue(String[] value)`
`String`	`asStringValue(List<String[]> value)`
`Map<String,String>`	`getAliasFieldMap()`
`Set<String>`	`getDynFieldSets()`
`Set<String>`	`getFieldAlias()`
`Map<String,String>`	`getFieldAliasMap()`
`Map<String,List<String>>`	`getFieldNotesRead()`	Gets a map with notes for form fields that were already read by a user.
`Map<String,List<String>>`	`getFieldNotesUnread()`	Gets a map with notes for form fields that were not yet read by a user.
`Set<String>`	`getFields()`
`EFormFieldTyp`	`getFieldTyp(String identifier, boolean asAlias)`
`List<String[]>`	`getFieldValues(String fieldName)`
`Map<String,List<String[]>>`	`getFieldValuesMap()`
`Map<String,IFormContainerMetaData>`	`getIDynContainerMap()`
`IFieldMetaData`	`getIFieldMetaData(String identifier, boolean asAlias)`
`Map<String,IFieldMetaData>`	`getIFieldMetaDataMap()`
`Map<String,String>`	`getMetaDataMap()`
`String`	`getNormName(String fieldName)`	For each element, a name is defined in the designer.
`Map<String,List<String>>`	`getRequestDataMap()`
`String`	`getStringValue(String fieldName)`	Each form element may have multiple values.
`boolean`	`hasAlias(String alias)`
`boolean`	`hasField(String fieldName)`	ERSTMAL: Liefert `true`, wenn das Formular ein Feld mit dem übergebenen Namen besitzt.
`boolean`	`isElementLooped(String elemName)`	A repeated form element (also called dynamic or looped) is a form element of which the user can create multiple copies of as they fill out the form.
`boolean`	`isQuestionElement(String elementName)`
`int`	`loopCount(String elemName)`	A repeated form element (also called dynamic or looped) is a form element of which the user can create multiple copies of as they fill out the form.
`String[]`	`normalizeValue(String... value)`
`String[]`	`normalizeValue(List<String> value)`
`List<String[]>`	`normalizeValues(List<String> stringList)`
`String`	`resolveAliasName(String alias)`
`protected String`	`resolveDynValueName(String fieldName, Integer index)`
`String`	`resolveFieldAlias(String alias)`
`String`	`resolveFieldName(String fieldName)`
`EFormFieldTyp`	`resolveFieldType(String fieldName, boolean asAlias)`
`protected void`	`updateContainerElements(IFormContainerMetaData container)`
`protected void`	`updateValuesMap(IFormContainerMetaData container, String elementName, List<String> value, int index)`
`boolean`	`valuesMapHasValue(String fieldName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.form.IFormDataAdapter
addRequestValue, createCompleteDynContainerMap, getDynContainerMap, getDynFieldSet, getFieldMetaData, getFieldMetaDataMap, getSendElements, init, init, init, init, mergeRequestData

- Field Detail
  - requestDataMap
```
protected Map<String,List<String>> requestDataMap
```
  - fieldAliasMap
```
protected final Map<String,String> fieldAliasMap
```
  - aliasFieldMap
```
protected final Map<String,String> aliasFieldMap
```
    Reverses Mapping zwischen Alias und Feldname
  - metaDataMap
```
protected final Map<String,String> metaDataMap
```
  - fieldMetaDataMap
```
protected final Map<String,IFieldMetaData> fieldMetaDataMap
```
  - fieldContainerMap
```
protected final Map<String,IFormContainerMetaData> fieldContainerMap
```
  - fieldValuesMap
```
protected final Map<String,List<String[]>> fieldValuesMap
```
  - dynContainerMap
```
protected final Map<String,IFormContainerMetaData> dynContainerMap
```
  - dynFieldSet
```
protected final Set<String> dynFieldSet
```
    A collection that contains all form elements that are repeated elements (dynamic).
  - questionFieldSet
```
protected final HashSet<String> questionFieldSet
```
  - fieldNotesRead
```
@Deprecated
protected final Map<String,List<String>> fieldNotesRead
```
    Deprecated.
  - fieldNotesUnread
```
@Deprecated
protected final Map<String,List<String>> fieldNotesUnread
```
    Deprecated.
  - sendElements
```
protected final Set<String> sendElements
```
- Constructor Detail
  - ASaveFormData
```
public ASaveFormData()
```
- Method Detail
  - isQuestionElement
```
public boolean isQuestionElement(String elementName)
```
    Specified by:
    
    isQuestionElement in interface IFormDataAdapter
  - loopCount
```
public int loopCount(String elemName)
```
    Description copied from interface: IFormDataAdapter
    
    A repeated form element (also called dynamic or looped) is a form element of which the user can create multiple copies of as they fill out the form. This method returns how many copies were created.
    
    Specified by:
    
    loopCount in interface IFormDataAdapter
    
    Parameters:
    
    elemName - The name of a form element.
    
    Returns:
    
    The number of repetitions of the given repeated form element, or 0 in case the element is not a repeated element.
    
    See Also:
    
    IFormDataAdapter.isElementLooped(String)
  - getMetaDataMap
```
public Map<String,String> getMetaDataMap()
```
    Specified by:
    
    getMetaDataMap in interface IFormDataAdapter
  - getFieldValuesMap
```
public Map<String,List<String[]>> getFieldValuesMap()
```
    Specified by:
    
    getFieldValuesMap in interface IFormDataAdapter
    
    Returns:
    
    A Map that maps from the name of a form element to its values.
  - getFieldAliasMap
```
public Map<String,String> getFieldAliasMap()
```
    Specified by:
    
    getFieldAliasMap in interface IFormDataAdapter
    
    Returns:
    
    A Map that maps from the name of a form elements to its alias name.
    
    See Also:
    
    IFormDataAdapter.getAliasFieldMap()
  - getAliasFieldMap
```
public Map<String,String> getAliasFieldMap()
```
    Specified by:
    
    getAliasFieldMap in interface IFormDataAdapter
    
    Returns:
    
    A Map that maps from the alias name of a form elements to its name.
    
    See Also:
    
    IFormDataAdapter.getFieldAliasMap()
  - getIFieldMetaDataMap
```
public Map<String,IFieldMetaData> getIFieldMetaDataMap()
```
    Specified by:
    
    getIFieldMetaDataMap in interface IFormDataAdapter
  - getIDynContainerMap
```
public Map<String,IFormContainerMetaData> getIDynContainerMap()
```
    Specified by:
    
    getIDynContainerMap in interface IFormDataAdapter
    
    Returns:
    
    A map from the name of a repeated container or element to the metadata for that repeated container or element.
  - getDynFieldSets
```
public Set<String> getDynFieldSets()
```
    Specified by:
    
    getDynFieldSets in interface IFormDataAdapter
    
    Returns:
    
    A set that consists of the names of all form elements which are repeated and that have a value.
    
    See Also:
    
    IFormDataAdapter.isElementLooped(String), IFormDataAdapter.getDynContainerMap()
  - getFieldNotesRead
```
public Map<String,List<String>> getFieldNotesRead()
```
    Description copied from interface: IFormDataAdapter
    
    Gets a map with notes for form fields that were already read by a user. The key is the name of the field, e.g. tf1.
    
    Specified by:
    
    getFieldNotesRead in interface IFormDataAdapter
    
    Returns:
    
    Am map with all read field notes.
  - getFieldNotesUnread
```
public Map<String,List<String>> getFieldNotesUnread()
```
    Description copied from interface: IFormDataAdapter
    
    Gets a map with notes for form fields that were not yet read by a user. The key is the name of the field, e.g. tf1.
    
    Specified by:
    
    getFieldNotesUnread in interface IFormDataAdapter
    
    Returns:
    
    Am map with all unread field notes.
  - getRequestDataMap
```
public Map<String,List<String>> getRequestDataMap()
```
    Specified by:
    
    getRequestDataMap in interface IFormDataAdapter
  - updateValuesMap
```
protected void updateValuesMap(IFormContainerMetaData container,
                               String elementName,
                               List<String> value,
                               int index)
```
  - updateContainerElements
```
protected void updateContainerElements(IFormContainerMetaData container)
```
  - resolveDynValueName
```
protected String resolveDynValueName(String fieldName,
                                     Integer index)
```
  - valuesMapHasValue
```
public boolean valuesMapHasValue(String fieldName)
```
    Specified by:
    
    valuesMapHasValue in interface IFormDataAdapter
  - resolveFieldAlias
```
public String resolveFieldAlias(String alias)
```
    Specified by:
    
    resolveFieldAlias in interface IFormDataAdapter
  - resolveFieldName
```
public String resolveFieldName(String fieldName)
```
    Specified by:
    
    resolveFieldName in interface IFormDataAdapter
  - getFieldTyp
```
public EFormFieldTyp getFieldTyp(String identifier,
                                 boolean asAlias)
```
    Specified by:
    
    getFieldTyp in interface IFormDataAdapter
    
    Parameters:
    
    identifier - The name of a form element.
    
    asAlias - If true, interpret the given identifier as the alias name of the form element. If false, interpret the given identifier as the name of the form element.
    
    Returns:
    
    The form field type for the given element; or null when the given element does not exist.
  - getFieldAlias
```
public Set<String> getFieldAlias()
```
    Specified by:
    
    getFieldAlias in interface IFormDataAdapter
    
    Returns:
    
    A Set consisting of the alias names of all existing form elements.
  - getIFieldMetaData
```
public IFieldMetaData getIFieldMetaData(String identifier,
                                        boolean asAlias)
```
    Specified by:
    
    getIFieldMetaData in interface IFormDataAdapter
  - isElementLooped
```
public boolean isElementLooped(String elemName)
```
    Description copied from interface: IFormDataAdapter
    
    A repeated form element (also called dynamic or looped) is a form element of which the user can create multiple copies of as they fill out the form. This method checks whether the given form element is repeated.
    
    Specified by:
    
    isElementLooped in interface IFormDataAdapter
    
    Parameters:
    
    elemName - The name of a form element to check.
    
    Returns:
    
    true if the form element is a repeated element, false otherwise (or if the given element does not exist).
  - aliasValue
```
public Object aliasValue(String alias)
```
    Specified by:
    
    aliasValue in interface IFormDataAdapter
  - hasAlias
```
public boolean hasAlias(String alias)
```
    Specified by:
    
    hasAlias in interface IFormDataAdapter
    
    Parameters:
    
    alias - An alias name to check.
    
    Returns:
    
    true if a form element with the given alias exists, or false otherwise.
  - hasField
```
public boolean hasField(String fieldName)
```
    Description copied from interface: IFormDataAdapter
    
    ERSTMAL: Liefert true, wenn das Formular ein Feld mit dem übergebenen Namen besitzt.
    
    Specified by:
    
    hasField in interface IFormDataAdapter
    
    Parameters:
    
    fieldName - the field to check for
    
    Returns:
    
    Liefert true, wenn das Formular ein Feld mit dem übergebenen Namen besitzt
  - resolveFieldType
```
public EFormFieldTyp resolveFieldType(String fieldName,
                                      boolean asAlias)
```
    Specified by:
    
    resolveFieldType in interface IFormDataAdapter
  - getFieldValues
```
public List<String[]> getFieldValues(String fieldName)
```
    Specified by:
    
    getFieldValues in interface IFormDataAdapter
    
    Parameters:
    
    fieldName - The name of a form element.
    
    Returns:
    
    A List of all values for the given form element, or null if the given form element does not exist.
  - resolveAliasName
```
public String resolveAliasName(String alias)
```
    Specified by:
    
    resolveAliasName in interface IFormDataAdapter
    
    Parameters:
    
    alias - The alias of a form element.
    
    Returns:
    
    The resolved alias, i.e. the name of the form element with the given alias. Returns the given alias in case no form element with the given alias exists.
    
    See Also:
    
    IFormDataAdapter.hasAlias(String)
  - getStringValue
```
public String getStringValue(String fieldName)
```
    Description copied from interface: IFormDataAdapter
    
    Each form element may have multiple values. This returns the first value.
    
    Specified by:
    
    getStringValue in interface IFormDataAdapter
    
    Parameters:
    
    fieldName - The name of a form element.
    
    Returns:
    
    The first value for the given form element, or the empty string when no value or the form element does not exist.
  - normalizeValue
```
public String[] normalizeValue(String... value)
```
    Specified by:
    
    normalizeValue in interface IFormDataAdapter
    
    Parameters:
    
    value - A list of values.
    
    Returns:
    
    The given list of values, or an empty array in case null was given.
  - normalizeValue
```
public String[] normalizeValue(List<String> value)
```
    Specified by:
    
    normalizeValue in interface IFormDataAdapter
    
    Parameters:
    
    value - A List of values.
    
    Returns:
    
    An array with the given values, or an empty array in case null was given.
  - normalizeValues
```
public List<String[]> normalizeValues(List<String> stringList)
```
    Specified by:
    
    normalizeValues in interface IFormDataAdapter
    
    Parameters:
    
    stringList - A list of values.
    
    Returns:
    
    A List with only a single entry, an array containing the given values.
  - getNormName
```
public String getNormName(String fieldName)
```
    Description copied from interface: IFormDataAdapter
    
    For each element, a name is defined in the designer. When the element is marked as a repeated elements, the created elements get a name that consists of the original name and a suffix. This method takes a name that may contain such a suffix and returns the original form element name.
    
    Specified by:
    
    getNormName in interface IFormDataAdapter
    
    Parameters:
    
    fieldName - A form element that may contain suffixes such as the suffix for repeated elements.
    
    Returns:
    
    The given name, normalized to the form element name as defined in the designer.
  - asStringValue
```
public String asStringValue(List<String[]> value)
```
    Specified by:
    
    asStringValue in interface IFormDataAdapter
    
    Parameters:
    
    value - A List of values to be converted.
    
    Returns:
    
    The given values, joined with a comma; or the empty string in case null or no values were given.
  - asStringValue
```
public String asStringValue(String[] value)
```
    Specified by:
    
    asStringValue in interface IFormDataAdapter
    
    Parameters:
    
    value - An array of values to be converted.
    
    Returns:
    
    The given values, joined with a comma; or the empty string in case null or no values were given.
  - addSingleValue
```
public void addSingleValue(String fieldName,
                           String... value)
```
    Description copied from interface: IFormDataAdapter
    
    Adds the given values to the values of the form element. If one or multiple values exist already for the given form element, they are preserved. Please note that the value of a form element is a List of arrays of Strings, this adds the given values to the first entry in the List of values.
    
    Specified by:
    
    addSingleValue in interface IFormDataAdapter
    
    Parameters:
    
    fieldName - The name of a form element.
    
    value - One or multiple values to add for the given element.
    
    See Also:
    
    IFormDataAdapter.addMultiValue(String, List)
  - addMultiValue
```
public void addMultiValue(String fieldName,
                          List<String[]> values)
```
    Description copied from interface: IFormDataAdapter
    
    Adds the given values to the values of the form element. If one or multiple values exist already for the given form element, they are preserved.
    
    Specified by:
    
    addMultiValue in interface IFormDataAdapter
    
    Parameters:
    
    fieldName - The name of a form element.
    
    values - A List of values to add to the form element.
    
    See Also:
    
    IFormDataAdapter.addSingleValue(String, String...)
  - getFields
```
public Set<String> getFields()
```
    Specified by:
    
    getFields in interface IFormDataAdapter

Class ASaveFormData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.xima.fc.interfaces.form.IFormDataAdapter

Field Detail

requestDataMap

fieldAliasMap

aliasFieldMap

metaDataMap

fieldMetaDataMap

fieldContainerMap

fieldValuesMap

dynContainerMap

dynFieldSet

questionFieldSet

fieldNotesRead

fieldNotesUnread

sendElements

Constructor Detail

ASaveFormData

Method Detail

isQuestionElement

loopCount

getMetaDataMap

getFieldValuesMap

getFieldAliasMap

getAliasFieldMap

getIFieldMetaDataMap

getIDynContainerMap

getDynFieldSets

getFieldNotesRead

getFieldNotesUnread

getRequestDataMap

updateValuesMap

updateContainerElements

resolveDynValueName

valuesMapHasValue

resolveFieldAlias

resolveFieldName

getFieldTyp

getFieldAlias

getIFieldMetaData

isElementLooped

aliasValue

hasAlias

hasField

resolveFieldType

getFieldValues

resolveAliasName

getStringValue

normalizeValue

normalizeValue

normalizeValues

getNormName

asStringValue

asStringValue

addSingleValue

addMultiValue

getFields