DBCDatabaseIndexedColumnInfo

#DBCDatabaseIndexedColumnInfo Class Reference
[SQLitews]:http://www.sqlite.org
[APPLFastEnumerationProtocol]:http://developer.apple.com/library/ios/#documentation/cocoa/reference/NSFastEnumeration_protocol/Reference/NSFastEnumeration.html [DBCDatabaseResultCR]:https://github.com/parfeon/DBConnect/wiki/DBCDatabaseResult
[DBCDatabaseCR]:https://github.com/parfeon/DBConnect/wiki/DBCDatabase
[DBCDatabaseBasicExample]:https://github.com/parfeon/DBConnect/wiki/DBCDatabase#basicExample
[DBCDatabaseIndexInfo]:https://github.com/parfeon/DBConnect/wiki/DBCDatabase+Aliases#m17
Overview
This class holds information about the column which is a part of the table index and was retrieved as a result of [indexedColumnsList:index:error:][DBCDatabaseIndexInfo].
This class holds information about:

• column index inside of the table index
• column index inside of the table
• column name

##Tasks
###DBCDatabaseIndexedColumnInfo initialization
+ indexedColumnInfoWithSequence:inTableSequenceNumber:name:
- initIndexedColumnInfoWithSequence:inTableSequenceNumber:name:
###DBCDatabaseIndexedColumnInfo properties
indexInIndex
indexInTable
name

##Properties

indexInIndex

This property stores information about sequence number of the column inside of the index.

@property (nonatomic, readonly, getter = indexInIndex)int colIdxInIndex

Return value
Sequence number of the column inside of the index.

See Also
indexInTable
name

Top

---

indexInTable

This property stores information about the column sequence number inside of the table.

@property (nonatomic, readonly, getter = indexInTable)int colIdxInTable

Return value
Column sequence number inside of the table.

See Also
indexInIndex
name

Top

---

name

This property stores information about column name.

@property (nonatomic, readonly, getter = name)NSString *colName

Return value
Column name.

See Also
indexInIndex
indexInTable

Top

##Class methods

indexedColumnInfoWithSequence:inTableSequenceNumber:name:

Create and initialize DBCDatabaseIndexedColumnInfo instance with an index sequence number in the table, sequence number and column name.

+ (id)indexedColumnInfoWithSequence:(int)columnIndexInIndex inTableSequenceNumber:(int)columnIndexInTable 
                               name:(NSString*)columnName

Parameters
columnIndexInIndex
    Sequence number of the column inside of the index.
columnIndexInTable
    Column sequence number inside of the table.
columnName
    Column name.

Return value
Autoreleased DBCDatabaseIndexedColumnInfo instance.

Discussion
This method creates and initializes DBCDatabaseIndexedColumnInfo instance which stores information about indexed column.

See Also
- initIndexedColumnInfoWithSequence:inTableSequenceNumber:name:

Top

##Instance methods

initIndexedColumnInfoWithSequence:inTableSequenceNumber:name:

Initialize DBCDatabaseIndexedColumnInfo instance with an index sequence number in the table, sequence number and column name.

- (id)initIndexedColumnInfoWithSequence:(int)columnIndexInIndex inTableSequenceNumber:(int)columnIndexInTable 
                                   name:(NSString*)columnName

Parameters
sequenceNumber
columnIndexInIndex
    Sequence number ofthe column inside of the index.
columnIndexInTable
    Column sequence number inside of the table.
columnName
    Column name.

Return value
Initialized DBCDatabaseIndexedColumnInfo instance.

Discussion
This method creates and initializes DBCDatabaseIndexedColumnInfo instance which stores information about indexed column.

See Also
+ indexedColumnInfoWithSequence:inTableSequenceNumber:name:

Top