Class Parameters

    • Constructor Detail

      • Parameters

        public Parameters()
    • Method Detail

      • reset

        public void reset()
        Description copied from class: StringParameters
        Reset this parameters object to its default values.

        Subclasses should override this method to set any initial values and instantiate any objects that require allocation. It is recommended that subclasses also call super.reset() in the override to ensure that the buffer is empty.

        Specified by:
        reset in interface IParameters
        Overrides:
        reset in class StringParameters
      • getCsvNoExtractCols

        public String getCsvNoExtractCols()
        Gets the comma-separated list of the indexes of the columns not to extract (0-based index). You can have whitespace between values. Example: "2,4"
        Returns:
        the comma-separated list of the columns not to extract, or null when all columns are extractable.
      • setCsvNoExtractCols

        public void setCsvNoExtractCols​(String csvNoExtractCols)
      • getCsvFormatCols

        public String getCsvFormatCols()
        Gets the comma-separated list of the indexes of the columns to process with a non-plain-text filter (0-based index). The format to use for the given column is entered after the index and a separator ':'. You can have whitespace between values. Example: "1:okf_markdown, 5:okf_html"
        Returns:
        the comma-separated list of the columns to process with a given sub-filter, null when all columns are plain-text.
      • setCsvFormatCols

        public void setCsvFormatCols​(String csvFormatCols)
      • getCsvStartingRow

        public int getCsvStartingRow()
        Gets the row number where the extraction should start (1-based index).
        Returns:
        the row number where the extraction should start.
      • setCsvStartingRow

        public void setCsvStartingRow​(int csvStartingRow)
      • getCsvAutoDetectColumnTypes

        public boolean getCsvAutoDetectColumnTypes()
        Gets the detection mode used when determining each column's extraction type. 'False' to use values in the .fprm file, 'true' to auto-detect the extraction types for each column using the designated row in the CSV. This auto-detect row might look like this: "notrans,text,okf_html,okf_markdown,text".
        Returns:
        boolean value which governs the auto-detection mode.
      • setCsvAutoDetectColumnTypes

        public void setCsvAutoDetectColumnTypes​(boolean csvAutoDetectColumnTypes)
      • getCsvAutoDetectColumnTypesRow

        public int getCsvAutoDetectColumnTypesRow()
        Gets the row number to use when using 'auto-detection' to determine column types. The auto-detection row might look like this: "notrans,text,okf_html,okf_markdown,text".
        Returns:
        int value corresponding to the line/row number containing the "column types" data
      • setCsvAutoDetectColumnTypesRow

        public void setCsvAutoDetectColumnTypesRow​(int csvAutoDetectColumnTypesRow)