Class MediaRow

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

Hierarchy

UserCustomRow
- MediaRow
  - IconRow

Constructors

constructor

new MediaRow(table: MediaTable): MediaRow
Constructor to create an empty row
Parameters
- table: MediaTable
  
  media table
Returns MediaRow
Overrides UserCustomRow.constructor
- Defined in lib/extension/related/media/mediaRow.ts:15
new MediaRow(userCustomRow: UserCustomRow): MediaRow
Constructor
Parameters
- userCustomRow: UserCustomRow
  
  user custom row
Returns MediaRow
Overrides UserCustomRow.constructor
- Defined in lib/extension/related/media/mediaRow.ts:21
new MediaRow(mediaRow: MediaRow): MediaRow
Copy Constructor
Parameters
- mediaRow: MediaRow
  
  media row to copy
Returns MediaRow
Overrides UserCustomRow.constructor
- Defined in lib/extension/related/media/mediaRow.ts:27

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 UserCustomRow.columnCount
- Defined in lib/user/userRow.ts:171

columnNames

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

Returns
column names

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

idColumn

get idColumn(): UserColumn
Gets the id column

Returns

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

pkColumn

get pkColumn(): UserColumn
Get the primary key column

Returns
pk column

Returns UserColumn
Inherited from UserCustomRow.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 UserCustomRow.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 UserCustomRow.columnToContentValue
- Defined in lib/user/userRow.ts:469

copy

copy(): MediaRow
Copy the row

Returns
row copy

Returns MediaRow
Overrides UserCustomRow.copy
- Defined in lib/extension/related/media/mediaRow.ts:182

`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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.getColumnWithIndex
- Defined in lib/user/userRow.ts:271

getColumns

getColumns(): UserCustomColumns
Get columns

Returns

Returns UserCustomColumns
Inherited from UserCustomRow.getColumns
- Defined in lib/user/custom/userCustomRow.ts:56

getContentType

getContentType(): string
Get the content type

Returns
content type

Returns string
- Defined in lib/extension/related/media/mediaRow.ts:165

getContentTypeColumn

getContentTypeColumn(): UserCustomColumn
Get the content type column

Returns
content type column

Returns UserCustomColumn
- Defined in lib/extension/related/media/mediaRow.ts:156

getContentTypeColumnIndex

getContentTypeColumnIndex(): number
Get the content type column index

Returns
content type column index

Returns number
- Defined in lib/extension/related/media/mediaRow.ts:147

getData

getData(): Buffer
Get the data

Returns
data

Returns Buffer
- Defined in lib/extension/related/media/mediaRow.ts:106

getDataColumn

getDataColumn(): UserCustomColumn
Get the data column

Returns
data column

Returns UserCustomColumn
- Defined in lib/extension/related/media/mediaRow.ts:98

getDataColumnIndex

getDataColumnIndex(): number
Get the data column index

Returns
data column index

Returns number
- Defined in lib/extension/related/media/mediaRow.ts:89

getDataImage

getDataImage(): Promise<GeoPackageImage>
Get the data image

Returns
image

Returns Promise<GeoPackageImage>
- Defined in lib/extension/related/media/mediaRow.ts:129

getId

getId(): number
Get the id

Returns
id

Returns number
Overrides UserCustomRow.getId
- Defined in lib/extension/related/media/mediaRow.ts:80

getIdColumn

getIdColumn(): UserCustomColumn
Get the id column

Returns
id column

Returns UserCustomColumn
- Defined in lib/extension/related/media/mediaRow.ts:72

getIdColumnIndex

getIdColumnIndex(): number
Get the id column index

Returns
id column index

Returns number
- Defined in lib/extension/related/media/mediaRow.ts:63

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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.getRowColumnTypes
- Defined in lib/user/userRow.ts:112

getScaledDataImage

getScaledDataImage(scale: number): Promise<GeoPackageImage>
Get the scaled data image

Returns
Parameters
- scale: number
Returns Promise<GeoPackageImage>
- Defined in lib/extension/related/media/mediaRow.ts:138

getTable

getTable(): MediaTable
Return the table

Returns MediaTable
Overrides UserCustomRow.getTable
- Defined in lib/extension/related/media/mediaRow.ts:54

getValue

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

Returns
value
Parameters
- columnName: string
  
  column name
Returns any
Inherited from UserCustomRow.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 UserCustomRow.getValueWithIndex
- Defined in lib/user/userRow.ts:202

getValues

getValues(): DBValue[]
Get the row values

Returns
values

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

hasId

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

hasIdColumn

hasIdColumn(): boolean
Returns boolean
Inherited from UserCustomRow.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 UserCustomRow.resetId
- Defined in lib/user/userRow.ts:402

setContentType

setContentType(contentType: string): void
Set the content type
Parameters
- contentType: string
  
  content type
Returns void
- Defined in lib/extension/related/media/mediaRow.ts:173

setData

setData(data: Buffer): void
Set the data
Parameters
- data: Buffer
  
  data
Returns void
- Defined in lib/extension/related/media/mediaRow.ts:121

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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.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 UserCustomRow.validateValue
- Defined in lib/user/userRow.ts:519

Class MediaRow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

table: MediaTable

Returns MediaRow

Parameters

userCustomRow: UserCustomRow

Returns MediaRow

Parameters

mediaRow: MediaRow

Returns MediaRow

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 MediaRow

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

Returns UserCustomColumns

getContentType

Returns

`Protected` `Readonly` columnTypes

`Protected` `Readonly` columns

`Protected` `Readonly` table

`Protected` `Readonly` values

`Protected` columnToContentValue

`Protected` copyValue