Class TextDataReaderSettings

Settings for the Spotfire.Dxp.Data.Import.TextFileDataSource class.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor AllowNewlinesInQuotedFields CodePage ColumnNameConcatenation ColumnNameNullValueReplacement ColumnNameNullValueReplacementString ColumnNameRows CommentPrefix ConstantFieldCount CultureName DataTypesGivenName DefaultColumnName HasQuoteChar HasTrailingSeparator IgnoreColumns IgnoreRows MinimumFieldCount NullValueDescriptor QuoteChar QuoteCharEscape ReadOnly Separator StartReadingRow TypesRow AddColumnNameRow AddColumnNameRows AddIgnoreColumn AddIgnoreColumns AddIgnoreRow AddIgnoreRows AddPercentColumn ClearColumnNameRows ClearColumnNames ClearDataTypes ClearFormatters ClearIgnoreColumns ClearIgnoreRows ClearParsers ClearPercentColumns Clone GetColumnName GetColumnOffset GetDataType GetDataTypeName GetFormatter GetInvariantCurrencySymbol GetParser HasMoreHeaders IsPercentColumn RemoveColumnName RemoveColumnNameRows RemoveDataType RemoveFormatter RemoveIgnoreColumns RemoveIgnoreRows RemoveParser RemovePercentColumn SetColumnName SetDataType SetFormatter SetInvariantCurrencySymbol SetParser ValidateUniqueLines ValidateColumnType VerifyDefaultColumnName

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

constructor

AllowNewlinesInQuotedFields

  • get AllowNewlinesInQuotedFields(): boolean

  • Gets or sets a value indicating whether the data set has quoted fields which contain newline characters (that is, multi-line fields).

    Returns boolean

    Since

    2.0

  • set AllowNewlinesInQuotedFields(value): void

  • Parameters

    • value: boolean

    Returns void

CodePage

  • get CodePage(): number

  • Gets or sets the code page.

    Returns number

    Since

    2.0

  • set CodePage(value): void

  • Parameters

    • value: number

    Returns void

ColumnNameConcatenation

  • get ColumnNameConcatenation(): string

  • Gets or sets the format string used to concatenate the column names if there are more than one column name row defined.

    Returns string

    Since

    2.0

  • set ColumnNameConcatenation(value): void

  • Parameters

    • value: string

    Returns void

ColumnNameNullValueReplacement

ColumnNameNullValueReplacementString

  • get ColumnNameNullValueReplacementString(): string

  • Gets or sets the string used to replace empty fields when concatenation column names.

    Returns string

    Since

    2.0

  • set ColumnNameNullValueReplacementString(value): void

  • Parameters

    • value: string

    Returns void

ColumnNameRows

CommentPrefix

  • get CommentPrefix(): string

  • Gets or sets the string describing how a commented line starts.

    Returns string

    Since

    2.0

  • set CommentPrefix(value): void

  • Parameters

    • value: string

    Returns void

ConstantFieldCount

  • get ConstantFieldCount(): number

  • Gets or sets the number of columns in the data set.

    Returns number

    Since

    2.0

  • set ConstantFieldCount(value): void

  • Parameters

    • value: number

    Returns void

CultureName

  • get CultureName(): string

  • Gets or sets the name of the explicitly set culture. Example: "en-US" for English(United States) culture settings.

    Returns string

    Since

    2.0

  • set CultureName(value): void

  • Parameters

    • value: string

    Returns void

DataTypesGivenName

DefaultColumnName

  • get DefaultColumnName(): string

  • Gets or sets the default column name. Add a "{0}" to get a 1-based index applied to the column name. If no "{0}" is added, one will be automatically appended to the end.

    Returns string

    Since

    2.0

  • set DefaultColumnName(value): void

  • Parameters

    • value: string

    Returns void

HasQuoteChar

  • get HasQuoteChar(): boolean

  • Gets or sets a value indicating whether the data set has quote characters. The quote character to use is set in Spotfire.Dxp.Data.Import.TextDataReaderSettings.QuoteChar.

    Returns boolean

    Since

    2.0

  • set HasQuoteChar(value): void

  • Parameters

    • value: boolean

    Returns void

HasTrailingSeparator

  • get HasTrailingSeparator(): boolean

  • Gets or sets a value indicating whether the data has trailing separator.

    Returns boolean

    Since

    2.0

  • set HasTrailingSeparator(value): void

  • Parameters

    • value: boolean

    Returns void

IgnoreColumns

IgnoreRows

MinimumFieldCount

  • get MinimumFieldCount(): number

  • Gets or sets the minimum number of columns in the data set.

    Returns number

    Since

    2.0

  • set MinimumFieldCount(value): void

  • Parameters

    • value: number

    Returns void

NullValueDescriptor

  • get NullValueDescriptor(): string

  • Gets or sets the string describing how a null value will be described in the data set.

    Returns string

    Since

    2.0

  • set NullValueDescriptor(value): void

  • Parameters

    • value: string

    Returns void

QuoteChar

  • get QuoteChar(): number

  • Gets or sets the quote character.

    Returns number

    Since

    2.0

  • set QuoteChar(value): void

  • Parameters

    • value: number

    Returns void

QuoteCharEscape

  • get QuoteCharEscape(): string

  • Gets or sets the quote character escape sequence.

    Returns string

    Since

    2.0

  • set QuoteCharEscape(value): void

  • Parameters

    • value: string

    Returns void

ReadOnly

  • get ReadOnly(): boolean

  • Gets or sets a value indicating whether this instance is readonly.

    Returns boolean

    Since

    2.0

  • set ReadOnly(value): void

  • Parameters

    • value: boolean

    Returns void

Separator

  • get Separator(): string

  • Gets or sets the separator string used to split the data set into fields.

    Returns string

    Since

    2.0

  • set Separator(value): void

  • Parameters

    • value: string

    Returns void

StartReadingRow

  • get StartReadingRow(): number

  • Gets or sets the row to start reading from.

    Returns number

    Since

    2.0

  • set StartReadingRow(value): void

  • Parameters

    • value: number

    Returns void

TypesRow

  • get TypesRow(): number

  • Gets or sets the types row.

    Returns number

    Since

    2.0

  • set TypesRow(value): void

  • Parameters

    • value: number

    Returns void

AddColumnNameRow

  • AddColumnNameRow(row): void

  • Adds the provided row to the list of column name rows.

    Parameters

    • row: number | Int32

      The row to add.

    Returns void

    Since

    2.0

AddColumnNameRows

  • AddColumnNameRows(rows): void

  • Adds the provided rows to the list of column name rows.

    Parameters

    Returns void

    Since

    2.0

AddIgnoreColumn

  • AddIgnoreColumn(column): void

  • Adds the provided column to the list of ignored columns.

    Parameters

    • column: number | Int32

      The column to add.

    Returns void

    Since

    2.0

AddIgnoreColumns

  • AddIgnoreColumns(columns): void

  • Adds the provided columns to the list of ignore columns.

    Parameters

    Returns void

    Since

    2.0

AddIgnoreRow

  • AddIgnoreRow(row): void

  • Adds the provided row to the list of ignored rows.

    Parameters

    • row: number | Int32

      The row to add.

    Returns void

    Since

    2.0

AddIgnoreRows

  • AddIgnoreRows(rows): void

  • Adds the provided rows to the list of ignored rows.

    Parameters

    Returns void

    Since

    2.0

AddPercentColumn

  • AddPercentColumn(column): void

  • Adds a column to the list of percent columns.

    Parameters

    • column: number | Int32

      The column to add.

    Returns void

    Since

    2.0

ClearColumnNameRows

  • ClearColumnNameRows(): void

  • Clears the list of column name rows.

    Returns void

    Since

    2.0

ClearColumnNames

  • ClearColumnNames(clearPersisted): void

  • Clears the list of column names. If the clearPersisted flag is false, the persisted names are kept.

    Parameters

    • clearPersisted: boolean | Boolean

      A value indicating whether the persisted column names should be cleared as well.

    Returns void

    Since

    2.0

ClearDataTypes

  • ClearDataTypes(clearPersisted): void

  • Clears the list of data types. If the clearPersisted flag is false, the persisted data types are kept.

    Parameters

    • clearPersisted: boolean | Boolean

      A value indicating whether the persisted data types should be cleared as well.

    Returns void

    Since

    2.0

ClearFormatters

  • ClearFormatters(clearPersisted): void

  • Clears the list of formatters. If the clearPersisted flag is false, the persisted formatters are kept.

    Parameters

    • clearPersisted: boolean | Boolean

      A flag to specify if the persisted formatters should be cleared as well.

    Returns void

    Since

    2.0

ClearIgnoreColumns

  • ClearIgnoreColumns(): void

  • Clears the list of ignored columns.

    Returns void

    Since

    2.0

ClearIgnoreRows

  • ClearIgnoreRows(): void

  • Clears the list of ignored rows.

    Returns void

    Since

    2.0

ClearParsers

  • ClearParsers(): void

  • Clear the list of parsers.

    Returns void

    Since

    2.0

ClearPercentColumns

  • ClearPercentColumns(): void

  • Clears the list of Percent columns.

    Returns void

    Since

    2.0

Clone

GetColumnName

  • GetColumnName(column): string

  • Gets the name for a specific column.

    Parameters

    • column: number | Int32

      The column to get the name for.

    Returns string

    The column name if found; otherwise null.

    Since

    2.0

GetColumnOffset

  • GetColumnOffset(column): number

  • Gets the offset for the column, that is the count of ignored columns prior to this column. This is used when reading the data in Spotfire.Dxp.Data.Import.TextDataReader.

    Parameters

    • column: number | Int32

      The column to get the offset for.

    Returns number

    The offset.

    Since

    2.0

GetDataType

GetDataTypeName

  • GetDataTypeName(column): string

  • Gets the Spotfire type for the specified column.

    Parameters

    • column: number | Int32

      The column.

    Returns string

    The Spotfire type

    Since

    2.0

GetFormatter

GetInvariantCurrencySymbol

  • GetInvariantCurrencySymbol(column): string

  • Gets the invariant currency symbol, if one exists.

    Parameters

    • column: number | Int32

      The column to get the invariant currency symbol for.

    Returns string

    The invariant currency symbol, or null if there was none..

    Since

    2.0

GetParser

HasMoreHeaders

  • HasMoreHeaders(row): boolean

  • Returns true if there are any type or name rows with higher number than the provided row number.

    Parameters

    Returns boolean

    True if more headers exists.

    Since

    2.0

IsPercentColumn

  • IsPercentColumn(column): boolean

  • Returns true if the provided column is present in the list of percent columns.

    Parameters

    • column: number | Int32

      The column to look for.

    Returns boolean

    True if the column existed in the list.

    Since

    2.0

RemoveColumnName

  • RemoveColumnName(column): void

  • Removes the column name from the list of column names.

    Parameters

    • column: number | Int32

      The column to remove the name for.

    Returns void

    Since

    2.0

RemoveColumnNameRows

  • RemoveColumnNameRows(rows): void

  • Removes the provided rows from the list of column name rows.

    Parameters

    Returns void

    Since

    2.0

RemoveDataType

  • RemoveDataType(column): void

  • Removes the stored data type for the specified column.

    Parameters

    • column: number | Int32

      The column to remove the data type for.

    Returns void

    Since

    2.0

RemoveFormatter

RemoveIgnoreColumns

  • RemoveIgnoreColumns(columns): void

  • Removes the provided columns to the list of ignored columns.

    Parameters

    Returns void

    Since

    2.0

RemoveIgnoreRows

  • RemoveIgnoreRows(rows): void

  • Removes the provided rows from the list of ignored rows.

    Parameters

    Returns void

    Since

    2.0

RemoveParser

  • RemoveParser(column): void

  • Removes the parser for the provided column from the list of parsers, if it exists.

    Parameters

    • column: number | Int32

      The column to remove the parser for.

    Returns void

    Since

    2.0

RemovePercentColumn

  • RemovePercentColumn(column): void

  • Removes the provided column from the list of percent columns, if it exists.

    Parameters

    • column: number | Int32

      The column to remove.

    Returns void

    Since

    2.0

SetColumnName

  • SetColumnName(column, name): void

  • Explicitly sets the name of a column.

    Parameters

    • column: number | Int32

      The column to set the name for.

    • name: string | String

      The name to set.

    Returns void

    Since

    2.0

SetDataType

SetFormatter

SetInvariantCurrencySymbol

  • SetInvariantCurrencySymbol(column, symbol): void

  • Sets the invariant currency symbol for the provided column index.

    Parameters

    • column: number | Int32

      The column to set the invariant currency symbol for.

    • symbol: string | String

      The symbol to set.

    Returns void

    Since

    2.0

SetParser

  • SetParser(column, parser): void

  • Sets the parser to use for the provided column.

    Parameters

    Returns void

    Since

    2.0

ValidateUniqueLines

  • ValidateUniqueLines(): boolean

  • A sanity check to make sure that no name rows, type row or ignored rows are the same.

    Returns boolean

    true if the combination of rows is valid.

    Since

    2.0

StaticValidateColumnType

  • ValidateColumnType(type): DataType

  • Validates the data type string, and if valid return the corresponding data type, otherwise returns Undefined.

    Parameters

    • type: string | String

      A string representation of a data type.

    Returns DataType

    Returns the data type if the input string is valid, otherwize; Undefined.

    Since

    2.0

StaticVerifyDefaultColumnName

  • VerifyDefaultColumnName(name): boolean

  • Verifies if the string is a valid default column name string.

    Parameters

    • name: string | String

      The string to test.

    Returns boolean

    true if the string is valid, otherwise false.

    Since

    2.0

  • VerifyDefaultColumnName(name, allowed): boolean

  • Verifies if the string is a valid default column name string.

    Parameters

    • name: string | String

      The string to test.

    • allowed: string | String

      The allowed integers.

    Returns boolean

    true if the string is valid, otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
constructorAllowNewlinesInQuotedFieldsCodePageColumnNameConcatenationColumnNameNullValueReplacementColumnNameNullValueReplacementStringColumnNameRowsCommentPrefixConstantFieldCountCultureNameDataTypesGivenNameDefaultColumnNameHasQuoteCharHasTrailingSeparatorIgnoreColumnsIgnoreRowsMinimumFieldCountNullValueDescriptorQuoteCharQuoteCharEscapeReadOnlySeparatorStartReadingRowTypesRowAddColumnNameRowAddColumnNameRowsAddIgnoreColumnAddIgnoreColumnsAddIgnoreRowAddIgnoreRowsAddPercentColumnClearColumnNameRowsClearColumnNamesClearDataTypesClearFormattersClearIgnoreColumnsClearIgnoreRowsClearParsersClearPercentColumnsCloneGetColumnNameGetColumnOffsetGetDataTypeGetDataTypeNameGetFormatterGetInvariantCurrencySymbolGetParserHasMoreHeadersIsPercentColumnRemoveColumnNameRemoveColumnNameRowsRemoveDataTypeRemoveFormatterRemoveIgnoreColumnsRemoveIgnoreRowsRemoveParserRemovePercentColumnSetColumnNameSetDataTypeSetFormatterSetInvariantCurrencySymbolSetParserValidateUniqueLinesValidateColumnTypeVerifyDefaultColumnName