jetbrains.exodus.tree.btree

Class BTreeMutable

java.lang.Object

jetbrains.exodus.tree.btree.BTreeBase

jetbrains.exodus.tree.btree.BTreeMutable

All Implemented Interfaces:

ITree, ITreeMutable

public class BTreeMutable
extends BTreeBase
implements ITreeMutable

Field Summary

Fields inherited from class jetbrains.exodus.tree.btree.BTreeBase

allowsDuplicates, balancePolicy, BOTTOM, BOTTOM_ROOT, dataIterator, DUP_BOTTOM, DUP_INTERNAL, DUP_LEAF, INTERNAL, INTERNAL_ROOT, LEAF, LEAF_DUP_BOTTOM_ROOT, LEAF_DUP_INTERNAL_ROOT, log, size, structureId

Method Summary

Modifier and Type	Method and Description
boolean	add(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value) If tree supports duplicates and key already exists, then return false.
boolean	add(@NotNull INode ln) If tree support duplicates and key already exists, then return false.
protected void	addExpiredLoggable(@NotNull Loggable loggable)
protected void	addExpiredLoggable(long address)
AddressIterator	addressIterator()
protected @NotNull jetbrains.exodus.tree.btree.BaseLeafNodeMutable	createMutableLeaf(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value)
void	cursorClosed(@NotNull ITreeCursorMutable cursor)
protected void	decrementSize(long delta)
boolean	delete(@NotNull jetbrains.exodus.ByteIterable key) Delete key/value pairs for given key.
protected boolean	delete(@NotNull jetbrains.exodus.ByteIterable key, @Nullable jetbrains.exodus.ByteIterable value)
boolean	delete(@NotNull jetbrains.exodus.ByteIterable key, @Nullable jetbrains.exodus.ByteIterable value, @Nullable ITreeCursorMutable cursorToSkip) Delete key/value pair, should be supported only by tree which allows duplicates if value is not null.
protected byte	getBottomPageType()
@NotNull DataIterator	getDataIterator(long address)
@NotNull jetbrains.exodus.tree.ExpiredLoggableCollection	getExpiredLoggables()
protected byte	getInternalPageType()
protected byte	getLeafType()
@NotNull BTreeMutable	getMutableCopy()
@Nullable java.lang.Iterable<ITreeCursorMutable>	getOpenCursors()
@NotNull jetbrains.exodus.tree.btree.BasePageMutable	getRoot() Returns root page of the tree
long	getRootAddress()
protected void	incrementSize()
boolean	isAllowingDuplicates()
protected boolean	isDup()
TreeCursor	openCursor()
boolean	put(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value) If tree supports duplicates, then add key/value pair.
void	put(@NotNull INode ln) If tree supports duplicates, then add key/value pair.
void	putRight(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value) Add key/value pair with greatest (rightmost) key.
void	putRight(@NotNull INode ln) Add key/value pair with greatest (rightmost) key.
boolean	reclaim(@NotNull RandomAccessLoggable loggable, @NotNull java.util.Iterator<RandomAccessLoggable> loggables) Same as reclaim with expirationChecker, but takes all loggables into account
long	save() Save changes to log.

Methods inherited from class jetbrains.exodus.tree.btree.BTreeBase

dump, dump, get, getBalancePolicy, getLog, getLoggable, getSize, getStructureId, hasKey, hasPair, isDupKey, isEmpty, loadLeaf, loadPage, loadPage

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.exodus.tree.ITree

dump, dump, get, getLog, getSize, getStructureId, hasKey, hasPair, isEmpty

Method Detail

getRootAddress

public long getRootAddress()

Specified by:

getRootAddress in interface ITree

getRoot

@NotNull
public @NotNull jetbrains.exodus.tree.btree.BasePageMutable getRoot()

Description copied from class: BTreeBase

Returns root page of the tree

Specified by:

getRoot in interface ITreeMutable

Specified by:

getRoot in class BTreeBase

Returns:

tree root

isAllowingDuplicates

public boolean isAllowingDuplicates()

Specified by:

isAllowingDuplicates in interface ITreeMutable

getOpenCursors

@Nullable
public @Nullable java.lang.Iterable<ITreeCursorMutable> getOpenCursors()

Specified by:

getOpenCursors in interface ITreeMutable

addressIterator

public AddressIterator addressIterator()

Specified by:

addressIterator in interface ITree

Overrides:

addressIterator in class BTreeBase

getMutableCopy

@NotNull
public @NotNull BTreeMutable getMutableCopy()

Specified by:

getMutableCopy in interface ITree

Specified by:

getMutableCopy in class BTreeBase

getDataIterator

@NotNull
public @NotNull DataIterator getDataIterator(long address)

Specified by:

getDataIterator in interface ITree

Overrides:

getDataIterator in class BTreeBase

put

public void put(@NotNull
                @NotNull INode ln)

Description copied from interface: ITreeMutable

If tree supports duplicates, then add key/value pair. If tree doesn't support duplicates and key already exists, then overwrite value. If tree doesn't support duplicates and key doesn't exists, then add key/value pair.

Specified by:

put in interface ITreeMutable

Parameters:

ln - leaf node

putRight

public void putRight(@NotNull
                     @NotNull INode ln)

Description copied from interface: ITreeMutable

Add key/value pair with greatest (rightmost) key. In duplicates tree, value must be greatest too.

Specified by:

putRight in interface ITreeMutable

Parameters:

ln - leaf node, its key and values should be subtypes of ArrayByteIterable

add

public boolean add(@NotNull
                   @NotNull INode ln)

Description copied from interface: ITreeMutable

If tree support duplicates and key already exists, then return false. If tree support duplicates and key doesn't exists, then add key/value pair, return true. If tree doesn't support duplicates and key already exists, then return false. If tree doesn't support duplicates and key doesn't exists, then add key/value pair, return true.

Specified by:

add in interface ITreeMutable

Parameters:

ln - leaf node

Returns:

true if succeed

put

public boolean put(@NotNull
                   @NotNull jetbrains.exodus.ByteIterable key,
                   @NotNull
                   @NotNull jetbrains.exodus.ByteIterable value)

Description copied from interface: ITreeMutable

If tree supports duplicates, then add key/value pair. If tree doesn't support duplicates and key already exists, then overwrite value. If tree doesn't support duplicates and key doesn't exists, then add key/value pair.

Specified by:

put in interface ITreeMutable

Parameters:

key - key.

value - value.

putRight

public void putRight(@NotNull
                     @NotNull jetbrains.exodus.ByteIterable key,
                     @NotNull
                     @NotNull jetbrains.exodus.ByteIterable value)

Description copied from interface: ITreeMutable

Add key/value pair with greatest (rightmost) key. In duplicates tree, value must be greatest too.

Specified by:

putRight in interface ITreeMutable

Parameters:

key - key.

value - value.

add

public boolean add(@NotNull
                   @NotNull jetbrains.exodus.ByteIterable key,
                   @NotNull
                   @NotNull jetbrains.exodus.ByteIterable value)

Description copied from interface: ITreeMutable

If tree supports duplicates and key already exists, then return false. If tree supports duplicates and key doesn't exists, then add key/value pair, return true. If tree doesn't support duplicates and key already exists, then return false. If tree doesn't support duplicates and key doesn't exists, then add key/value pair, return true.

Specified by:

add in interface ITreeMutable

Parameters:

key - key.

value - value.

Returns:

false if key exists and tree is not supports duplicates

delete

public boolean delete(@NotNull
                      @NotNull jetbrains.exodus.ByteIterable key)

Description copied from interface: ITreeMutable

Delete key/value pairs for given key. If duplicate values exist for given key, all they will be removed.

Specified by:

delete in interface ITreeMutable

Parameters:

key - key.

Returns:

false if key wasn't found

delete

public boolean delete(@NotNull
                      @NotNull jetbrains.exodus.ByteIterable key,
                      @Nullable
                      @Nullable jetbrains.exodus.ByteIterable value,
                      @Nullable
                      @Nullable ITreeCursorMutable cursorToSkip)

Description copied from interface: ITreeMutable

Delete key/value pair, should be supported only by tree which allows duplicates if value is not null.

Specified by:

delete in interface ITreeMutable

Parameters:

key - key.

value - value.

cursorToSkip - mutable cursor to skip.

Returns:

false if key/value pair wasn't found

delete

protected boolean delete(@NotNull
                         @NotNull jetbrains.exodus.ByteIterable key,
                         @Nullable
                         @Nullable jetbrains.exodus.ByteIterable value)

decrementSize

protected void decrementSize(long delta)

incrementSize

protected void incrementSize()

save

public long save()

Description copied from interface: ITreeMutable

Save changes to log.

Specified by:

save in interface ITreeMutable

Returns:

address of new root page

addExpiredLoggable

protected void addExpiredLoggable(@NotNull
                                  @NotNull Loggable loggable)

addExpiredLoggable

protected void addExpiredLoggable(long address)

getExpiredLoggables

@NotNull
public @NotNull jetbrains.exodus.tree.ExpiredLoggableCollection getExpiredLoggables()

Specified by:

getExpiredLoggables in interface ITreeMutable

Returns:

set of expired loggables that were changed by put or delete methods.

openCursor

public TreeCursor openCursor()

Specified by:

openCursor in interface ITree

Overrides:

openCursor in class BTreeBase

cursorClosed

public void cursorClosed(@NotNull
                         @NotNull ITreeCursorMutable cursor)

Specified by:

cursorClosed in interface ITreeMutable

getBottomPageType

protected byte getBottomPageType()

getInternalPageType

protected byte getInternalPageType()

getLeafType

protected byte getLeafType()

isDup

protected boolean isDup()

createMutableLeaf

@NotNull
protected @NotNull jetbrains.exodus.tree.btree.BaseLeafNodeMutable createMutableLeaf(@NotNull
                                                                                              @NotNull jetbrains.exodus.ByteIterable key,
                                                                                              @NotNull
                                                                                              @NotNull jetbrains.exodus.ByteIterable value)

reclaim

public boolean reclaim(@NotNull
                       @NotNull RandomAccessLoggable loggable,
                       @NotNull
                       @NotNull java.util.Iterator<RandomAccessLoggable> loggables)

Description copied from interface: ITreeMutable

Same as reclaim with expirationChecker, but takes all loggables into account

Specified by:

reclaim in interface ITreeMutable

Parameters:

loggable - a candidate to reclaim.

loggables - loggables following the candidate.

Returns:

true if any loggable (the candidate or any among loggables) was reclaimed.