net.sf.joafip.btreeplus.entity

Class NonTerminalPage

java.lang.Object

net.sf.joafip.btreeplus.entity.AbstractElement

net.sf.joafip.btreeplus.entity.AbstractNodePage

net.sf.joafip.btreeplus.entity.NonTerminalPage

All Implemented Interfaces:

INonTerminalPage, IPageRecordable, IStateStored

@NotStorableClass
public class NonTerminalPage
extends AbstractNodePage
implements INonTerminalPage

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEAD_TAIL_SIZE
static int	MAX_NUMBER_OF_ENTRIES

Fields inherited from class net.sf.joafip.btreeplus.entity.AbstractNodePage

longKey

Constructor Summary

Constructors

Constructor and Description
NonTerminalPage(int numberOfKeyEntries, boolean longKey) not static set creation
NonTerminalPage(int numberOfKeyEntries, DataRecordIdentifier[] keys, long[] pagePosition, boolean longKey)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(ILeafPage existingLeftILeafPage, ILeafPage newRightILeafPage)
boolean	add(INonTerminalPage leftSonNonTerminalPage, DataRecordIdentifier middleKey, INonTerminalPage rightSonNonTerminalPage)
boolean	checkKeys() for assertion
DataRecordIdentifier	getAndClearMiddleKey() get and clear middle key computed by split()
int	getByteSize()
DataRecordIdentifier	getFirstKey()
int	getIndex(DataRecordIdentifier dataRecordIdentifier)
int	getInParentIndex()
DataRecordIdentifier	getKey(int index)
DataRecordIdentifier	getLastKey()
long	getLastPagePosition()
int	getNumberOfKeyEntries()
int	getNumberOfPage() the number of pages take is fix
long	getPagePointer(int index)
IPageRecordable	getParentPage()
EnumRecordType	getRecordType()
void	remove(int leafPageInParentIndex)
void	setEntry(int index, long pagePointer, DataRecordIdentifier key)
boolean	setKey(int index, DataRecordIdentifier key) change key
void	setParentPage(IPageRecordable parentPage, int inParentIndex)
INonTerminalPage	split()
int	tryBalanceOrMerge(DataRecordIdentifier middleKey, NonTerminalPage rightNonTerminalPage) update this#middleKey if do not merge
void	updateByteSize()
void	updateByteSizeAcceptBigger()
boolean	wellFilled()

Methods inherited from class net.sf.joafip.btreeplus.entity.AbstractNodePage

entrySize

Methods inherited from class net.sf.joafip.btreeplus.entity.AbstractElement

getPageRecord, getPositionInFile, getPreviousRecordPositionInFile, setPageRecord, setValueIsChangedValueToSave, setValueIsNotChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.joafip.btreeplus.entity.INonTerminalPage

getPositionInFile

Methods inherited from interface net.sf.joafip.btreeplus.entity.IPageRecordable

getPageRecord, setPageRecord

Methods inherited from interface net.sf.joafip.btreeplus.entity.IStateStored

setValueIsChangedValueToSave, setValueIsNotChanged

Field Detail

HEAD_TAIL_SIZE

public static final int HEAD_TAIL_SIZE

See Also:

Constant Field Values

MAX_NUMBER_OF_ENTRIES

public static final int MAX_NUMBER_OF_ENTRIES

See Also:

Constant Field Values

Constructor Detail

NonTerminalPage

public NonTerminalPage(int numberOfKeyEntries,
               boolean longKey)

not static set creation

Parameters:

numberOfKeyEntries -

longKey -

NonTerminalPage

@Fortest
public NonTerminalPage(int numberOfKeyEntries,
                       DataRecordIdentifier[] keys,
                       long[] pagePosition,
                       boolean longKey)
                throws HeapException

Throws:

HeapException

Method Detail

getRecordType

public EnumRecordType getRecordType()

Specified by:

getRecordType in interface IPageRecordable

getNumberOfPage

public int getNumberOfPage()

Description copied from interface: IPageRecordable

the number of pages take is fix

Specified by:

getNumberOfPage in interface IPageRecordable

Returns:

number of page take by the record

setParentPage

public void setParentPage(IPageRecordable parentPage,
                 int inParentIndex)

Specified by:

setParentPage in interface IPageRecordable

getParentPage

public IPageRecordable getParentPage()

Specified by:

getParentPage in interface IPageRecordable

getInParentIndex

public int getInParentIndex()
                     throws HeapException

Specified by:

getInParentIndex in interface INonTerminalPage

Specified by:

getInParentIndex in interface IPageRecordable

Throws:

HeapException

setEntry

public void setEntry(int index,
            long pagePointer,
            DataRecordIdentifier key)
              throws HeapException

Throws:

HeapException

setKey

public boolean setKey(int index,
             DataRecordIdentifier key)
               throws HeapException

change key

Parameters:

index -

key -

Returns:

true if not need to split (not too big)

Throws:

HeapException

getByteSize

public int getByteSize()

Specified by:

getByteSize in interface IPageRecordable

Returns:

byte size of the element

updateByteSize

public final void updateByteSize()
                          throws HeapException

Specified by:

updateByteSize in interface IPageRecordable

Throws:

HeapException

updateByteSizeAcceptBigger

@Fortest
public void updateByteSizeAcceptBigger()
                                throws HeapException

Throws:

HeapException

getNumberOfKeyEntries

public int getNumberOfKeyEntries()

Specified by:

getNumberOfKeyEntries in interface INonTerminalPage

getPagePointer

public long getPagePointer(int index)

Specified by:

getPagePointer in interface INonTerminalPage

getKey

public DataRecordIdentifier getKey(int index)

Specified by:

getKey in interface INonTerminalPage

getIndex

public int getIndex(DataRecordIdentifier dataRecordIdentifier)

Parameters:

dataRecordIdentifier -

Returns:

sub page index for data record identifier

add

public boolean add(ILeafPage existingLeftILeafPage,
          ILeafPage newRightILeafPage)
            throws HeapException

Parameters:

existingLeftILeafPage -

newRightILeafPage -

Returns:

true if add not need split

Throws:

HeapException

add

public boolean add(INonTerminalPage leftSonNonTerminalPage,
          DataRecordIdentifier middleKey,
          INonTerminalPage rightSonNonTerminalPage)
            throws HeapException

Parameters:

leftSonNonTerminalPage -

middleKey -

rightSonNonTerminalPage -

Returns:

true if add not need split

Throws:

HeapException

split

public INonTerminalPage split()
                       throws HeapException

Throws:

HeapException

getAndClearMiddleKey

public DataRecordIdentifier getAndClearMiddleKey()

get and clear middle key computed by split()

Returns:

middle key computed by split()

remove

public void remove(int leafPageInParentIndex)

wellFilled

public boolean wellFilled()

tryBalanceOrMerge

public int tryBalanceOrMerge(DataRecordIdentifier middleKey,
                    NonTerminalPage rightNonTerminalPage)
                      throws HeapException

update this#middleKey if do not merge

Parameters:

middleKey -

rightNonTerminalPage -

Returns:

0 if merged, 1 if balanced, or 2 if no changes

Throws:

HeapException

getLastKey

public DataRecordIdentifier getLastKey()

Specified by:

getLastKey in class AbstractNodePage

getLastPagePosition

public long getLastPagePosition()

getFirstKey

public DataRecordIdentifier getFirstKey()

checkKeys

public final boolean checkKeys()

for assertion

Returns:

true if keys ok