Class UserCustomRow

User Custom Row containing the values from a single result set row

Hierarchy

UserRow<UserCustomColumn, UserCustomTable>
- UserCustomRow

Constructors

constructor

new UserCustomRow(table: UserCustomTable): UserCustomRow
Constructor to create an empty row
Parameters
- table: UserCustomTable
  
  user custom table
Returns UserCustomRow
Overrides UserRow.constructor
- Defined in lib/user/custom/userCustomRow.ts:17
new UserCustomRow(userCustomRow: UserCustomRow): UserCustomRow
Copy Constructor
Parameters
- userCustomRow: UserCustomRow
  
  user custom row to copy
Returns UserCustomRow
Overrides UserRow.constructor
- Defined in lib/user/custom/userCustomRow.ts:24
new UserCustomRow(table: UserCustomTable, columns: UserCustomColumns, columnTypes: number[], values: DBValue[]): UserCustomRow
Constructor
Parameters
- table: UserCustomTable
  
  user custom table
- columns: UserCustomColumns
  
  columns
- columnTypes: number[]
  
  column types
- values: DBValue[]
  
  values
Returns UserCustomRow
Overrides UserRow.constructor
- Defined in lib/user/custom/userCustomRow.ts:34

Properties

`Protected` `Readonly` columnTypes

columnTypes: GeoPackageDataType[]

Column types of this row, based upon the data values

`Protected` `Readonly` columns

columns: UserColumns<UserCustomColumn>

User columns

`Protected` `Readonly` table

table: UserCustomTable

User table

`Protected` `Readonly` values

values: DBValue[]

Array of row values

Accessors

columnCount

get columnCount(): number
Get the column count

Returns
column count

Returns number
Inherited from UserRow.columnCount
- Defined in lib/user/userRow.ts:171

columnNames

get columnNames(): string[]
Get the column names

Returns
column names

Returns string[]
Inherited from UserRow.columnNames
- Defined in lib/user/userRow.ts:178

idColumn

get idColumn(): UserColumn
Gets the id column

Returns

Returns UserColumn
Inherited from UserRow.idColumn
- Defined in lib/user/userRow.ts:164

pkColumn

get pkColumn(): UserColumn
Get the primary key column

Returns
pk column

Returns UserColumn
Inherited from UserRow.pkColumn
- Defined in lib/user/userRow.ts:294

pkColumnIndex

get pkColumnIndex(): number
Get the primary key column Index

Returns
pk index

Returns number
Inherited from UserRow.pkColumnIndex
- Defined in lib/user/userRow.ts:287

Methods

`Protected` columnToContentValue

columnToContentValue(contentValues: ContentValues, column: UserCustomColumn, value: any): void
Map the column to the content values
Parameters
- contentValues: ContentValues
  
  content values
- column: UserCustomColumn
  
  column
- value: any
  
  value
Returns void
Inherited from UserRow.columnToContentValue
- Defined in lib/user/userRow.ts:469

copy

copy(): UserCustomRow
Copy the row

Returns
row copy

Returns UserCustomRow
- Defined in lib/user/custom/userCustomRow.ts:65

`Protected` copyValue

copyValue(column: UserCustomColumn, value: any): any
Copy the value of the data type

Returns
copy value
Parameters
- column: UserCustomColumn
  
  table column
- value: any
  
  value
Returns any
Inherited from UserRow.copyValue
- Defined in lib/user/userRow.ts:129

getColumn

getColumn(columnName: string): UserColumn
Get the column of the column name

Returns
column
Parameters
- columnName: string
  
  column name
Returns UserColumn
Inherited from UserRow.getColumn
- Defined in lib/user/userRow.ts:279

getColumnIndexWithColumnName

getColumnIndexWithColumnName(columnName: string): number
Get the column index of the column name

Returns
column index
Parameters
- columnName: string
  
  column name
Returns number
Inherited from UserRow.getColumnIndexWithColumnName
- Defined in lib/user/userRow.ts:194

getColumnNameWithIndex

getColumnNameWithIndex(index: number): string
Get the column name at the index

Returns
column name
Parameters
- index: number
  
  index
Returns string
Inherited from UserRow.getColumnNameWithIndex
- Defined in lib/user/userRow.ts:186

getColumnWithIndex

getColumnWithIndex(index: number): UserColumn
Get the column at the index

Returns
column
Parameters
- index: number
  
  index
Returns UserColumn
Inherited from UserRow.getColumnWithIndex
- Defined in lib/user/userRow.ts:271

getColumns

getColumns(): UserCustomColumns
Get columns

Returns

Returns UserCustomColumns
Overrides UserRow.getColumns
- Defined in lib/user/custom/userCustomRow.ts:56

getId

getId(): number
Get the id value, which is the value of the primary key

Returns
id

Returns number
Inherited from UserRow.getId
- Defined in lib/user/userRow.ts:347

getRowColumnTypeWithColumnName

getRowColumnTypeWithColumnName(columnName: string): number
Get the row column type of the column name

Returns
row column type
Parameters
- columnName: string
  
  column name
Returns number
Inherited from UserRow.getRowColumnTypeWithColumnName
- Defined in lib/user/userRow.ts:263

getRowColumnTypeWithIndex

getRowColumnTypeWithIndex(index: number): GeoPackageDataType
Get the row column type at the index

Returns
row column type
Parameters
- index: number
  
  index
Returns GeoPackageDataType
Inherited from UserRow.getRowColumnTypeWithIndex
- Defined in lib/user/userRow.ts:255

getRowColumnTypes

getRowColumnTypes(): number[]
Get the row column data types

Returns
row column types

Returns number[]
Inherited from UserRow.getRowColumnTypes
- Defined in lib/user/userRow.ts:112

getTable

getTable(): UserCustomTable
Return the table

Returns UserCustomTable
Inherited from UserRow.getTable
- Defined in lib/user/userRow.ts:431

getValue

getValue(columnName: string): any
Get the value of the column name

Returns
value
Parameters
- columnName: string
  
  column name
Returns any
Inherited from UserRow.getValue
- Defined in lib/user/userRow.ts:214

getValueWithIndex

getValueWithIndex(index: number): any
Get the value at the index

Returns
value
Parameters
- index: number
  
  index
Returns any
Inherited from UserRow.getValueWithIndex
- Defined in lib/user/userRow.ts:202

getValues

getValues(): DBValue[]
Get the row values

Returns
values

Returns DBValue[]
Inherited from UserRow.getValues
- Defined in lib/user/userRow.ts:103

hasId

hasId(): boolean
Returns boolean
Inherited from UserRow.hasId
- Defined in lib/user/userRow.ts:391

hasIdColumn

hasIdColumn(): boolean
Returns boolean
Inherited from UserRow.hasIdColumn
- Defined in lib/user/userRow.ts:388

resetId

resetId(): void
Clears the id so the row can be used as part of an insert or create

Returns void
Inherited from UserRow.resetId
- Defined in lib/user/userRow.ts:402

setId

setId(id: number, pkModifiable?: boolean): void
Set the id and optionally validate
Parameters
- id: number
  
  id value
- pkModifiable: boolean = ...
  
  primary key modifiable
Returns void
Inherited from UserRow.setId
- Defined in lib/user/userRow.ts:411

setValue

setValue(columnName: string, value: any): void
Set the value of the column name
Parameters
- columnName: string
  
  column name
- value: any
  
  value
Returns void
Inherited from UserRow.setValue
- Defined in lib/user/userRow.ts:337

setValueNoValidationWithIndex

setValueNoValidationWithIndex(index: number, value: any): void
Set the value at the index without validation
Parameters
- index: number
  
  index
- value: any
  
  value
Returns void
Inherited from UserRow.setValueNoValidationWithIndex
- Defined in lib/user/userRow.ts:329

setValueWithIndex

setValueWithIndex(index: number, value: any): void
Set the value at the index
Parameters
- index: number
  
  index
- value: any
  
  value
Returns void
Inherited from UserRow.setValueWithIndex
- Defined in lib/user/userRow.ts:302

toContentValues

toContentValues(includeNulls?: boolean): ContentValues
Convert the row to content values

Returns
content values
Parameters
- includeNulls: boolean = true
  
  include null values (default is true)
Returns ContentValues
Inherited from UserRow.toContentValues
- Defined in lib/user/userRow.ts:440

toDatabaseValue

toDatabaseValue(columnName: string): DBValue
Get the value which will be persisted to the database based on the column
Parameters
- columnName: string
  
  name of the column
Returns DBValue
Inherited from UserRow.toDatabaseValue
- Defined in lib/user/userRow.ts:242

toObjectValue

toObjectValue(index: number, value: DBValue): any
Get the value from the database as an object based on the column
Parameters
- index: number
  
  column index
- value: DBValue
  
  value from the database
Returns any
Inherited from UserRow.toObjectValue
- Defined in lib/user/userRow.ts:230

`Protected` validateValue

validateValue(column: UserCustomColumn, value: any, valueTypes: string[]): void
Validate the value and its actual value types against the column data type class
Parameters
- column: UserCustomColumn
  
  column
- value: any
  
  value
- valueTypes: string[]
  
  value type
Returns void
Inherited from UserRow.validateValue
- Defined in lib/user/userRow.ts:519

Class UserCustomRow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

table: UserCustomTable

Returns UserCustomRow

Parameters

userCustomRow: UserCustomRow

Returns UserCustomRow

Parameters

table: UserCustomTable

columns: UserCustomColumns

columnTypes: number[]

values: DBValue[]

Returns UserCustomRow

Properties

Protected Readonly columnTypes

Protected Readonly columns

Protected Readonly table

Protected Readonly values

Accessors

columnCount

Returns

Returns number

columnNames

Returns

Returns string[]

idColumn

Returns

Returns UserColumn

pkColumn

Returns

Returns UserColumn

pkColumnIndex

Returns

Returns number

Methods

Protected columnToContentValue

Parameters

contentValues: ContentValues

column: UserCustomColumn

value: any

Returns void

copy

Returns

Returns UserCustomRow

Protected copyValue

Returns

Parameters

column: UserCustomColumn

value: any

Returns any

getColumn

Returns

Parameters

columnName: string

Returns UserColumn

getColumnIndexWithColumnName

Returns

Parameters

columnName: string

Returns number

getColumnNameWithIndex

Returns

Parameters

index: number

Returns string

getColumnWithIndex

Returns

Parameters

index: number

Returns UserColumn

getColumns

Returns

`Protected` `Readonly` columnTypes

`Protected` `Readonly` columns

`Protected` `Readonly` table

`Protected` `Readonly` values

`Protected` columnToContentValue

`Protected` copyValue