org.tmatesoft.sqljet.core.internal.table
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.


Method Summary
 void 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.
 ISqlJetMemoryPointer getBlob(int field)
          Get field's value as BLOB.
 SqlJetEncoding getEncoding()
           
 int getFieldsCount()
          Get count of fields in current record.
 SqlJetValueType 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 getKeySize()
           
 ISqlJetBtreeRecord getRecord()
           
 java.lang.String getString(int field)
          Get field's value as string.
 java.lang.Object getValue(int field)
          Get value as object.
 java.lang.Object[] getValues()
          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 pushState()
          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 Detail

close

void close()
           throws SqlJetException
Close B-Tree table cursor.

Throws:
SqlJetException

lock

void lock()
          throws SqlJetException
Lock B-Tree table cursor's mutex.

Throws:
SqlJetException

unlock

void unlock()
Unlock B-Tree table cursror's mutex.


eof

boolean eof()
            throws SqlJetException
Check of end of B-Tree table cursor.

Returns:
true if there is not more records.
Throws:
SqlJetException

first

boolean first()
              throws SqlJetException
Go to first record.

Returns:
true if there is at least one record.
Throws:
SqlJetException

last

boolean last()
             throws SqlJetException
Go to last record.

Returns:
true if there is at least one record.
Throws:
SqlJetException

next

boolean next()
             throws SqlJetException
Go to next record.

Returns:
true if there is at least one record and end of cursor is not reached yet
Throws:
SqlJetException

previous

boolean previous()
                 throws SqlJetException
Go to previous record.

Returns:
true if there is at least one record and begin of cursor is not reached yet
Throws:
SqlJetException

getRecord

ISqlJetBtreeRecord getRecord()
                             throws SqlJetException
Returns:
Throws:
SqlJetException

lockTable

void lockTable(boolean write)
Parameters:
write -

getEncoding

SqlJetEncoding getEncoding()
                           throws SqlJetException
Returns:
Throws:
SqlJetException

getFieldsCount

int getFieldsCount()
                   throws SqlJetException
Get count of fields in current record.

Returns:
count of fields
Throws:
SqlJetException

getFieldType

SqlJetValueType getFieldType(int field)
                             throws SqlJetException
Get type of field.

Parameters:
field - number of field begin from zero
Returns:
type of field
Throws:
SqlJetException

isNull

boolean isNull(int field)
               throws SqlJetException
Check to field has null value.

Parameters:
field - number of field begin from zero
Returns:
true if field value is null
Throws:
SqlJetException

getString

java.lang.String getString(int field)
                           throws SqlJetException
Get field's value as string.

Parameters:
field - number of field begin from zero
Returns:
field's value as string
Throws:
SqlJetException

getInteger

long getInteger(int field)
                throws SqlJetException
Get field's value as integer.

Parameters:
field - number of field begin from zero
Returns:
field's value as integer
Throws:
SqlJetException

getFloat

double getFloat(int field)
                throws SqlJetException
Get field's value as real (float).

Parameters:
field - number of field begin from zero
Returns:
field's value as real
Throws:
SqlJetException

getBlob

ISqlJetMemoryPointer getBlob(int field)
                             throws SqlJetException
Get field's value as BLOB.

Parameters:
field - number of field begin from zero
Returns:
field's value as BLOB
Throws:
SqlJetException

getValues

java.lang.Object[] getValues()
                             throws SqlJetException
Get values as objects.

Returns:
Throws:
SqlJetException

getValue

java.lang.Object getValue(int field)
                          throws SqlJetException
Get value as object.

Parameters:
field -
Returns:
Throws:
SqlJetException

hasMoved

boolean hasMoved()
                 throws SqlJetException
Returns true if cursor has been moved. Side effect of this is restore position of cursor.

Returns:
Throws:
SqlJetException

clear

void clear()
           throws SqlJetException
Throws:
SqlJetException

delete

void delete()
            throws SqlJetException
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

int moveTo(ISqlJetMemoryPointer pKey,
           long nKey,
           boolean bias)
           throws SqlJetException
Parameters:
pKey -
nKey -
bias -
Returns:
Throws:
SqlJetException

getKeySize

long getKeySize()
                throws SqlJetException
Returns:
Throws:
SqlJetException

newRowId

long newRowId(long prev)
              throws SqlJetException
Parameters:
prev -
Returns:
Throws:
SqlJetException

newRowId

long newRowId()
              throws SqlJetException
Returns:
Throws:
SqlJetException

pushState

void pushState()
               throws SqlJetException
Saves current state of this table and sets it to point to the first record.

Throws:
SqlJetException

popState

boolean popState()
                 throws SqlJetException
Restores previously saved state if there any.

Returns:
Throws:
SqlJetException