org.tmatesoft.sqljet.core.internal.vdbe

Class SqlJetUnpackedRecord

java.lang.Object

org.tmatesoft.sqljet.core.internal.vdbe.SqlJetUnpackedRecord

All Implemented Interfaces:

ISqlJetReleasable, ISqlJetUnpackedRecord

public class SqlJetUnpackedRecord
extends java.lang.Object
implements ISqlJetUnpackedRecord

Author:

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

Constructor Summary

Constructors

Constructor and Description
SqlJetUnpackedRecord()

Method Summary

Modifier and Type	Method and Description
static void	delete(SqlJetUnpackedRecord p)
java.util.Set<SqlJetUnpackedRecordFlags>	getFlags()
int	recordCompare(int nKey1, ISqlJetMemoryPointer pKey1) This function compares the two table rows or index records specified by {nKey1, pKey1} and pPKey2.
void	release()
void	setFlags(java.util.Set<SqlJetUnpackedRecordFlags> flags)

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlJetUnpackedRecord

public SqlJetUnpackedRecord()

Method Detail

delete

public static void delete(SqlJetUnpackedRecord p)

recordCompare

public int recordCompare(int nKey1,
                         ISqlJetMemoryPointer pKey1)
                  throws SqlJetException

Description copied from interface: ISqlJetUnpackedRecord

This function compares the two table rows or index records specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero or positive integer if key1 is less than, equal to or greater than key2. The {nKey1, pKey1} key must be a blob created by th OP_MakeRecord opcode of the VDBE. The pPKey2 key must be a parsed key such as obtained from sqlite3VdbeParseRecord. Key1 and Key2 do not have to contain the same number of fields. The key with fewer fields is usually compares less than the longer key. However if the UNPACKED_INCRKEY flags in pPKey2 is set and the common prefixes are equal, then key1 is less than key2. Or if the UNPACKED_MATCH_PREFIX flag is set and the prefixes are equal, then the keys are considered to be equal and the parts beyond the common prefix are ignored. If the UNPACKED_IGNORE_ROWID flag is set, then the last byte of the header of pKey1 is ignored. It is assumed that pKey1 is an index key, and thus ends with a rowid value. The last byte of the header will therefore be the serial type of the rowid: one of 1, 2, 3, 4, 5, 6, 8, or 9 - the integer serial types. The serial type of the final rowid will always be a single byte. By ignoring this last byte of the header, we force the comparison to ignore the rowid at the end of key1.

Specified by:

recordCompare in interface ISqlJetUnpackedRecord

Returns:

Throws:

SqlJetException

getFlags

public java.util.Set<SqlJetUnpackedRecordFlags> getFlags()

Returns:

the flags

setFlags

public void setFlags(java.util.Set<SqlJetUnpackedRecordFlags> flags)

Parameters:

flags - the flags to set

release

public void release()

Specified by:

release in interface ISqlJetReleasable