Package de.xima.fc.form.common.models

Interface IFormContainerMetaData

All Superinterfaces:
Serializable
All Known Implementing Classes:
FormContainerMetaData
public interface IFormContainerMetaData extends Serializable
Meta data about a repeated form element.
Author:
XIMA MEDIA GmbH

  • Method Details

    • containsField

      boolean containsField(String fieldName)
      Parameters:
      fieldName - Name to check.
      Returns:
      Whether a repetition of the form element with the given name exists. Same as checking the getFieldList().

    • getContainerName

      String getContainerName()
      Returns:
      The name of the repeated container that contains this element. May be the element itself.

    • getFieldList

      Set<String> getFieldList()
      Returns:
      The field names of all repeated instances of the form field.

    • getIdList

      List<Integer> getIdList()
      Returns:
      The repetition IDs of all repeated instances of the form field.

    • getSize

      int getSize()
      Returns:
      The number of existing repetition of the form field.

    • repetitionIdToOrdinalIndex

      Integer repetitionIdToOrdinalIndex(Integer inputIndex)
      Finds the ordinal index for a repetition ID. For example, when there are three element repetitions, the first could be tf1_dyn_tf1_4, the seconds could be tf1_dyn_tf1_9, and the third could be tf1_dyn_tf1_15. Then this method would return repetitionIdToOrdinalIndex(4) == 0, repetitionIdToOrdinalIndex(9) == 1, and repetitionIdToOrdinalIndex(15) = 2. All other parameters return -1.
      Parameters:
      inputIndex - Repetition ID of the given repetition.
      Returns:
      Ordinal index of the element repetition. -1 when no element with the given repetition index exists.

    • ordinalIndexToRepetitionId

      Integer ordinalIndexToRepetitionId(Integer inputIndex)
      Finds the repetition ID for an ordinal index (the nth repetition of the element). For example, when there are three element repetitions, the first could be tf1_dyn_tf1_4, the seconds could be tf1_dyn_tf1_9, and the third could be tf1_dyn_tf1_15. Then this method would return ordinalToRepetitionId(0) == 4, ordinalToRepetitionId(1) == 9, and ordinalToRepetitionId(2) = 15. All other parameters return -1.
      Parameters:
      inputIndex - Repetition ID of the given repetition.
      Returns:
      Ordinal index of the element repetition. -1 when no element with the given repetition index exists.