public interface ISqlJetTable
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear table.
|
SqlJetDb |
getDataBase()
Get database connection.
|
ISqlJetTableDef |
getDefinition()
Get table's schema definition.
|
ISqlJetIndexDef |
getIndexDef(java.lang.String name)
Get definition of index by name.
|
java.util.Set<ISqlJetIndexDef> |
getIndexesDefs()
Returns definitions of indices used in this table.
|
java.util.Set<java.lang.String> |
getIndexesNames()
Get table indexes names.
|
java.lang.String |
getPrimaryKeyIndexName()
Returns name of primary key index.
|
long |
insert(java.lang.Object... values)
Add new record to the table with specified values.
|
long |
insertByFieldNames(java.util.Map<java.lang.String,java.lang.Object> values)
Insert record by values by names of fields.
|
long |
insertByFieldNamesOr(SqlJetConflictAction onConflict,
java.util.Map<java.lang.String,java.lang.Object> values)
Insert record by values by names of fields.
|
long |
insertOr(SqlJetConflictAction onConflict,
java.lang.Object... values)
Add new record to the table with specified values.
|
long |
insertWithRowId(long rowId,
java.lang.Object... values)
Inserts record at specified rowId.
|
long |
insertWithRowIdOr(SqlJetConflictAction onConflict,
long rowId,
java.lang.Object... values)
Inserts record at specified rowId.
|
ISqlJetCursor |
lookup(java.lang.String indexName,
java.lang.Object... key)
Open cursor for records which have found by key on index.
|
ISqlJetCursor |
open()
Open cursor for all table records.
|
ISqlJetCursor |
order(java.lang.String indexName)
Open cursors which sorts table by index.
|
ISqlJetCursor |
scope(java.lang.String indexName,
java.lang.Object[] firstKey,
java.lang.Object[] lastKey)
Open cursor which restricts table to some scope of index values.
|
ISqlJetCursor |
scope(java.lang.String indexName,
SqlJetScope scope)
Open cursor which restricts table to some scope of index values.
|
SqlJetDb getDataBase()
java.lang.String getPrimaryKeyIndexName() throws SqlJetException
lookup(String, Object...)
,
scope(String, Object[], Object[])
or order(String)
methods at first parameter.SqlJetException
ISqlJetTableDef getDefinition() throws SqlJetException
SqlJetException
java.util.Set<ISqlJetIndexDef> getIndexesDefs() throws SqlJetException
SqlJetException
java.util.Set<java.lang.String> getIndexesNames() throws SqlJetException
SqlJetException
ISqlJetIndexDef getIndexDef(java.lang.String name) throws SqlJetException
name
- name of index.SqlJetException
ISqlJetCursor open() throws SqlJetException
Open cursor for all table records.
Cursors can be opened only within active transaction. When transaction ends all cursors will be closed.
SqlJetException
ISqlJetCursor lookup(java.lang.String indexName, java.lang.Object... key) throws SqlJetException
Open cursor for records which have found by key on index.
If indexName is NULL then primary key will be used.
Cursors can be opened only within active transaction. When transaction ends all cursors will be closed.
indexName
- Name of the searched index. If null then primary key will be
used.key
- Key for the index lookup.SqlJetException
ISqlJetCursor order(java.lang.String indexName) throws SqlJetException
Open cursors which sorts table by index.
If indexName is NULL then primary key will be used.
Cursors can be opened only within active transaction. When transaction ends all cursors will be closed.
indexName
- name of index which defines ordering.If null then primary key
will be used.SqlJetException
ISqlJetCursor scope(java.lang.String indexName, java.lang.Object[] firstKey, java.lang.Object[] lastKey) throws SqlJetException
Open cursor which restricts table to some scope of index values.
Scope is specified as pair of index keys. First key means start of scope and last key means end of scope. One of these keys (or even both) could be NULL. In this case scope is open from one side (or both sides). If first key is less of last key then cursor will be in reversed order. If indexName is NULL then primary key will be used.
Cursors can be opened only within active transaction. When transaction ends all cursors will be closed.
indexName
- Name of the searched index. If null then primary key will be
used.firstKey
- first key of scope. Could be NULL.lastKey
- first key of scope. Could be NULL.SqlJetException
ISqlJetCursor scope(java.lang.String indexName, SqlJetScope scope) throws SqlJetException
Open cursor which restricts table to some scope of index values.
Scope is specified as pair of index keys. First key means start of scope and last key means end of scope. One of these keys (or even both) could be NULL. In this case scope is open from one side (or both sides). If first key is less of last key then cursor will be in reversed order. If indexName is NULL then primary key will be used.
Cursors can be opened only within active transaction. When transaction ends all cursors will be closed.
indexName
- Name of the searched index. If null then primary key will be
used.scope
- structure that contains both left and right bounds of the requested scope.SqlJetException
long insert(java.lang.Object... values) throws SqlJetException
Add new record to the table with specified values.
Values must be specified by position in table structure. If table have INTEGER PRIMARY KEY column then this column could be null and in this case it value will be defined automatically.
If field has DEFAULT value then it could be passed as null. If fields have DEFAULT value and are last in table structure then they could be not specified.
All relevant indexes are updated automatically.
Returns ROWID of inserted record.
Can be used without of active transaction, in this case method begins and ends own internal transaction.
values
- Values for the new record.SqlJetException
long insertByFieldNames(java.util.Map<java.lang.String,java.lang.Object> values) throws SqlJetException
Insert record by values by names of fields.
If table have INTEGER PRIMARY KEY column then this column could be null or even not specified and in this case it value will be defined automatically.
The ROWID of record could be passed by any of this names: ROWID, _ROWID_, OID. ROWID could be specified even if table haven't INTEGER PRIMARY KEY column.
All relevant indexes are updated automatically.
Returns ROWID of inserted record.
Can be used without of active transaction, in this case method begins and ends own internal transaction.
values
- map of field names with values.SqlJetException
long insertWithRowId(long rowId, java.lang.Object... values) throws SqlJetException
Inserts record at specified rowId. If rowId is 0 then it generates new rowId.
If table has INTEGER PRIMARY KEY column and rowId isn't 0 then value for this field will be ignored and could be specified just as null. If table has INTEGER PRIMARY KEY column and rowId is 0 then value for this field used as rowId.
If field has DEFAULT value then it could be passed as null. If fields have DEFAULT value and are last in table structure then they could be not specified.
All relevant indexes are updated automatically.
Returns ROWID of inserted record.
Can be used without of active transaction, in this case method begins and ends own internal transaction.
rowId
- ROWID of record.values
- Values for the new record.SqlJetException
long insertOr(SqlJetConflictAction onConflict, java.lang.Object... values) throws SqlJetException
Add new record to the table with specified values.
Values must be specified by position in table structure.
If table have INTEGER PRIMARY KEY column then this column could be null and in this case it value will be defined automatically.
If field has DEFAULT value then it could be passed as null. If fields have DEFAULT value and are last in table structure then they could be not specified.
All relevant indexes are updated automatically.
Returns ROWID of inserted record.
Can be used without of active transaction, in this case method begins and ends own internal transaction.
Implements ON CONFLICT clause. See SqlJetConflictAction
.
onConflict
- SqlJetConflictAction
.values
- Values for the new record.SqlJetException
long insertByFieldNamesOr(SqlJetConflictAction onConflict, java.util.Map<java.lang.String,java.lang.Object> values) throws SqlJetException
Insert record by values by names of fields.
If table have INTEGER PRIMARY KEY column then this column could be null or even not specified and in this case it value will be defined automatically.
The ROWID of record could be passed by any of this names: ROWID, _ROWID_, OID. ROWID could be specified even if table haven't INTEGER PRIMARY KEY column.
All relevant indexes are updated automatically.
Returns ROWID of inserted record.
Can be used without of active transaction, in this case method begins and ends own internal transaction.
Implements ON CONFLICT clause. See SqlJetConflictAction
.
onConflict
- SqlJetConflictAction
.values
- Values for the new record.SqlJetException
long insertWithRowIdOr(SqlJetConflictAction onConflict, long rowId, java.lang.Object... values) throws SqlJetException
Inserts record at specified rowId.
If rowId is 0 then it generates new rowId.
If table has INTEGER PRIMARY KEY column and rowId isn't 0 then value for this field will be ignored and could be specified just as null. If table has INTEGER PRIMARY KEY column and rowId is 0 then value for this field used as rowId.
If field has DEFAULT value then it could be passed as null. If fields have DEFAULT value and are last in table structure then they could be not specified.
All relevant indexes are updated automatically.
Returns ROWID of inserted record.
Can be used without of active transaction, in this case method begins and ends own internal transaction.
Implements ON CONFLICT clause. See SqlJetConflictAction
.
onConflict
- SqlJetConflictAction
.rowId
- ROWID of record.values
- Values for the new record.SqlJetException
void clear() throws SqlJetException
SqlJetException
Copyright © 2009-2010 TMate Software Ltd. All Rights Reserved.