A B C D F G H I L M N O P R S T U V W

A

ABOUT - Static variable in class com.coyotegulch.itzam.Itzam

Text that describes the purpose of Itzam/Java.

B

Btree<KeyClass extends Itzamable> - Class in com.coyotegulch.itzam

A generic class that stores and retrieves data from a file using a key.

Btree(String, Class<KeyClass>) - Constructor for class com.coyotegulch.itzam.Btree

Creates a Btree object.

Btree.Cursor - Class in com.coyotegulch.itzam

A Cursor allows in-order traversing of the data stored in a Btree.

C

close() - Method in class com.coyotegulch.itzam.Btree

Closes the Btree and releases the lock on the underlying file.

close() - Method in class com.coyotegulch.itzam.Datafile

Closes an open Datafile.

close() - Method in class com.coyotegulch.itzam.HashTable

Closes the HashTable and releases the lock on the underlying file.

com.coyotegulch.itzam - package com.coyotegulch.itzam

compare(Itzamable) - Method in interface com.coyotegulch.itzam.Itzamable

Determines the relative order of two keys.

D

Datafile - Class in com.coyotegulch.itzam

The Datafile provides a random-access file that serializes objects to variable length records in a random-access file.

Datafile(String) - Constructor for class com.coyotegulch.itzam.Datafile

Initializes, then creates or opens a Datafile.

F

find(KeyClass) - Method in class com.coyotegulch.itzam.Btree

Retrieve the record reference associated with a given key.

find(KeyClass) - Method in class com.coyotegulch.itzam.HashTable

Retrieve the record reference associated with a given key.

G

getBufferFor(Itzamable) - Static method in class com.coyotegulch.itzam.Itzam

Retrieves an appropriately-sized buffer for the reading an instance of the given object.

getCount() - Method in class com.coyotegulch.itzam.Btree

Get the number of keys stored in this Btree.

getCount() - Method in class com.coyotegulch.itzam.HashTable

Get the number of keys stored in this HashTable.

getCursor() - Method in class com.coyotegulch.itzam.Btree

Creates a new cursor for this Btree.

getCursorCount() - Method in class com.coyotegulch.itzam.Btree

Get the number of times a key has been successfully stored in this Btree.

getKeyList(Selector) - Method in class com.coyotegulch.itzam.Btree

Obtains a vector of keys for this specific Btree, in order as defined by the provided Selector.

getNextOpen(long) - Method in class com.coyotegulch.itzam.Datafile

Returns the file position of the next record to which an object of length bytes will be written.

getNumberOfBuckets() - Method in class com.coyotegulch.itzam.HashTable

How many buckets does this HashTable have?

getSize() - Method in interface com.coyotegulch.itzam.Itzamable

This function must return the precise size of the buffer required to hold an object of the implementing class.

getTicker() - Method in class com.coyotegulch.itzam.Btree

Get the number of times a key has been successfully stored in this Btree.

getTicker() - Method in class com.coyotegulch.itzam.HashTable

Get the number of times a key has been successfully stored in this HashTable.

getUnderlyingException() - Method in exception com.coyotegulch.itzam.ItzamException

Returns the underlying exception.

H

hash(int) - Method in interface com.coyotegulch.itzam.Hashable

Hashable - Interface in com.coyotegulch.itzam

Defines a type that can be stored in a HashTable.

HashTable<KeyClass extends Hashable> - Class in com.coyotegulch.itzam

HashTable defines an index bash on a table of keys organized by their hash values.

HashTable(String, Class<KeyClass>, int) - Constructor for class com.coyotegulch.itzam.HashTable

Creates a HashTable object.

I

insert(KeyClass) - Method in class com.coyotegulch.itzam.Btree

Adds a key to a Btree.

insert(KeyClass) - Method in class com.coyotegulch.itzam.HashTable

Adds a key to a HashTable.

isClosed() - Method in class com.coyotegulch.itzam.Btree

Is the Btree closed?

isClosed() - Method in class com.coyotegulch.itzam.Datafile

Is this file closed?

isClosed() - Method in class com.coyotegulch.itzam.HashTable

Is the HashTable closed?

isOpen() - Method in class com.coyotegulch.itzam.Btree

Is the Btree open?

isOpen() - Method in class com.coyotegulch.itzam.Datafile

Is this file open?

isOpen() - Method in class com.coyotegulch.itzam.HashTable

Is the HashTable open?

Itzam - Class in com.coyotegulch.itzam

A collection of general-purpose functions and values used throughout the Itzam/Java package.

Itzam() - Constructor for class com.coyotegulch.itzam.Itzam

ITZAM_NULL_REF - Static variable in class com.coyotegulch.itzam.Itzam

A file reference (position) the doesn't point to anything, used to mark empty list entries or to indicate that a record was not found.

Itzamable - Interface in com.coyotegulch.itzam

Defines the requirements of an object that can be stored in a Datafile.

ItzamException - Exception in com.coyotegulch.itzam

Standard exception type thrown by the Itzam database classes.

ItzamException() - Constructor for exception com.coyotegulch.itzam.ItzamException

Constructs a new DatabaseException with null as its error message string.

ItzamException(String) - Constructor for exception com.coyotegulch.itzam.ItzamException

Constructs a new DatabaseException with message as its error message string.

ItzamException(String, Throwable) - Constructor for exception com.coyotegulch.itzam.ItzamException

Constructs a new DatabaseException with message as its error message string and a specific underlying exception.

L

LICENSE - Static variable in class com.coyotegulch.itzam.Itzam

"GNU Public License", the license governing the distribution and use of Jisp.

lock() - Method in class com.coyotegulch.itzam.Btree

Lock the underlying file for exclusive access.

lock() - Method in class com.coyotegulch.itzam.Datafile

Lock the underlying file for exclusive access.

lock() - Method in class com.coyotegulch.itzam.HashTable

Lock the underlying file for exclusive access.

M

main(String[]) - Static method in class com.coyotegulch.itzam.Itzam

The main function, run from itzam.jar to display version number and license.

N

next() - Method in class com.coyotegulch.itzam.Btree.Cursor

Moves a Cursor to the next key, in order.

O

open() - Method in class com.coyotegulch.itzam.Btree

If the Btree file exists, it is opened and internal data structures are initialized.

open() - Method in class com.coyotegulch.itzam.Datafile

Creates or opens a Datafile.

open() - Method in class com.coyotegulch.itzam.HashTable

If the HashTable file exists, it is opened and internal data structures are initialized.

P

persist() - Method in interface com.coyotegulch.itzam.Itzamable

Returns a buffer containing the binary representation of the object's state.

R

read() - Method in class com.coyotegulch.itzam.Btree.Cursor

Retrieves the key pointed to by a Cursor.

read(Itzamable) - Method in class com.coyotegulch.itzam.Datafile

Reads an Itzamable object from the current file position.

read(Itzamable, long) - Method in class com.coyotegulch.itzam.Datafile

Reads an Itzamable object from the specified file position.

readRecordDirect(long, Itzamable) - Method in class com.coyotegulch.itzam.Btree

Reads a record directly from the Btree file, at the specified position.

release() - Method in class com.coyotegulch.itzam.Btree.Cursor

Invalidates a Cursor, and decrements the active cursor count for the BTree.

remove(KeyClass) - Method in class com.coyotegulch.itzam.Btree

Removes a given key from the index, and returns the location of its associated record.

remove(long) - Method in class com.coyotegulch.itzam.Datafile

Remove a record from an explicit file position.

remove() - Method in class com.coyotegulch.itzam.Datafile

Remove a record from the current file position.

remove(KeyClass) - Method in class com.coyotegulch.itzam.HashTable

Removes a given key from the index, and returns the location of its associated record.

reset() - Method in class com.coyotegulch.itzam.Btree.Cursor

Sets a Cursor to reference the first item, in-order, for this Btree.

restore(ByteBuffer, int) - Method in interface com.coyotegulch.itzam.Itzamable

Sets an object to a state as stored in the given buffer.

rewind() - Method in class com.coyotegulch.itzam.Datafile

Sets the file position to the first record immediately after the file header.

S

seek(long) - Method in class com.coyotegulch.itzam.Datafile

Sets the current file position

select(Itzamable) - Method in interface com.coyotegulch.itzam.Selector

Determines if the given key fits the criteria defined by this Selector.

Selector - Interface in com.coyotegulch.itzam

Provides selection criteria for a set of Itzamable objects.

T

tell() - Method in class com.coyotegulch.itzam.Datafile

Returns the current file position

U

unlock() - Method in class com.coyotegulch.itzam.Btree

Unlock the underlying file.

unlock() - Method in class com.coyotegulch.itzam.Datafile

Unlock the underlying file.

unlock() - Method in class com.coyotegulch.itzam.HashTable

Unlock the underlying file.

V

VERSION - Static variable in class com.coyotegulch.itzam.Itzam

Version number string.

W

wasCreated() - Method in class com.coyotegulch.itzam.Btree

Was this file created when last opened?

wasCreated() - Method in class com.coyotegulch.itzam.Datafile

Was this file newly-created?

wasCreated() - Method in class com.coyotegulch.itzam.HashTable

Was this file created when last opened?

write(Itzamable) - Method in class com.coyotegulch.itzam.Datafile

Writes an Itzamable object to the next available record slot of appropriate size.

write(Itzamable, long) - Method in class com.coyotegulch.itzam.Datafile

Writes an Itzamable object to an explicit position within the file.

write(Itzamable, long, int) - Method in class com.coyotegulch.itzam.Datafile

Writes an Itzamable object to an explicit position within the file.

writeRecord(Itzamable) - Method in class com.coyotegulch.itzam.Btree

Writes an Itzamable object to the next available record slot of appropriate size.

writeRecordDirect(Itzamable, long) - Method in class com.coyotegulch.itzam.Btree

Writes an Itzamable object to an explicit position within the Btree file.

A B C D F G H I L M N O P R S T U V W