com.groupdocs.editor.options

Class DelimitedTextEditOptions

  • All Implemented Interfaces:
    IEditOptions

    public final class DelimitedTextEditOptions
extends Object
implements IEditOptions

    Options for loading text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)

    https://en.wikipedia.org/wiki/Delimiter-separated_values

    • Constructor Summary

      Constructors 
      Constructor and Description
      DelimitedTextEditOptions(String separator)
      Creates an instance of options class for delimited text with mandatory separator (delimiter)

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean getConvertDateTimeData()
      Gets or sets a value that indicates whether the string in text-based document is converted to the date data.
      boolean getConvertNumericData()
      Gets or sets a value that indicates whether the string in text-based document is converted to numeric data.
      boolean getOptimizeMemoryUsage()
      Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage.
      String getSeparator()
      Allows to specify a string separator (delimiter) for text-based Spreadsheet documents
      boolean getTreatConsecutiveDelimitersAsOne()
      Defines whether consecutive delimiters should be treated as one.
      void setConvertDateTimeData(boolean value)
      Gets or sets a value that indicates whether the string in text-based document is converted to the date data.
      void setConvertNumericData(boolean value)
      Gets or sets a value that indicates whether the string in text-based document is converted to numeric data.
      void setOptimizeMemoryUsage(boolean value)
      Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage.
      void setSeparator(String value)
      Allows to specify a string separator (delimiter) for text-based Spreadsheet documents
      void setTreatConsecutiveDelimitersAsOne(boolean value)
      Defines whether consecutive delimiters should be treated as one.

    • Constructor Detail

      • DelimitedTextEditOptions

        public DelimitedTextEditOptions(String separator)

        Creates an instance of options class for delimited text with mandatory separator (delimiter)

        Parameters:
        separator - Mandatory separator (delimiter), that cannot be NULL or empty

    • Method Detail

      • getConvertDateTimeData

        public final boolean getConvertDateTimeData()

        Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is false.

      • getConvertNumericData

        public final boolean getConvertNumericData()

        Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is false.

      • getOptimizeMemoryUsage

        public final boolean getOptimizeMemoryUsage()

        Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

      • getSeparator

        public final String getSeparator()

        Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

      • getTreatConsecutiveDelimitersAsOne

        public final boolean getTreatConsecutiveDelimitersAsOne()

        Defines whether consecutive delimiters should be treated as one. By default is false.

      • setConvertDateTimeData

        public final void setConvertDateTimeData(boolean value)

        Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is false.

      • setConvertNumericData

        public final void setConvertNumericData(boolean value)

        Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is false.

      • setOptimizeMemoryUsage

        public final void setOptimizeMemoryUsage(boolean value)

        Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

      • setSeparator

        public final void setSeparator(String value)

        Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

      • setTreatConsecutiveDelimitersAsOne

        public final void setTreatConsecutiveDelimitersAsOne(boolean value)

        Defines whether consecutive delimiters should be treated as one. By default is false.