org.hsqldb.index.NodeAVLDisk Maven / Gradle / Ivy
Show all versions of hsqldb Show documentation
/*
* For work developed by the HSQL Development Group:
*
* Copyright (c) 2001-2024, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
*
* For work originally developed by the Hypersonic SQL Group:
*
* Copyright (c) 1995-2000, The Hypersonic SQL Group.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the Hypersonic SQL Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE HYPERSONIC SQL GROUP,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* on behalf of the Hypersonic SQL Group.
*/
package org.hsqldb.index;
import org.hsqldb.RowAVL;
import org.hsqldb.RowAVLDisk;
import org.hsqldb.Table;
import org.hsqldb.lib.LongLookup;
import org.hsqldb.persist.PersistentStore;
import org.hsqldb.rowio.RowInputInterface;
import org.hsqldb.rowio.RowOutputInterface;
// fredt@users 20020221 - patch 513005 by sqlbob@users (RMP)
// fredt@users 20020920 - path 1.7.1 - refactoring to cut memory footprint
// fredt@users 20021205 - path 1.7.2 - enhancements
/**
* Cached table Node implementation.
* Only integral references to left, right and parent nodes in the AVL tree
* are held and used as pointers data.
*
* iId is a reference to the Index object that contains this node.
* This fields can be eliminated in the future, by changing the
* method signatures to take an Index parameter from Index.java (fredt@users)
*
* New class derived from Hypersonic SQL code and enhanced in HSQLDB.
*
* @author Fred Toussi (fredt@users dot sourceforge dot net)
* @author Thomas Mueller (Hypersonic SQL Group)
* @version 2.6.0
* @since Hypersonic SQL
*/
public class NodeAVLDisk extends NodeAVL {
private int iLeft = NO_POS;
private int iRight = NO_POS;
private int iParent = NO_POS;
private int iId; // id of Index object for this Node
public static final int SIZE_IN_BYTE = 4 * 4;
public NodeAVLDisk(RowAVLDisk r, RowInputInterface in, int id) {
super(r);
iId = id;
iBalance = in.readInt();
iLeft = in.readInt();
iRight = in.readInt();
iParent = in.readInt();
if (iLeft <= 0) {
iLeft = NO_POS;
}
if (iRight <= 0) {
iRight = NO_POS;
}
if (iParent <= 0) {
iParent = NO_POS;
}
}
public NodeAVLDisk(RowAVLDisk r, int id) {
super(r);
iId = id;
}
public void delete() {
iLeft = NO_POS;
iRight = NO_POS;
iParent = NO_POS;
nLeft = null;
nRight = null;
nParent = null;
iBalance = 0;
((RowAVLDisk) row).setNodesChanged();
}
public boolean isInMemory() {
return row.isInMemory();
}
public boolean isMemory() {
return false;
}
public long getPos() {
return row.getPos();
}
public RowAVL getRow(PersistentStore store) {
return (RowAVLDisk) store.get(this.row, false);
}
public Object[] getData(PersistentStore store) {
return row.getData();
}
private NodeAVLDisk findNode(PersistentStore store) {
if (row.isInMemory()) {
return this;
}
RowAVLDisk r = (RowAVLDisk) store.get(row.getPos(), false);
if (r == null) {
String tableName = "";
if (row.getTable().getTableType() == Table.CACHED_TABLE) {
tableName = ((Table) row.getTable()).getName().name;
}
store.getCache()
.logSevereEvent(
tableName + " NodeAVLDisk " + row.getPos(),
null);
return this;
}
return (NodeAVLDisk) r.getNode(iId);
}
private NodeAVLDisk findNode(PersistentStore store, long pos) {
NodeAVLDisk ret = null;
RowAVLDisk r = (RowAVLDisk) store.get(pos, false);
if (r != null) {
ret = (NodeAVLDisk) r.getNode(iId);
}
return ret;
}
boolean isLeft(PersistentStore store, NodeAVL n) {
NodeAVLDisk node = findNode(store);
if (n == null) {
return node.iLeft == NO_POS;
}
return node.iLeft == n.getPos();
}
boolean isRight(PersistentStore store, NodeAVL n) {
NodeAVLDisk node = findNode(store);
if (n == null) {
return node.iRight == NO_POS;
}
return node.iRight == n.getPos();
}
NodeAVL getLeft(PersistentStore store) {
NodeAVLDisk node = findNode(store);
if (node.iLeft == NO_POS) {
return null;
}
return findNode(store, node.iLeft);
}
NodeAVL getRight(PersistentStore store) {
NodeAVLDisk node = findNode(store);
if (node.iRight == NO_POS) {
return null;
}
return findNode(store, node.iRight);
}
NodeAVL getParent(PersistentStore store) {
NodeAVLDisk node = findNode(store);
if (node.iParent == NO_POS) {
return null;
}
return findNode(store, node.iParent);
}
public int getBalance(PersistentStore store) {
NodeAVLDisk node = findNode(store);
return node.iBalance;
}
boolean isRoot(PersistentStore store) {
NodeAVLDisk node = findNode(store);
return node.iParent == NO_POS;
}
boolean isFromLeft(PersistentStore store) {
NodeAVLDisk node = findNode(store);
if (node.iParent == NO_POS) {
return true;
}
NodeAVLDisk temp = findNode(store, node.iParent);
return row.getPos() == temp.iLeft;
}
public NodeAVL child(PersistentStore store, boolean isleft) {
return isleft
? getLeft(store)
: getRight(store);
}
NodeAVL setParent(PersistentStore store, NodeAVL n) {
RowAVLDisk row = (RowAVLDisk) store.get(this.row, true);
NodeAVLDisk node = (NodeAVLDisk) row.getNode(iId);
row.setNodesChanged();
node.iParent = n == null
? NO_POS
: (int) n.getPos();
row.keepInMemory(false);
return node;
}
public NodeAVL setBalance(PersistentStore store, int b) {
RowAVLDisk row = (RowAVLDisk) store.get(this.row, true);
NodeAVLDisk node = (NodeAVLDisk) row.getNode(iId);
row.setNodesChanged();
node.iBalance = b;
row.keepInMemory(false);
return node;
}
NodeAVL setLeft(PersistentStore store, NodeAVL n) {
RowAVLDisk row = (RowAVLDisk) store.get(this.row, true);
NodeAVLDisk node = (NodeAVLDisk) row.getNode(iId);
node.iLeft = n == null
? NO_POS
: (int) n.getPos();
row.setNodesChanged();
row.keepInMemory(false);
return node;
}
NodeAVL setRight(PersistentStore store, NodeAVL n) {
RowAVLDisk row = (RowAVLDisk) store.get(this.row, true);
NodeAVLDisk node = (NodeAVLDisk) row.getNode(iId);
node.iRight = n == null
? NO_POS
: (int) n.getPos();
row.setNodesChanged();
row.keepInMemory(false);
return node;
}
public NodeAVL set(PersistentStore store, boolean isLeft, NodeAVL n) {
NodeAVL x;
if (isLeft) {
x = setLeft(store, n);
} else {
x = setRight(store, n);
}
if (n != null) {
n.setParent(store, x);
}
return x;
}
public void replace(PersistentStore store, Index index, NodeAVL n) {
NodeAVLDisk node = findNode(store);
if (node.iParent == NO_POS) {
if (n != null) {
n = n.setParent(store, null);
}
store.setAccessor(index, n);
} else {
boolean isFromLeft = isFromLeft(store);
getParent(store).set(store, isFromLeft, n);
}
}
boolean equals(NodeAVL n) {
if (n instanceof NodeAVLDisk) {
return this == n || (row.getPos() == n.getPos());
}
return false;
}
public int getRealSize(RowOutputInterface out) {
return NodeAVLDisk.SIZE_IN_BYTE;
}
public void setInMemory(boolean in) {}
public void write(RowOutputInterface out) {
out.writeInt(iBalance);
out.writeInt((iLeft == NO_POS)
? 0
: iLeft);
out.writeInt((iRight == NO_POS)
? 0
: iRight);
out.writeInt((iParent == NO_POS)
? 0
: iParent);
}
public void write(RowOutputInterface out, LongLookup lookup) {
out.writeInt(iBalance);
out.writeInt(getTranslatePointer(iLeft, lookup));
out.writeInt(getTranslatePointer(iRight, lookup));
out.writeInt(getTranslatePointer(iParent, lookup));
}
private static int getTranslatePointer(int pointer, LongLookup lookup) {
int newPointer = 0;
if (pointer != NodeAVL.NO_POS) {
if (lookup == null) {
newPointer = pointer;
} else {
newPointer = (int) lookup.lookup(pointer);
}
}
return newPointer;
}
public void restore() {}
public void destroy() {}
public void updateAccessCount(int count) {}
public int getAccessCount() {
return 0;
}
public void setStorageSize(int size) {}
public int getStorageSize() {
return 0;
}
public void setPos(long pos) {}
public boolean isNew() {
return false;
}
public boolean hasChanged() {
return false;
}
public void setChanged(boolean flag) {}
public boolean isKeepInMemory() {
return false;
}
public boolean keepInMemory(boolean keep) {
return false;
}
long getLeftPos() {
return iLeft;
}
long getRightPos() {
return iRight;
}
long getParentPos() {
return iParent;
}
}