Class FtStringMetaField

Meta field for string values.

Hierarchy (View Summary)

FtGenericMetaField<string>
- FtStringMetaField

Index

Constructors

Properties

onDefaultHeadingAlwaysWriteOptionalQuoteRequired onDefaultHeadingConstraintRequired onDefaultHeadingEndOfValueCharRequired onDefaultHeadingPadAlignmentRequired onDefaultHeadingPadCharRequired onDefaultHeadingPadCharTypeRequired onDefaultHeadingQuotedTypeRequired onDefaultHeadingTruncateCharRequired onDefaultHeadingTruncateTypeRequired onDefaultHeadingWritePrefixSpaceRequired DATA_TYPE DEFAULT_SEQUENCE_REDIRECT_TYPE DEFAULT_VALUE

Methods

assignFrom createCopy getDefaultHeadings getDefaultSequenceRedirectType loadDefaults validateEndOfLineTypeChar isStringMetaField

Constructors

constructor

new FtStringMetaField(headingCount?: number): FtStringMetaField
Parameters
- headingCount: number = 0
Returns FtStringMetaField
Overrides FtGenericMetaField.constructor
- Defined in lib/src/meta/fields/ft-string-meta-field.ts:17

Properties

onDefaultHeadingAlwaysWriteOptionalQuoteRequired

onDefaultHeadingAlwaysWriteOptionalQuoteRequired: (() => boolean) | undefined = undefined

onDefaultHeadingConstraintRequired

onDefaultHeadingConstraintRequired: (() => FtHeadingConstraint) | undefined = undefined

onDefaultHeadingEndOfValueCharRequired

onDefaultHeadingEndOfValueCharRequired: (() => string) | undefined = undefined

onDefaultHeadingPadAlignmentRequired

onDefaultHeadingPadAlignmentRequired: (() => FtPadAlignment) | undefined = undefined

onDefaultHeadingPadCharRequired

onDefaultHeadingPadCharRequired: (() => string) | undefined = undefined

onDefaultHeadingPadCharTypeRequired

onDefaultHeadingPadCharTypeRequired: (() => FtPadCharType) | undefined = undefined

onDefaultHeadingQuotedTypeRequired

onDefaultHeadingQuotedTypeRequired: (() => FtQuotedType) | undefined = undefined

onDefaultHeadingTruncateCharRequired

onDefaultHeadingTruncateCharRequired: (() => string) | undefined = undefined

onDefaultHeadingTruncateTypeRequired

onDefaultHeadingTruncateTypeRequired: (() => FtTruncateType) | undefined = undefined

onDefaultHeadingWritePrefixSpaceRequired

onDefaultHeadingWritePrefixSpaceRequired: (() => boolean) | undefined = undefined

`Static` `Readonly`DATA_TYPE

DATA_TYPE: "String" = FtDataType.String

`Static` `Readonly`DEFAULT_SEQUENCE_REDIRECT_TYPE

DEFAULT_SEQUENCE_REDIRECT_TYPE: "ExactString" = FtMetaDefaults.StringField.SequenceRedirectType

`Static` `Readonly`DEFAULT_VALUE

DEFAULT_VALUE: "" = FtMetaDefaults.StringField.Value

Accessors

constant

get constant(): boolean
Returns boolean
Inherited from FtGenericMetaField.constant
- Defined in lib/src/meta/fields/ft-meta-field.ts:116
set constant(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.constant
- Defined in lib/src/meta/fields/ft-meta-field.ts:119

dataType

get dataType(): FtDataType
Returns FtDataType
Inherited from FtGenericMetaField.dataType
- Defined in lib/src/meta/fields/ft-meta-field.ts:74
set dataType(value: FtDataType): void
Parameters
- value: FtDataType
Returns void
Inherited from FtGenericMetaField.dataType
- Defined in lib/src/meta/fields/ft-meta-field.ts:77

fixedWidth

get fixedWidth(): boolean
Returns boolean
Inherited from FtGenericMetaField.fixedWidth
- Defined in lib/src/meta/fields/ft-meta-field.ts:102
set fixedWidth(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.fixedWidth
- Defined in lib/src/meta/fields/ft-meta-field.ts:105

headingAlwaysWriteOptionalQuote

get headingAlwaysWriteOptionalQuote(): boolean
Returns boolean
Inherited from FtGenericMetaField.headingAlwaysWriteOptionalQuote
- Defined in lib/src/meta/fields/ft-meta-field.ts:214
set headingAlwaysWriteOptionalQuote(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.headingAlwaysWriteOptionalQuote
- Defined in lib/src/meta/fields/ft-meta-field.ts:217

headingConstraint

get headingConstraint(): FtHeadingConstraint
Returns FtHeadingConstraint
Inherited from FtGenericMetaField.headingConstraint
- Defined in lib/src/meta/fields/ft-meta-field.ts:200
set headingConstraint(value: FtHeadingConstraint): void
Parameters
- value: FtHeadingConstraint
Returns void
Inherited from FtGenericMetaField.headingConstraint
- Defined in lib/src/meta/fields/ft-meta-field.ts:203

headingCount

get headingCount(): number
Returns number
Inherited from FtGenericMetaField.headingCount
- Defined in lib/src/meta/fields/ft-meta-field.ts:270

headingEndOfValueChar

get headingEndOfValueChar(): string
Returns string
Inherited from FtGenericMetaField.headingEndOfValueChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:263
set headingEndOfValueChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.headingEndOfValueChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:266

headingPadAlignment

get headingPadAlignment(): FtPadAlignment
Returns FtPadAlignment
Inherited from FtGenericMetaField.headingPadAlignment
- Defined in lib/src/meta/fields/ft-meta-field.ts:228
set headingPadAlignment(value: FtPadAlignment): void
Parameters
- value: FtPadAlignment
Returns void
Inherited from FtGenericMetaField.headingPadAlignment
- Defined in lib/src/meta/fields/ft-meta-field.ts:231

headingPadChar

get headingPadChar(): string
Returns string
Inherited from FtGenericMetaField.headingPadChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:242
set headingPadChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.headingPadChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:245

headingPadCharType

get headingPadCharType(): FtPadCharType
Returns FtPadCharType
Inherited from FtGenericMetaField.headingPadCharType
- Defined in lib/src/meta/fields/ft-meta-field.ts:235
set headingPadCharType(value: FtPadCharType): void
Parameters
- value: FtPadCharType
Returns void
Inherited from FtGenericMetaField.headingPadCharType
- Defined in lib/src/meta/fields/ft-meta-field.ts:238

headingQuotedType

get headingQuotedType(): FtQuotedType
Returns FtQuotedType
Inherited from FtGenericMetaField.headingQuotedType
- Defined in lib/src/meta/fields/ft-meta-field.ts:207
set headingQuotedType(value: FtQuotedType): void
Parameters
- value: FtQuotedType
Returns void
Inherited from FtGenericMetaField.headingQuotedType
- Defined in lib/src/meta/fields/ft-meta-field.ts:210

headings

get headings(): string[]
Returns string[]
Inherited from FtGenericMetaField.headings
- Defined in lib/src/meta/fields/ft-meta-field.ts:95
set headings(value: string[]): void
Parameters
- value: string[]
Returns void
Inherited from FtGenericMetaField.headings
- Defined in lib/src/meta/fields/ft-meta-field.ts:98

headingTruncateChar

get headingTruncateChar(): string
Returns string
Inherited from FtGenericMetaField.headingTruncateChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:256
set headingTruncateChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.headingTruncateChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:259

headingTruncateType

get headingTruncateType(): FtTruncateType
Returns FtTruncateType
Inherited from FtGenericMetaField.headingTruncateType
- Defined in lib/src/meta/fields/ft-meta-field.ts:249
set headingTruncateType(value: FtTruncateType): void
Parameters
- value: FtTruncateType
Returns void
Inherited from FtGenericMetaField.headingTruncateType
- Defined in lib/src/meta/fields/ft-meta-field.ts:252

headingWritePrefixSpace

get headingWritePrefixSpace(): boolean
Returns boolean
Inherited from FtGenericMetaField.headingWritePrefixSpace
- Defined in lib/src/meta/fields/ft-meta-field.ts:221
set headingWritePrefixSpace(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.headingWritePrefixSpace
- Defined in lib/src/meta/fields/ft-meta-field.ts:224

id

get id(): number | undefined
Returns number | undefined
Inherited from FtGenericMetaField.id
- Defined in lib/src/meta/fields/ft-meta-field.ts:81
set id(value: number | undefined): void
Parameters
- value: number | undefined
Returns void
Inherited from FtGenericMetaField.id
- Defined in lib/src/meta/fields/ft-meta-field.ts:84

index

get index(): number
Returns number
Inherited from FtGenericMetaField.index
- Defined in lib/src/meta/fields/ft-meta-field.ts:67
set index(value: number): void
Parameters
- value: number
Returns void
Inherited from FtGenericMetaField.index
- Defined in lib/src/meta/fields/ft-meta-field.ts:70

name

get name(): string
Returns string
Inherited from FtGenericMetaField.name
- Defined in lib/src/meta/fields/ft-meta-field.ts:88
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.name
- Defined in lib/src/meta/fields/ft-meta-field.ts:91

null

get null(): boolean
Returns boolean
Inherited from FtGenericMetaField.null
- Defined in lib/src/meta/fields/ft-meta-field.ts:123
set null(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.null
- Defined in lib/src/meta/fields/ft-meta-field.ts:126

value

get value(): T
Returns T
Inherited from FtGenericMetaField.value
- Defined in lib/src/meta/fields/ft-generic-meta-field.ts:19
set value(val: T): void
Parameters
- val: T
Returns void
Inherited from FtGenericMetaField.value
- Defined in lib/src/meta/fields/ft-generic-meta-field.ts:23

valueAlwaysWriteOptionalQuote

get valueAlwaysWriteOptionalQuote(): boolean
Returns boolean
Inherited from FtGenericMetaField.valueAlwaysWriteOptionalQuote
- Defined in lib/src/meta/fields/ft-meta-field.ts:137
set valueAlwaysWriteOptionalQuote(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.valueAlwaysWriteOptionalQuote
- Defined in lib/src/meta/fields/ft-meta-field.ts:140

valueEndOfValueChar

get valueEndOfValueChar(): string
Returns string
Inherited from FtGenericMetaField.valueEndOfValueChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:186
set valueEndOfValueChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.valueEndOfValueChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:189

valueNullChar

get valueNullChar(): string
Returns string
Inherited from FtGenericMetaField.valueNullChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:193
set valueNullChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.valueNullChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:196

valuePadAlignment

get valuePadAlignment(): FtPadAlignment
Returns FtPadAlignment
Inherited from FtGenericMetaField.valuePadAlignment
- Defined in lib/src/meta/fields/ft-meta-field.ts:151
set valuePadAlignment(value: FtPadAlignment): void
Parameters
- value: FtPadAlignment
Returns void
Inherited from FtGenericMetaField.valuePadAlignment
- Defined in lib/src/meta/fields/ft-meta-field.ts:154

valuePadChar

get valuePadChar(): string
Returns string
Inherited from FtGenericMetaField.valuePadChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:165
set valuePadChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.valuePadChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:168

valuePadCharType

get valuePadCharType(): FtPadCharType
Returns FtPadCharType
Inherited from FtGenericMetaField.valuePadCharType
- Defined in lib/src/meta/fields/ft-meta-field.ts:158
set valuePadCharType(value: FtPadCharType): void
Parameters
- value: FtPadCharType
Returns void
Inherited from FtGenericMetaField.valuePadCharType
- Defined in lib/src/meta/fields/ft-meta-field.ts:161

valueQuotedType

get valueQuotedType(): FtQuotedType
Returns FtQuotedType
Inherited from FtGenericMetaField.valueQuotedType
- Defined in lib/src/meta/fields/ft-meta-field.ts:130
set valueQuotedType(value: FtQuotedType): void
Parameters
- value: FtQuotedType
Returns void
Inherited from FtGenericMetaField.valueQuotedType
- Defined in lib/src/meta/fields/ft-meta-field.ts:133

valueTruncateChar

get valueTruncateChar(): string
Returns string
Inherited from FtGenericMetaField.valueTruncateChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:179
set valueTruncateChar(value: string): void
Parameters
- value: string
Returns void
Inherited from FtGenericMetaField.valueTruncateChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:182

valueTruncateType

get valueTruncateType(): FtTruncateType
Returns FtTruncateType
Inherited from FtGenericMetaField.valueTruncateType
- Defined in lib/src/meta/fields/ft-meta-field.ts:172
set valueTruncateType(value: FtTruncateType): void
Parameters
- value: FtTruncateType
Returns void
Inherited from FtGenericMetaField.valueTruncateType
- Defined in lib/src/meta/fields/ft-meta-field.ts:175

valueWritePrefixSpace

get valueWritePrefixSpace(): boolean
Returns boolean
Inherited from FtGenericMetaField.valueWritePrefixSpace
- Defined in lib/src/meta/fields/ft-meta-field.ts:144
set valueWritePrefixSpace(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FtGenericMetaField.valueWritePrefixSpace
- Defined in lib/src/meta/fields/ft-meta-field.ts:147

width

get width(): number
Returns number
Inherited from FtGenericMetaField.width
- Defined in lib/src/meta/fields/ft-meta-field.ts:109
set width(value: number): void
Parameters
- value: number
Returns void
Inherited from FtGenericMetaField.width
- Defined in lib/src/meta/fields/ft-meta-field.ts:112

Methods

loadDefaults

loadDefaults(leaveNameAsIs?: boolean): void
Parameters
- leaveNameAsIs: boolean = true
Returns void
Inherited from FtGenericMetaField.loadDefaults
- Defined in lib/src/meta/fields/ft-generic-meta-field.ts:27

validateEndOfLineTypeChar

validateEndOfLineTypeChar(
eolTypeChar: string,
headingLineCount: number,
): { errorMessage: string; valid: boolean }
Parameters
- eolTypeChar: string
- headingLineCount: number
Returns { errorMessage: string; valid: boolean }
Inherited from FtGenericMetaField.validateEndOfLineTypeChar
- Defined in lib/src/meta/fields/ft-meta-field.ts:325

`Static`isStringMetaField

isStringMetaField(field: FtMetaField): field is FtStringMetaField
Parameters
- field: FtMetaField
Returns field is FtStringMetaField
- Defined in lib/src/meta/fields/ft-string-meta-field.ts:21

Class FtStringMetaField

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FtStringMetaField

Properties

onDefaultHeadingAlwaysWriteOptionalQuoteRequired

onDefaultHeadingConstraintRequired

onDefaultHeadingEndOfValueCharRequired

onDefaultHeadingPadAlignmentRequired

onDefaultHeadingPadCharRequired

onDefaultHeadingPadCharTypeRequired

onDefaultHeadingQuotedTypeRequired

onDefaultHeadingTruncateCharRequired

onDefaultHeadingTruncateTypeRequired

onDefaultHeadingWritePrefixSpaceRequired

Static ReadonlyDATA_TYPE

Static ReadonlyDEFAULT_SEQUENCE_REDIRECT_TYPE

Static ReadonlyDEFAULT_VALUE

Accessors

constant

Returns boolean

Parameters

Returns void

dataType

Returns FtDataType

Parameters

Returns void

fixedWidth

Returns boolean

Parameters

Returns void

headingAlwaysWriteOptionalQuote

Returns boolean

Parameters

Returns void

headingConstraint

Returns FtHeadingConstraint

Parameters

Returns void

headingCount

Returns number

headingEndOfValueChar

Returns string

Parameters

Returns void

headingPadAlignment

Returns FtPadAlignment

Parameters

Returns void

headingPadChar

Returns string

Parameters

Returns void

headingPadCharType

Returns FtPadCharType

Parameters

Returns void

headingQuotedType

Returns FtQuotedType

Parameters

Returns void

headings

Returns string[]

Parameters

Returns void

headingTruncateChar

Returns string

Parameters

Returns void

headingTruncateType

Returns FtTruncateType

Parameters

Returns void

`Static` `Readonly`DATA_TYPE

`Static` `Readonly`DEFAULT_SEQUENCE_REDIRECT_TYPE

`Static` `Readonly`DEFAULT_VALUE

`Protected`assignFrom