Interface ISqlJetBtreeTable
- All Known Subinterfaces:
ISqlJetBtreeDataTable
,ISqlJetBtreeIndexTable
,ISqlJetBtreeSchemaTable
- All Known Implementing Classes:
SqlJetBtreeDataTable
,SqlJetBtreeIndexTable
,SqlJetBtreeSchemaTable
,SqlJetBtreeTable
,SqlJetMapIndexCursor
,SqlJetMapTableCursor
public interface ISqlJetBtreeTable
Interface of table over B-Tree.
- Author:
- TMate Software Ltd., Sergey Scherbina (sergey.scherbina@gmail.com)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
void
close()
Close B-Tree table cursor.void
delete()
boolean
eof()
Check of end of B-Tree table cursor.boolean
first()
Go to first record.getBlob
(int field) Get field's value as BLOB.int
Get count of fields in current record.getFieldType
(int field) Get type of field.double
getFloat
(int field) Get field's value as real (float).long
getInteger
(int field) Get field's value as integer.long
getString
(int field) Get field's value as string.getValue
(int field) Get value as object.Object[]
Get values as objects.boolean
hasMoved()
Returns true if cursor has been moved.void
insert
(ISqlJetMemoryPointer pKey, long nKey, ISqlJetMemoryPointer pData, int nData, int nZero, boolean bias) boolean
isNull
(int field) Check to field has null value.boolean
last()
Go to last record.void
lock()
Lock B-Tree table cursor's mutex.void
lockTable
(boolean write) int
moveTo
(ISqlJetMemoryPointer pKey, long nKey, boolean bias) long
newRowId()
long
newRowId
(long prev) boolean
next()
Go to next record.boolean
popState()
Restores previously saved state if there any.boolean
previous()
Go to previous record.void
Saves current state of this table and sets it to point to the first record.void
unlock()
Unlock B-Tree table cursror's mutex.
-
Method Details
-
close
Close B-Tree table cursor.- Throws:
SqlJetException
-
lock
Lock B-Tree table cursor's mutex.- Throws:
SqlJetException
-
unlock
void unlock()Unlock B-Tree table cursror's mutex. -
eof
Check of end of B-Tree table cursor.- Returns:
- true if there is not more records.
- Throws:
SqlJetException
-
first
Go to first record.- Returns:
- true if there is at least one record.
- Throws:
SqlJetException
-
last
Go to last record.- Returns:
- true if there is at least one record.
- Throws:
SqlJetException
-
next
Go to next record.- Returns:
- true if there is at least one record and end of cursor is not reached yet
- Throws:
SqlJetException
-
previous
Go to previous record.- Returns:
- true if there is at least one record and begin of cursor is not reached yet
- Throws:
SqlJetException
-
getRecord
- Returns:
- Throws:
SqlJetException
-
lockTable
void lockTable(boolean write) - Parameters:
write
-
-
getEncoding
- Returns:
- Throws:
SqlJetException
-
getFieldsCount
Get count of fields in current record.- Returns:
- count of fields
- Throws:
SqlJetException
-
getFieldType
Get type of field.- Parameters:
field
- number of field begin from zero- Returns:
- type of field
- Throws:
SqlJetException
-
isNull
Check to field has null value.- Parameters:
field
- number of field begin from zero- Returns:
- true if field value is null
- Throws:
SqlJetException
-
getString
Get field's value as string.- Parameters:
field
- number of field begin from zero- Returns:
- field's value as string
- Throws:
SqlJetException
-
getInteger
Get field's value as integer.- Parameters:
field
- number of field begin from zero- Returns:
- field's value as integer
- Throws:
SqlJetException
-
getFloat
Get field's value as real (float).- Parameters:
field
- number of field begin from zero- Returns:
- field's value as real
- Throws:
SqlJetException
-
getBlob
Get field's value as BLOB.- Parameters:
field
- number of field begin from zero- Returns:
- field's value as BLOB
- Throws:
SqlJetException
-
getValues
Get values as objects.- Returns:
- Throws:
SqlJetException
-
getValue
Get value as object.- Parameters:
field
-- Returns:
- Throws:
SqlJetException
-
hasMoved
Returns true if cursor has been moved. Side effect of this is restore position of cursor.- Returns:
- Throws:
SqlJetException
-
clear
- Throws:
SqlJetException
-
delete
- Throws:
SqlJetException
-
insert
void insert(ISqlJetMemoryPointer pKey, long nKey, ISqlJetMemoryPointer pData, int nData, int nZero, boolean bias) throws SqlJetException - Parameters:
pKey
-nKey
-pData
-nData
-nZero
-bias
-- Throws:
SqlJetException
-
moveTo
- Parameters:
pKey
-nKey
-bias
-- Returns:
- Throws:
SqlJetException
-
getKeySize
- Returns:
- Throws:
SqlJetException
-
newRowId
- Parameters:
prev
-- Returns:
- Throws:
SqlJetException
-
newRowId
- Returns:
- Throws:
SqlJetException
-
pushState
Saves current state of this table and sets it to point to the first record.- Throws:
SqlJetException
-
popState
Restores previously saved state if there any.- Returns:
- Throws:
SqlJetException
-