GPKGUserRow

Objective-C

@interface GPKGUserRow : NSObject <NSMutableCopying>

Swift

class GPKGUserRow : NSObject, NSMutableCopying

User Row containing the values from a single result row

Show on GitHub

  • User table

    Declaration

    Objective-C

    @property (nonatomic, strong) GPKGUserTable *table;

    Swift

    var table: GPKGUserTable! { get set }
    Show on GitHub

  • User columns

    Declaration

    Objective-C

    @property (nonatomic, strong) GPKGUserColumns *columns;

    Swift

    var columns: GPKGUserColumns! { get set }
    Show on GitHub

  • Array of row values

    Declaration

    Objective-C

    @property (nonatomic, strong) NSMutableArray *values;

    Swift

    var values: NSMutableArray! { get set }
    Show on GitHub

  • Initialize

    Declaration

    Objective-C

    - (instancetype)initWithTable:(GPKGUserTable *)table
                   andColumns:(GPKGUserColumns *)columns
                    andValues:(NSMutableArray *)values;

    Swift

    init!(table: GPKGUserTable!, andColumns columns: GPKGUserColumns!, andValues values: NSMutableArray!)

    Parameters

    table

    user table
    columns

    columns
    values

    values

    Return Value

    new user row

    Show on GitHub

  • Initialize

    Declaration

    Objective-C

    - (instancetype)initWithTable:(GPKGUserTable *)table;

    Swift

    init!(table: GPKGUserTable!)

    Parameters

    table

    user table

    Return Value

    new user row

    Show on GitHub

  • Copy Initializer

    Declaration

    Objective-C

    - (instancetype)initWithRow:(GPKGUserRow *)row;

    Swift

    init!(row: GPKGUserRow!)

    Parameters

    row

    user row

    Return Value

    new user row

    Show on GitHub

  • Get the table name

    Declaration

    Objective-C

    - (NSString *)tableName;

    Swift

    func tableName() -> String!

    Return Value

    table name

    Show on GitHub

  • Get the column count

    Declaration

    Objective-C

    - (int)columnCount;

    Swift

    func columnCount() -> Int32

    Return Value

    column count

    Show on GitHub

  • Get the column names

    Declaration

    Objective-C

    - (NSArray *)columnNames;

    Swift

    func columnNames() -> [Any]!

    Return Value

    column names

    Show on GitHub

  • Get the column name at the index

    Declaration

    Objective-C

    - (NSString *)columnNameWithIndex:(int)index;

    Swift

    func columnName(with index: Int32) -> String!

    Parameters

    index

    index

    Return Value

    column name

    Show on GitHub

  • Get the column index of the column name

    Declaration

    Objective-C

    - (int)columnIndexWithColumnName:(NSString *)columnName;

    Swift

    func columnIndex(withColumnName columnName: String!) -> Int32

    Parameters

    columnName

    column name

    Return Value

    index

    Show on GitHub

  • Get the value at the index

    Declaration

    Objective-C

    - (NSObject *)valueWithIndex:(int)index;

    Swift

    func value(with index: Int32) -> NSObject!

    Parameters

    index

    index

    Return Value

    value

    Show on GitHub

  • Get the value of the column name

    Declaration

    Objective-C

    - (NSObject *)valueWithColumnName:(NSString *)columnName;

    Swift

    func value(withColumnName columnName: String!) -> NSObject!

    Parameters

    columnName

    column name

    Return Value

    value

    Show on GitHub

  • Get the value of the column

    Declaration

    Objective-C

    - (NSObject *)valueWithColumn:(GPKGUserColumn *)column;

    Swift

    func value(with column: GPKGUserColumn!) -> NSObject!

    Parameters

    column

    column

    Return Value

    value

    Show on GitHub

  • Get the value at the index as a string

    Declaration

    Objective-C

    - (NSString *)valueStringWithIndex:(int)index;

    Swift

    func valueString(with index: Int32) -> String!

    Parameters

    index

    index

    Return Value

    value

    Show on GitHub

  • Get the value of the column name as a string

    Declaration

    Objective-C

    - (NSString *)valueStringWithColumnName:(NSString *)columnName;

    Swift

    func valueString(withColumnName columnName: String!) -> String!

    Parameters

    columnName

    column name

    Return Value

    value

    Show on GitHub

  • Get the database formatted value at the index

    Declaration

    Objective-C

    - (NSObject *)databaseValueWithIndex:(int)index;

    Swift

    func databaseValue(with index: Int32) -> NSObject!

    Parameters

    index

    index

    Return Value

    value

    Show on GitHub

  • Get the datbase formatted value of the column name

    Declaration

    Objective-C

    - (NSObject *)databaseValueWithColumnName:(NSString *)columnName;

    Swift

    func databaseValue(withColumnName columnName: String!) -> NSObject!

    Parameters

    columnName

    column name

    Return Value

    value

    Show on GitHub

  • Get the data type at the index

    Declaration

    Objective-C

    - (enum GPKGDataType)dataTypeWithIndex:(int)index;

    Swift

    func dataType(with index: Int32) -> GPKGDataType

    Parameters

    index

    index

    Return Value

    row column type

    Show on GitHub

  • Get the data type of the column name

    Declaration

    Objective-C

    - (enum GPKGDataType)dataTypeWithColumnName:(NSString *)columnName;

    Swift

    func dataType(withColumnName columnName: String!) -> GPKGDataType

    Parameters

    columnName

    column name

    Return Value

    row column type

    Show on GitHub

  • Get the SQLite type at the index

    Declaration

    Objective-C

    - (int)sqliteTypeWithIndex:(int)index;

    Swift

    func sqliteType(with index: Int32) -> Int32

    Parameters

    index

    index

    Return Value

    row column type

    Show on GitHub

  • Get the SQLite type of the column name

    Declaration

    Objective-C

    - (int)sqliteTypeWithColumnName:(NSString *)columnName;

    Swift

    func sqliteType(withColumnName columnName: String!) -> Int32

    Parameters

    columnName

    column name

    Return Value

    row column type

    Show on GitHub

  • Get the column at the index

    Declaration

    Objective-C

    - (GPKGUserColumn *)columnWithIndex:(int)index;

    Swift

    func column(with index: Int32) -> GPKGUserColumn!

    Parameters

    index

    index

    Return Value

    column

    Show on GitHub

  • Get the column of the column name

    Declaration

    Objective-C

    - (GPKGUserColumn *)columnWithColumnName:(NSString *)columnName;

    Swift

    func column(withColumnName columnName: String!) -> GPKGUserColumn!

    Parameters

    columnName

    column name

    Return Value

    column

    Show on GitHub

  • Check if the row has the column

    Declaration

    Objective-C

    - (BOOL)hasColumnWithColumnName:(NSString *)columnName;

    Swift

    func hasColumn(withColumnName columnName: String!) -> Bool

    Parameters

    columnName

    column name

    Return Value

    true if has the column

    Show on GitHub
  • -id

    Get the id value, which is the value of the primary key

    Declaration

    Objective-C

    - (NSNumber *)id;

    Swift

    func id() -> NSNumber!

    Return Value

    id value

    Show on GitHub

  • Get the id value, which is the value of the primary key

    Declaration

    Objective-C

    - (int)idValue;

    Swift

    func idValue() -> Int32

    Return Value

    id value

    Show on GitHub

  • Check if the row has an id column

    Declaration

    Objective-C

    - (BOOL)hasIdColumn;

    Swift

    func hasIdColumn() -> Bool

    Return Value

    true if has an id column

    Show on GitHub

  • Check if the row has an id value

    Declaration

    Objective-C

    - (BOOL)hasId;

    Swift

    func hasId() -> Bool

    Return Value

    true if has an id

    Show on GitHub

  • Get the id column index

    Declaration

    Objective-C

    - (int)idIndex;

    Swift

    func idIndex() -> Int32

    Return Value

    id column index

    Show on GitHub

  • Get the id column

    Declaration

    Objective-C

    - (GPKGUserColumn *)idColumn;

    Swift

    func idColumn() -> GPKGUserColumn!

    Return Value

    id column

    Show on GitHub

  • Get the id column name

    Declaration

    Objective-C

    - (NSString *)idColumnName;

    Swift

    func idColumnName() -> String!

    Return Value

    id column name

    Show on GitHub
  • -pk

    Get the pk value

    Declaration

    Objective-C

    - (NSObject *)pk;

    Swift

    func pk() -> NSObject!

    Return Value

    pk value

    Show on GitHub

  • Check if the row has an pk column

    Declaration

    Objective-C

    - (BOOL)hasPkColumn;

    Swift

    func hasPkColumn() -> Bool

    Return Value

    true if has a pk column

    Show on GitHub

  • Check if the row has an pk value

    Declaration

    Objective-C

    - (BOOL)hasPk;

    Swift

    func hasPk() -> Bool

    Return Value

    true if has an pk

    Show on GitHub

  • Get the primary key column index

    Declaration

    Objective-C

    - (int)pkIndex;

    Swift

    func pkIndex() -> Int32

    Return Value

    pk index

    Show on GitHub

  • Get the primary key column

    Declaration

    Objective-C

    - (GPKGUserColumn *)pkColumn;

    Swift

    func pkColumn() -> GPKGUserColumn!

    Return Value

    pk column

    Show on GitHub

  • Get the primary key column name

    Declaration

    Objective-C

    - (NSString *)pkColumnName;

    Swift

    func pkColumnName() -> String!

    Return Value

    primary key column name

    Show on GitHub

  • Set the value at the index

    Declaration

    Objective-C

    - (void)setValueWithIndex:(int)index andValue:(NSObject *)value;

    Swift

    func setValueWith(_ index: Int32, andValue value: NSObject!)

    Parameters

    index

    index
    value

    value
    Show on GitHub

  • Set the value at the index without validation

    Declaration

    Objective-C

    - (void)setValueNoValidationWithIndex:(int)index andValue:(NSObject *)value;

    Swift

    func setValueNoValidationWith(_ index: Int32, andValue value: NSObject!)

    Parameters

    index

    index
    value

    value
    Show on GitHub

  • Set the value of the column name

    Declaration

    Objective-C

    - (void)setValueWithColumnName:(NSString *)columnName
                      andValue:(NSObject *)value;

    Swift

    func setValueWithColumnName(_ columnName: String!, andValue value: NSObject!)

    Parameters

    columnName

    column name
    value

    value
    Show on GitHub

  • Set the primary key id value

    Declaration

    Objective-C

    - (void)setId:(NSNumber *)id;

    Swift

    func setId(_ id: NSNumber!)

    Parameters

    id

    id value
    Show on GitHub

  • Clears the id so the row can be used as part of an insert or create

    Declaration

    Objective-C

    - (void)resetId;

    Swift

    func resetId()
    Show on GitHub

  • Validate the value and its actual value types against the column data type class

    Declaration

    Objective-C

    - (void)validateValueWithColumn:(GPKGUserColumn *)column
                       andValue:(NSObject *)value
                  andValueTypes:(NSArray *)valueTypes;

    Swift

    func validateValue(with column: GPKGUserColumn!, andValue value: NSObject!, andValueTypes valueTypes: [Any]!)

    Parameters

    column

    column
    value

    value
    valueTypes

    value type classes
    Show on GitHub

  • Copy the value of the data type

    Declaration

    Objective-C

    - (NSObject *)copyValue:(NSObject *)value forColumn:(GPKGUserColumn *)column;

    Swift

    func copyValue(_ value: NSObject!, for column: GPKGUserColumn!) -> NSObject!

    Parameters

    column

    table column
    value

    value

    Return Value

    copy value

    Show on GitHub