Package org.tmatesoft.sqljet.core.internal.table

Class SqlJetBtreeDataTable

java.lang.Object

org.tmatesoft.sqljet.core.internal.table.SqlJetBtreeTable

org.tmatesoft.sqljet.core.internal.table.SqlJetBtreeDataTable

All Implemented Interfaces:

ISqlJetBtreeDataTable, ISqlJetBtreeTable

public class SqlJetBtreeDataTable
extends SqlJetBtreeTable
implements ISqlJetBtreeDataTable

Author:

TMate Software Ltd., Sergey Scherbina (sergey.scherbina@gmail.com)

Nested Class Summary

Nested classes/interfaces inherited from class org.tmatesoft.sqljet.core.internal.table.SqlJetBtreeTable

SqlJetBtreeTable.State

Field Summary

Fields inherited from class org.tmatesoft.sqljet.core.internal.table.SqlJetBtreeTable

btree, index, rootPage, write

Constructor Summary

Constructors

Constructor	Description
SqlJetBtreeDataTable(ISqlJetBtree btree, String tableName, boolean write)	Open data table by name.

Method Summary

Modifier and Type	Method	Description
boolean	checkIndex(String indexName, Object[] key)	Check the current record is equal to key using definition of index.
void	clear()
void	close()	Close B-Tree table cursor.
void	delete()	Delete curent record.
void	delete(long rowId)	Delete record by row's ID.
ISqlJetTableDef	getDefinition()	Get table's schema definition.
ISqlJetBtreeIndexTable	getIndex(String indexName)
Map<String,ISqlJetIndexDef>	getIndexDefinitions()	Get definitions of table's indexes.
Map<String,ISqlJetBtreeIndexTable>	getIndexesTables()	Get indexes which are related with table.
long	getInteger(int field)	Get field's value as integer.
Object[]	getKeyForIndex(Object[] fields, ISqlJetIndexDef indexDef)
String	getPrimaryKeyIndex()	Get name of index which has been auto-created for primary key.
long	getRowId()	Get current rowID.
static long	getRowIdFromValues(Map<String,Object> values)
Object	getValue(int field)	Get value as object.
protected ISqlJetVdbeMem	getValueMem(int field)
boolean	goToRow(long rowId)	Go to record with given rowID.
long	insert(SqlJetConflictAction onConflict, Object... values)	Write an new entry into the table.
long	insert(SqlJetConflictAction onConflict, Map<String,Object> values)	Insert record by values by names of fields.
long	insertWithRowId(SqlJetConflictAction onConflict, long rowId, Object[] values)
static boolean	isFieldNameRowId(String fieldName)
boolean	isIndexExists(String indexName)
boolean	isNull(int field)	Check to field has null value.
boolean	locate(String indexName, boolean next, Object... key)	Locate record which using index by key.
long	newRowId()
void	update(SqlJetConflictAction onConflict, long rowId, Object... values)	Update an entry in the table by rowId.
void	update(SqlJetConflictAction onConflict, long rowId, Map<String,Object> values)
void	update(SqlJetConflictAction onConflict, Map<String,Object> values)
void	updateCurrent(SqlJetConflictAction onConflict, Object... values)	Update the current entry in the table.
long	updateCurrentWithRowId(SqlJetConflictAction onConflict, long newRowId, Object... values)	Update the rowId and values in current entry in the table.
long	updateWithRowId(SqlJetConflictAction onConflict, long rowId, long newRowId, Object... values)	Update the rowId and values an entry in the table by rowId.

Methods inherited from class org.tmatesoft.sqljet.core.internal.table.SqlJetBtreeTable

adjustKeyInfo, checkField, clearRecordCache, eof, first, getBlob, getCursor, getEncoding, getFieldsCount, getFieldType, getFloat, getKeyInfo, getKeySize, getRecord, getString, getValues, getValueUncached, hasMoved, insert, last, lock, lockTable, moveTo, newRowId, next, popState, previous, pushState, unlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.tmatesoft.sqljet.core.internal.table.ISqlJetBtreeTable

eof, first, getBlob, getEncoding, getFieldsCount, getFieldType, getFloat, getKeySize, getRecord, getString, getValues, hasMoved, insert, last, lock, lockTable, moveTo, newRowId, next, popState, previous, pushState, unlock

Constructor Details

SqlJetBtreeDataTable

public SqlJetBtreeDataTable(ISqlJetBtree btree,
 String tableName,
 boolean write)
                     throws SqlJetException

Open data table by name.

Throws:

SqlJetException

Method Details

close

public void close()
           throws SqlJetException

Description copied from interface: ISqlJetBtreeTable

Close B-Tree table cursor.

Specified by:

close in interface ISqlJetBtreeTable

Overrides:

close in class SqlJetBtreeTable

Throws:

SqlJetException

getDefinition

public ISqlJetTableDef getDefinition()

Description copied from interface: ISqlJetBtreeDataTable

Get table's schema definition.

Specified by:

getDefinition in interface ISqlJetBtreeDataTable

Returns:

the tableDef

getIndexDefinitions

public Map<String,ISqlJetIndexDef> getIndexDefinitions()

Description copied from interface: ISqlJetBtreeDataTable

Get definitions of table's indexes.

Specified by:

getIndexDefinitions in interface ISqlJetBtreeDataTable

Returns:

the indexesDefs

goToRow

public boolean goToRow(long rowId)
                throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Go to record with given rowID. Return boolean to indicate success.

Specified by:

goToRow in interface ISqlJetBtreeDataTable

Parameters:

rowId -

Returns:

Throws:

SqlJetException

getRowId

public long getRowId()
              throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Get current rowID.

Specified by:

getRowId in interface ISqlJetBtreeDataTable

Returns:

Throws:

SqlJetException

insert

public long insert(SqlJetConflictAction onConflict,
 Object... values)
            throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Write an new entry into the table.

Specified by:

insert in interface ISqlJetBtreeDataTable

Parameters:

values -

Throws:

SqlJetException

insertWithRowId

public long insertWithRowId(SqlJetConflictAction onConflict,
 long rowId,
 Object[] values)
                     throws SqlJetException

Specified by:

insertWithRowId in interface ISqlJetBtreeDataTable

Parameters:

rowId -

values -

Returns:

Throws:

SqlJetException

newRowId

public long newRowId()
              throws SqlJetException

Specified by:

newRowId in interface ISqlJetBtreeTable

Overrides:

newRowId in class SqlJetBtreeTable

Returns:

Throws:

SqlJetException

update

public void update(SqlJetConflictAction onConflict,
 long rowId,
 Object... values)
            throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Update an entry in the table by rowId.

Specified by:

update in interface ISqlJetBtreeDataTable

Parameters:

rowId -

values -

Throws:

SqlJetException

updateCurrent

public void updateCurrent(SqlJetConflictAction onConflict,
 Object... values)
                   throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Update the current entry in the table.

Specified by:

updateCurrent in interface ISqlJetBtreeDataTable

Parameters:

values -

Throws:

SqlJetException

updateWithRowId

public long updateWithRowId(SqlJetConflictAction onConflict,
 long rowId,
 long newRowId,
 Object... values)
                     throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Update the rowId and values an entry in the table by rowId.

Specified by:

updateWithRowId in interface ISqlJetBtreeDataTable

Parameters:

rowId -

values -

Throws:

SqlJetException

updateCurrentWithRowId

public long updateCurrentWithRowId(SqlJetConflictAction onConflict,
 long newRowId,
 Object... values)
                            throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Update the rowId and values in current entry in the table.

Specified by:

updateCurrentWithRowId in interface ISqlJetBtreeDataTable

Parameters:

values -

Throws:

SqlJetException

delete

public void delete(long rowId)
            throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Delete record by row's ID.

Specified by:

delete in interface ISqlJetBtreeDataTable

Parameters:

rowId -

Throws:

SqlJetException

delete

public void delete()
            throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Delete curent record.

Specified by:

delete in interface ISqlJetBtreeDataTable

Specified by:

delete in interface ISqlJetBtreeTable

Overrides:

delete in class SqlJetBtreeTable

Throws:

SqlJetException

getKeyForIndex

public Object[] getKeyForIndex(Object[] fields,
 ISqlJetIndexDef indexDef)

checkIndex

public boolean checkIndex(String indexName,
 Object[] key)
                   throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Check the current record is equal to key using definition of index.

Specified by:

checkIndex in interface ISqlJetBtreeDataTable

Parameters:

indexName -

key -

Returns:

Throws:

SqlJetException

getPrimaryKeyIndex

public String getPrimaryKeyIndex()

Description copied from interface: ISqlJetBtreeDataTable

Get name of index which has been auto-created for primary key.

Specified by:

getPrimaryKeyIndex in interface ISqlJetBtreeDataTable

Returns:

the primaryKeyIndex

locate

public boolean locate(String indexName,
 boolean next,
 Object... key)
               throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Locate record which using index by key. Key is values for fields which are defined in index. If record is found then returns true. If next is true then locate record by next entry in index for key.

Specified by:

locate in interface ISqlJetBtreeDataTable

Parameters:

indexName -

next -

key -

Returns:

Throws:

SqlJetException

getIndexesTables

public Map<String,ISqlJetBtreeIndexTable> getIndexesTables()

Description copied from interface: ISqlJetBtreeDataTable

Get indexes which are related with table.

Specified by:

getIndexesTables in interface ISqlJetBtreeDataTable

Returns:

the indexesTables

insert

public long insert(SqlJetConflictAction onConflict,
 Map<String,Object> values)
            throws SqlJetException

Description copied from interface: ISqlJetBtreeDataTable

Insert record by values by names of fields.

Specified by:

insert in interface ISqlJetBtreeDataTable

Parameters:

values -

Returns:

Throws:

SqlJetException

update

public void update(SqlJetConflictAction onConflict,
 long rowId,
 Map<String,Object> values)
            throws SqlJetException

Specified by:

update in interface ISqlJetBtreeDataTable

Parameters:

rowId -

values -

Throws:

SqlJetException

update

public void update(SqlJetConflictAction onConflict,
 Map<String,Object> values)
            throws SqlJetException

Specified by:

update in interface ISqlJetBtreeDataTable

Parameters:

values -

Throws:

SqlJetException

getInteger

public long getInteger(int field)
                throws SqlJetException

Description copied from interface: ISqlJetBtreeTable

Get field's value as integer.

Specified by:

getInteger in interface ISqlJetBtreeTable

Overrides:

getInteger in class SqlJetBtreeTable

Parameters:

field - number of field begin from zero

Returns:

field's value as integer

Throws:

SqlJetException

getValue

public Object getValue(int field)
                throws SqlJetException

Description copied from interface: ISqlJetBtreeTable

Get value as object.

Specified by:

getValue in interface ISqlJetBtreeTable

Overrides:

getValue in class SqlJetBtreeTable

Parameters:

field -

Returns:

Throws:

SqlJetException

isIndexExists

public boolean isIndexExists(String indexName)

Specified by:

isIndexExists in interface ISqlJetBtreeDataTable

Parameters:

indexName -

Returns:

isFieldNameRowId

public static boolean isFieldNameRowId(String fieldName)

getRowIdFromValues

public static long getRowIdFromValues(Map<String,Object> values)
                               throws SqlJetException

Throws:

SqlJetException

clear

public void clear()
           throws SqlJetException

Specified by:

clear in interface ISqlJetBtreeTable

Overrides:

clear in class SqlJetBtreeTable

Throws:

SqlJetException

getValueMem

protected ISqlJetVdbeMem getValueMem(int field)
                              throws SqlJetException

Overrides:

getValueMem in class SqlJetBtreeTable

Throws:

SqlJetException

getIndex

public ISqlJetBtreeIndexTable getIndex(String indexName)

Specified by:

getIndex in interface ISqlJetBtreeDataTable

Parameters:

indexName -

Returns:

isNull

public boolean isNull(int field)
               throws SqlJetException

Description copied from interface: ISqlJetBtreeTable

Check to field has null value.

Specified by:

isNull in interface ISqlJetBtreeTable

Overrides:

isNull in class SqlJetBtreeTable

Parameters:

field - number of field begin from zero

Returns:

true if field value is null

Throws:

SqlJetException