hyracks-storage-am-common/src/main/java/edu/uci/ics/hyracks/storage/am/common/api/ITreeIndexFrame.java

/*
 * Copyright 2009-2010 by The Regents of the University of California
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * you may obtain a copy of the License from
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package edu.uci.ics.hyracks.storage.am.common.api;

import java.nio.ByteBuffer;

import edu.uci.ics.hyracks.api.dataflow.value.ISerializerDeserializer;
import edu.uci.ics.hyracks.api.exceptions.HyracksDataException;
import edu.uci.ics.hyracks.dataflow.common.data.accessors.ITupleReference;
import edu.uci.ics.hyracks.storage.am.common.frames.FrameOpSpaceStatus;
import edu.uci.ics.hyracks.storage.am.common.ophelpers.MultiComparator;
import edu.uci.ics.hyracks.storage.common.buffercache.ICachedPage;

public interface ITreeIndexFrame {
	public void setPage(ICachedPage page);

	public ICachedPage getPage();

	public ByteBuffer getBuffer();

	public int findTupleIndex(ITupleReference tuple, MultiComparator cmp)
			throws Exception;

	public void insert(ITupleReference tuple, MultiComparator cmp,
			int tupleIndex) throws Exception;

	public void update(int rid, ITupleReference tuple) throws Exception;

	public void delete(ITupleReference tuple, MultiComparator cmp,
			boolean exactDelete) throws Exception;

	// returns true if slots were modified, false otherwise
	public boolean compact(MultiComparator cmp);

	public boolean compress(MultiComparator cmp) throws HyracksDataException;

	public void initBuffer(byte level);

	public int getTupleCount();

	// assumption: page must be write-latched at this point
	public FrameOpSpaceStatus hasSpaceInsert(ITupleReference tuple,
			MultiComparator cmp);

	public FrameOpSpaceStatus hasSpaceUpdate(int rid, ITupleReference tuple,
			MultiComparator cmp);

	public int getTupleOffset(int slotNum);

	public int getTotalFreeSpace();

	public void setPageLsn(int pageLsn);

	public int getPageLsn();

	// for debugging
	public void printHeader();

	public String printKeys(MultiComparator cmp,
			ISerializerDeserializer[] fields) throws HyracksDataException;

	// TODO; what if tuples more than half-page size?
	public int split(ITreeIndexFrame rightFrame, ITupleReference tuple,
			MultiComparator cmp, ISplitKey splitKey) throws Exception;

	public ISlotManager getSlotManager();

	// ATTENTION: in b-tree operations it may not always be possible to
	// determine whether an ICachedPage is a leaf or interior node
	// a compatible interior and leaf implementation MUST return identical
	// values when given the same ByteBuffer for the functions below
	public boolean isLeaf();

	public boolean isInterior();

	public byte getLevel();

	public void setLevel(byte level);

	public boolean getSmFlag(); // structure modification flag

	public void setSmFlag(boolean smFlag);

	public int getSlotSize();

	// TODO: should be removed after new tuple format
	public void setPageTupleFieldCount(int fieldCount);

	// for debugging
	public int getFreeSpaceOff();

	public void setFreeSpaceOff(int freeSpace);

	public ITreeIndexTupleWriter getTupleWriter();

	public int getPageHeaderSize();
}