Class ListItemSourcePropsRowsOfCharacterSeparatedValues

java.lang.Object
de.xima.fc.workflow.model.list_item_source.AListItemSourceProps
de.xima.fc.workflow.model.list_item_source.AListItemSourcePropsCsvFormat
de.xima.fc.workflow.model.list_item_source.ListItemSourcePropsRowsOfCharacterSeparatedValues
All Implemented Interfaces:
Serializable
public final class ListItemSourcePropsRowsOfCharacterSeparatedValues extends AListItemSourcePropsCsvFormat
Model class for the for-each loop, representing the settings when EForEachLoopItemListSource.ROWS_OF_CHARACTER_SEPARATED_VALUES is selected.
Since:
8.2.0
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Details

    • ListItemSourcePropsRowsOfCharacterSeparatedValues

      public ListItemSourcePropsRowsOfCharacterSeparatedValues()

  • Method Details

    • getCsvRowsFile

      public SingleFile getCsvRowsFile()
      When getCsvRowsSource() is EWorkflowTextSource.FILE, the CSV file with rows of values to be parsed.
      Returns:
      The file with the rows of character separated values.

    • setCsvRowsFile

      public void setCsvRowsFile(SingleFile csvRowsFile)
      When getCsvRowsSource() is EWorkflowTextSource.FILE, the CSV file with rows of values to be parsed.
      Parameters:
      csvRowsFile - The file with the rows of character separated values.

    • getCsvRowsSource

      public EWorkflowTextSource getCsvRowsSource()
      The source of the CSV rows. Either a string entered directly, or a file.
      Returns:
      The source of the CSV rows.

    • setCsvRowsSource

      public void setCsvRowsSource(EWorkflowTextSource csvRowsSource)
      The source of the CSV rows. Either a string entered directly, or a file.
      Parameters:
      csvRowsSource - The source of the CSV rows.

    • getCsvRowsString

      public String getCsvRowsString()
      When getCsvRowsSource() is EWorkflowTextSource.STRING, the CSV string of rows of values to be parsed. May contain placeholders.
      Returns:
      The string with the rows of character separated values.

    • setCsvRowsString

      public void setCsvRowsString(String csvString)
      When getCsvRowsSource() is EWorkflowTextSource.STRING, the CSV string of rows of values to be parsed. May contain placeholders.
      Parameters:
      csvString - The string with the rows of character separated values.

    • getNewlines

      public Set<String> getNewlines()
      Gets the line separators to be used when parsing the CSV string.
      Returns:
      The line separators to be used when parsing the CSV string.

    • setNewlines

      public void setNewlines(Set<String> newlines)
      Sets the line separators to be used when parsing the CSV string.
      Parameters:
      newlines - The line separators to be used when parsing the CSV string.

    • getNewlinesEncoded

      @Deprecated public Set<String> getNewlinesEncoded()
      Deprecated.
      This should not be necessary. Only required for stupid frameworks that do not encode properly.
      Same as getNewlines(), but encodes the values. Needed e.g. for Faces / PrimeFaces which still has encoding issues...
      Returns:
      The line separators to be used when parsing the CSV string.

    • setNewlinesEncoded

      @Deprecated public void setNewlinesEncoded(Set<String> newlines)
      Deprecated.
      This should not be necessary. Only required for stupid frameworks that do not encode properly.
      Same as setNewlines(Set), but decodes the encoded values. Needed e.g. for Faces / PrimeFaces which still has encoding issues...
      Parameters:
      newlines - The line separators to be used when parsing the CSV string.

    • isIgnoreBlankLines

      public boolean isIgnoreBlankLines()
      Whether to ignore blank lines in the CSV string. If true, lines consisting of blank values only will be skipped and not be included in the data. If false, such lines will be included in the data.
      Returns:
      Whether to ignore blank lines in the CSV string.

    • setIgnoreBlankLines

      public void setIgnoreBlankLines(boolean ignoreBlankLines)
      Whether to ignore blank lines in the CSV string. If true, blank lines will be skipped and not be included in the data. If false, empty or blank lines will result in a row with a single column value that is empty or blank.
      Parameters:
      ignoreBlankLines - Whether to ignore blank lines in the CSV string.

    • isTreatFirstRowAsHeader

      public boolean isTreatFirstRowAsHeader()
      Whether to treat the first row as a header row. If true, the first row will be used to name the columns, and not be part of the data.
      Returns:
      Whether to treat the first row as a header row.

    • setTreatFirstRowAsHeader

      public void setTreatFirstRowAsHeader(boolean treatFirstRowAsHeader)