com.healthmarketscience.jackcess.impl

Class IndexData.Entry

java.lang.Object

com.healthmarketscience.jackcess.impl.IndexData.Entry

All Implemented Interfaces:

java.lang.Comparable<IndexData.Entry>

Direct Known Subclasses:

IndexData.NodeEntry

Enclosing class:

IndexData

public static class IndexData.Entry
extends java.lang.Object
implements java.lang.Comparable<IndexData.Entry>

A single leaf entry in an index (points to a single row)

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	_entryBytes the entry value
private RowIdImpl	_rowId page/row on which this row is stored
private IndexData.EntryType	_type comparable type for the entry

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Entry(byte[] entryBytes, RowIdImpl rowId) Create a new entry
private	Entry(byte[] entryBytes, RowIdImpl rowId, IndexData.EntryType type) Create a new entry
private	Entry(java.nio.ByteBuffer buffer, int entryLen) Read an existing entry in from a buffer
private	Entry(java.nio.ByteBuffer buffer, int entryLen, int extraTrailingLen) Read an existing entry in from a buffer

Method Summary

Modifier and Type	Method and Description
protected IndexData.Entry	asNodeEntry(java.lang.Integer subPageNumber) Returns a copy of this entry as a node Entry with the given subPageNumber.
int	compareTo(IndexData.Entry other)
protected org.apache.commons.lang.builder.ToStringBuilder	entryBytesToStringBuilder(org.apache.commons.lang.builder.ToStringBuilder sb)
boolean	equals(java.lang.Object o)
boolean	equalsEntryBytes(IndexData.Entry o)
protected byte[]	getEntryBytes()
RowIdImpl	getRowId()
java.lang.Integer	getSubPageNumber()
IndexData.EntryType	getType()
int	hashCode()
boolean	isLeafEntry()
boolean	isValid()
protected int	size() Size of this entry in the db.
java.lang.String	toString()
protected void	write(java.nio.ByteBuffer buffer, byte[] prefix) Write this entry into a buffer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_rowId

private final RowIdImpl _rowId

page/row on which this row is stored

_entryBytes

private final byte[] _entryBytes

the entry value

_type

private final IndexData.EntryType _type

comparable type for the entry

Constructor Detail

Entry

private Entry(byte[] entryBytes,
              RowIdImpl rowId,
              IndexData.EntryType type)

Create a new entry

Parameters:

entryBytes - encoded bytes for this index entry

rowId - rowId in which the row is stored

type - the type of the entry

Entry

private Entry(byte[] entryBytes,
              RowIdImpl rowId)

Create a new entry

Parameters:

entryBytes - encoded bytes for this index entry

rowId - rowId in which the row is stored

Entry

private Entry(java.nio.ByteBuffer buffer,
              int entryLen)
       throws java.io.IOException

Read an existing entry in from a buffer

Throws:

java.io.IOException

Entry

private Entry(java.nio.ByteBuffer buffer,
              int entryLen,
              int extraTrailingLen)
       throws java.io.IOException

Read an existing entry in from a buffer

Throws:

java.io.IOException

Method Detail

getRowId

public RowIdImpl getRowId()

getType

public IndexData.EntryType getType()

getSubPageNumber

public java.lang.Integer getSubPageNumber()

isLeafEntry

public boolean isLeafEntry()

isValid

public boolean isValid()

getEntryBytes

protected final byte[] getEntryBytes()

size

protected int size()

Size of this entry in the db.

write

protected void write(java.nio.ByteBuffer buffer,
                     byte[] prefix)
              throws java.io.IOException

Write this entry into a buffer

Throws:

java.io.IOException

entryBytesToStringBuilder

protected final org.apache.commons.lang.builder.ToStringBuilder entryBytesToStringBuilder(org.apache.commons.lang.builder.ToStringBuilder sb)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsEntryBytes

public boolean equalsEntryBytes(IndexData.Entry o)

Returns:

true iff the entryBytes are equal between this Entry and the given Entry

compareTo

public int compareTo(IndexData.Entry other)

Specified by:

compareTo in interface java.lang.Comparable<IndexData.Entry>

asNodeEntry

protected IndexData.Entry asNodeEntry(java.lang.Integer subPageNumber)

Returns a copy of this entry as a node Entry with the given subPageNumber.