A B C D E F G H I J K L M O R S T V W

A

ABOUT - Static variable in class com.coyotegulch.jisp.Jisp
Text that describes the purpose of Jisp.
assignFilter(RecordFilter) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Assigns a filter object to translated, encrypt, compress, or otherwise manipulate objects as they are written and read.
attachIndex(ObjectIndex) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Attaches an index object to this database.

B

BTreeException - exception com.coyotegulch.jisp.BTreeException.
Standard exception type thrown by B-Tree index classes.
BTreeException() - Constructor for class com.coyotegulch.jisp.BTreeException
Constructs a new BTreeException with a null error message string.
BTreeException(String) - Constructor for class com.coyotegulch.jisp.BTreeException
Constructs a new BTreeException with a specific error message string.
BTreeIndex - class com.coyotegulch.jisp.BTreeIndex.
Associates a key value with a long reference.
BTreeIndex(String) - Constructor for class com.coyotegulch.jisp.BTreeIndex
Opens an existing file, name, as a BTreeIndex.
BTreeIndex(String, int, boolean) - Constructor for class com.coyotegulch.jisp.BTreeIndex
Creates the specified file as a BTreeIndex, using the given order
BTreeIndex.SearchResult - class com.coyotegulch.jisp.BTreeIndex.SearchResult.
 
BTreeIndex.SearchResult(boolean, BTreePage, int) - Constructor for class com.coyotegulch.jisp.BTreeIndex.SearchResult
 
BTreeIterator - class com.coyotegulch.jisp.BTreeIterator.
BTreeIterator defines an object that references a specific object relative to other objects in an ObjectIndex.
BTreeIterator(BTreeIndex) - Constructor for class com.coyotegulch.jisp.BTreeIterator
Creates a new BTreeIterator for a given index and database.
BTreeIterator(BTreeIterator) - Constructor for class com.coyotegulch.jisp.BTreeIterator
Creates a new BTreeIterator that points to the same location as an existing BtreeIterator.

C

close() - Method in class com.coyotegulch.jisp.BTreeIndex
Closes an open BTreeIndex and empties the page cache to release memory.
close() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Explicitly closes the file.
com.coyotegulch.jisp - package com.coyotegulch.jisp
 
compact(ObjectDatabaseCallback) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Compacts a database file by copying it to a new file and deleting the old one.
compactNotify(long, Object) - Method in interface com.coyotegulch.jisp.ObjectDatabaseCallback
A function called when an object is rewritten to the compacted files.
compareTo(OrderedObject) - Method in class com.coyotegulch.jisp.IntKey
Compares the invoking IntKey to key, returning one of the KEY_* constants based on the relationship of the two keys.
compareTo(OrderedObject) - Method in class com.coyotegulch.jisp.LongKey
Compares the invoking LongKey to key, returning one of the KEY_* constants based on the relationship of the two keys.
compareTo(OrderedObject) - Method in class com.coyotegulch.jisp.OrderedObject
Compares the invoking object to key, returning one of the KEY_* constants based on the relationship of the two keys.
compareTo(OrderedObject) - Method in class com.coyotegulch.jisp.StringKey
Compares the invoking StringKey to key, returning one of the KEY_* constants based on the relationship of the two keys.
count() - Method in class com.coyotegulch.jisp.BTreeIndex
Returns the number of keys stored in this index.

D

DEL_LIST_END - Static variable in class com.coyotegulch.jisp.ObjectDatabaseFile
Marks the end of the list of deleted records
DatabaseException - exception com.coyotegulch.jisp.DatabaseException.
Standard exception type thrown by the object database classes.
DatabaseException() - Constructor for class com.coyotegulch.jisp.DatabaseException
Constructs a new DatabaseException with null as its error message string.
DatabaseException(String) - Constructor for class com.coyotegulch.jisp.DatabaseException
Constructs a new DatabaseException with message as its error message string.
DuplicateKeyException - exception com.coyotegulch.jisp.DuplicateKeyException.
A ObjectIndex throws a DuplicateKeyException when a key being added to the index is identical to a key already stored there.
DuplicateKeyException() - Constructor for class com.coyotegulch.jisp.DuplicateKeyException
Constructs a new DuplicateKeyException with null as its error message string.
DuplicateKeyException(OrderedObject) - Constructor for class com.coyotegulch.jisp.DuplicateKeyException
Constructs a new DuplicateKeyException with message as its error message string.
decode(HuffmanEncoded) - Static method in class com.coyotegulch.jisp.Huffman
Decodes a compressed object using the Huffman algorithm.
delete() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Deletes the record in the current file position.
dumpTree(PrintStream) - Method in class com.coyotegulch.jisp.BTreeIndex
Dumps the entire B-Tree to a print strem for analysis.

E

emptyPageCache() - Method in class com.coyotegulch.jisp.BTreeIndex
Empty the page cache.
encode(Object) - Static method in class com.coyotegulch.jisp.Huffman
Encodes an object using Huffman compression.

F

filterDecode(Object) - Method in class com.coyotegulch.jisp.HuffmanFilter
Decompresses the target object using the Huffman algorithm.
filterDecode(Object) - Method in interface com.coyotegulch.jisp.RecordFilter
Decodes the target object.
filterEncode(Object) - Method in class com.coyotegulch.jisp.HuffmanFilter
Compresses the target object using the Huffman algorithm.
filterEncode(Object) - Method in interface com.coyotegulch.jisp.RecordFilter
Encodes the target object.
findKey(OrderedObject) - Method in class com.coyotegulch.jisp.BTreeIndex
Find the position of the object associated with a given key.
findKey(OrderedObject, boolean) - Method in class com.coyotegulch.jisp.BTreeIndex
Find the position of an object associated with a given key, or its successor.
findKey(OrderedObject) - Method in interface com.coyotegulch.jisp.ObjectIndex
Find the position of the object associated with a given key.

G

getClassLoader() - Static method in class com.coyotegulch.jisp.Jisp
Get the current class loader.
getFD() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Returns the file descriptor.
getFilePointer() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Returns the current file position.
getKey() - Method in class com.coyotegulch.jisp.BTreeIterator
Returns the key Object currently associated with this iterator.
getKey() - Method in class com.coyotegulch.jisp.DuplicateKeyException
Returns the key object that was not found.
getKey() - Method in interface com.coyotegulch.jisp.IndexIterator
Returns the key Object currently referenced by this iterator.
getKey() - Method in class com.coyotegulch.jisp.KeyNotFoundException
Returns the key object that was not found.
getNextOpen() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Returns the file position of the next open record.
getPageCacheSize() - Method in class com.coyotegulch.jisp.BTreeIndex
Get the size of the page cache, in number of B-tree pages stored in memory.
getRecPtr() - Method in class com.coyotegulch.jisp.BTreeIterator
Returns the reference (usually a file pointer) currently associated with this iterator.
getRecPtr() - Method in interface com.coyotegulch.jisp.IndexIterator
Returns the record Object currently referenced by this iterator.

H

Huffman - class com.coyotegulch.jisp.Huffman.
Compresses and decompresses objects using the Huffman algorithm.
Huffman() - Constructor for class com.coyotegulch.jisp.Huffman
 
HuffmanEncoded - class com.coyotegulch.jisp.HuffmanEncoded.
A compressed object and its encoding table.
HuffmanEncoded() - Constructor for class com.coyotegulch.jisp.HuffmanEncoded
 
HuffmanException - exception com.coyotegulch.jisp.HuffmanException.
Standard exception type thrown by the Huffman compression.
HuffmanException() - Constructor for class com.coyotegulch.jisp.HuffmanException
Constructs a new HuffmanException with null as its error message string.
HuffmanException(String) - Constructor for class com.coyotegulch.jisp.HuffmanException
Constructs a new HuffmanException with message as its error message string.
HuffmanFilter - class com.coyotegulch.jisp.HuffmanFilter.
A filter to automatically compress and decompress database records using the Huffman algorithm.
HuffmanFilter() - Constructor for class com.coyotegulch.jisp.HuffmanFilter
 
HuffmanHeader - class com.coyotegulch.jisp.HuffmanHeader.
Tables and information required to reconstitute an object compressed with the Huffman algorithm.
HuffmanHeader() - Constructor for class com.coyotegulch.jisp.HuffmanHeader
 
hashCode() - Method in class com.coyotegulch.jisp.IntKey
Returns a hash code value for the object, which is, in effect, the the value of the key.
hashCode() - Method in class com.coyotegulch.jisp.LongKey
Returns a hash code value for the object, which is, in effect, the the value of the key.

I

IS_ACTIVE - Static variable in class com.coyotegulch.jisp.ObjectDatabaseFile
Marks a given record as containing live data
IS_DELETED - Static variable in class com.coyotegulch.jisp.ObjectDatabaseFile
Marks a given record as deleted
IndexIterator - interface com.coyotegulch.jisp.IndexIterator.
IndexIterator defines an object that references a specific object relative to other objects in an ObjectIndex.
IndexedObjectDatabase - class com.coyotegulch.jisp.IndexedObjectDatabase.
The IndexedObjectDatabase class provides a mechanism for using a key value to an object serialized to a file.
IndexedObjectDatabase(String, boolean) - Constructor for class com.coyotegulch.jisp.IndexedObjectDatabase
Opens an existing IndexedObjectDatabase, using a supplied file name.
IntKey - class com.coyotegulch.jisp.IntKey.
IntKey defines a key based on the Int type.
IntKey(int) - Constructor for class com.coyotegulch.jisp.IntKey
Creates a new IntKey with a specific value.
IntKey() - Constructor for class com.coyotegulch.jisp.IntKey
Creates a blank IntKey (value = 0).
insert(OrderedObject[], Serializable) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Write a new object to the database, associating it with the provided keys.
insertKey(OrderedObject, long) - Method in class com.coyotegulch.jisp.BTreeIndex
Insert a key into the index, associating a "reference" value with the given key.
insertKey(OrderedObject, long) - Method in interface com.coyotegulch.jisp.ObjectIndex
Insert a key into the database, associating a record position with the given key.
intValue() - Method in class com.coyotegulch.jisp.IntKey
Returns the int value of a IntKey.
invalidate() - Method in class com.coyotegulch.jisp.BTreeIterator
Sets this iterator's state to invalid.
isValid() - Method in class com.coyotegulch.jisp.BTreeIterator
Checks to see if this iterator is valid.
isValid() - Method in interface com.coyotegulch.jisp.IndexIterator
Checks to see if this iterator is valid.

J

Jisp - class com.coyotegulch.jisp.Jisp.
Defines common, global objects for the entire Jisp package.
Jisp() - Constructor for class com.coyotegulch.jisp.Jisp
 

K

KEY_EQUAL - Static variable in class com.coyotegulch.jisp.OrderedObject
Returned by compareTo when the invoking key is greater than the parameter key.
KEY_ERROR - Static variable in class com.coyotegulch.jisp.OrderedObject
Returned by compareTo when the invoking key has a different type from the parameter key.
KEY_LESS - Static variable in class com.coyotegulch.jisp.OrderedObject
Returned by compareTo when the invoking key is less than the parameter key.
KEY_MORE - Static variable in class com.coyotegulch.jisp.OrderedObject
Returned by compareTo when the invoking key equals the parameter key.
KeyNotFoundException - exception com.coyotegulch.jisp.KeyNotFoundException.
An ObjectIndex throws KeyNotFoundException when a requested key is not found in the index.
KeyNotFoundException() - Constructor for class com.coyotegulch.jisp.KeyNotFoundException
Constructs a new KeyNotFoundException with null as its error message string.
KeyNotFoundException(OrderedObject) - Constructor for class com.coyotegulch.jisp.KeyNotFoundException
Constructs a new KeyNotFoundException with s as its error message string.

L

LICENSE - Static variable in class com.coyotegulch.jisp.Jisp
"Scott's Very Free License", the license governing the distribution and use of Jisp.
LongKey - class com.coyotegulch.jisp.LongKey.
LongKey defines a key based on the long type.
LongKey(long) - Constructor for class com.coyotegulch.jisp.LongKey
Creates a new LongKey with a specific value.
LongKey() - Constructor for class com.coyotegulch.jisp.LongKey
Creates a blank LongKey (value = 0).
length() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Returns the number of bytes in the file.
longValue() - Method in class com.coyotegulch.jisp.LongKey
Returns the long value of a LongKey.

M

m_dataFile - Variable in class com.coyotegulch.jisp.ObjectDatabaseFile
Physical file containing serialized objects
m_database - Variable in class com.coyotegulch.jisp.BTreeIndex
 
m_fileName - Variable in class com.coyotegulch.jisp.ObjectDatabaseFile
Name of the underlying physical file
m_filter - Variable in class com.coyotegulch.jisp.ObjectDatabaseFile
Filter to be applied to each object read or written
m_firstDeleted - Variable in class com.coyotegulch.jisp.ObjectDatabaseFile
File position of the first delete record
m_found - Variable in class com.coyotegulch.jisp.BTreeIndex.SearchResult
 
m_page - Variable in class com.coyotegulch.jisp.BTreeIndex.SearchResult
 
m_position - Variable in class com.coyotegulch.jisp.BTreeIndex.SearchResult
 
m_root - Variable in class com.coyotegulch.jisp.BTreeIndex
 
main(String[]) - Static method in class com.coyotegulch.jisp.Jisp
The main function, run from jisp.jar to display version number and license.
moveFirst() - Method in class com.coyotegulch.jisp.BTreeIterator
Moves this iterator to the first key and reference in sequence.
moveFirst() - Method in interface com.coyotegulch.jisp.IndexIterator
Moves this iterator to the first record in sequence.
moveLast() - Method in class com.coyotegulch.jisp.BTreeIterator
Moves this iterator to the last key and reference in sequence.
moveLast() - Method in interface com.coyotegulch.jisp.IndexIterator
Moves this iterator to the last record in sequence.
moveNext() - Method in class com.coyotegulch.jisp.BTreeIterator
Moves this iterator to the next key and reference in sequence.
moveNext() - Method in interface com.coyotegulch.jisp.IndexIterator
Moves this iterator to the next record in sequence.
movePrevious() - Method in class com.coyotegulch.jisp.BTreeIterator
Moves this iterator to the previous key and reference in sequence.
movePrevious() - Method in interface com.coyotegulch.jisp.IndexIterator
Moves this iterator to the previous record in sequence.
moveTo(OrderedObject) - Method in class com.coyotegulch.jisp.BTreeIterator
Moves this iterator to point to the given key.
moveTo(OrderedObject, boolean) - Method in class com.coyotegulch.jisp.BTreeIterator
Moves this iterator to point to the given key.
moveTo(OrderedObject) - Method in interface com.coyotegulch.jisp.IndexIterator
Moves this iterator to the record associated with the given key.
moveTo(OrderedObject, boolean) - Method in interface com.coyotegulch.jisp.IndexIterator
Moves this iterator to the record associated with the given key.

O

ObjectDatabaseCallback - interface com.coyotegulch.jisp.ObjectDatabaseCallback.
An interface to be implemented by objects that wish to be notified of record movements during the compaction of an ObjectDatabaseFile.
ObjectDatabaseFile - class com.coyotegulch.jisp.ObjectDatabaseFile.
The ObjectDatabaseFile provides a random-access file that serializes objects to variable length records in a random-access file.
ObjectDatabaseFile(String, boolean) - Constructor for class com.coyotegulch.jisp.ObjectDatabaseFile
Creates or opens a file that stores objects in variable-length records.
ObjectDatabaseFile(File, boolean) - Constructor for class com.coyotegulch.jisp.ObjectDatabaseFile
Creates or opens a file that stores objects in variable-length records.
ObjectIndex - interface com.coyotegulch.jisp.ObjectIndex.
ObjectIndex defines the concept of an index that associates key values with references to serializable objects.
OrderedObject - class com.coyotegulch.jisp.OrderedObject.
OrderedObject defines an characteristics of an object to be used as a key * in an ObjectIndex.
OrderedObject() - Constructor for class com.coyotegulch.jisp.OrderedObject
 

R

RecordFilter - interface com.coyotegulch.jisp.RecordFilter.
A filter to automatically performs translations on objects stored in database records.
read(OrderedObject, ObjectIndex) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Read the object(s) associated with a given key.
read(IndexIterator) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Read the object associated with a given iterator.
readExternal(ObjectInput) - Method in class com.coyotegulch.jisp.IntKey
IntKey implements the readExternal method to restore its contents.
readExternal(ObjectInput) - Method in class com.coyotegulch.jisp.LongKey
LongKey implements the readExternal method to restore its contents.
readExternal(ObjectInput) - Method in class com.coyotegulch.jisp.StringKey
StringKey implements the readExternal method to restore its contents.
readObject() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Reads the object at the current file position.
remove(OrderedObject, ObjectIndex) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Delete the record associated with a given key.
removeIndex(ObjectIndex) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Removes the association of an index with this database.
removeKey(OrderedObject, long) - Method in class com.coyotegulch.jisp.BTreeIndex
Removes specified reference from the entry for the given key, and removes the key itself if it no longer has an references.
removeKey(OrderedObject, long) - Method in interface com.coyotegulch.jisp.ObjectIndex
Removes specified reference from the entry for the given key, and removes the key itself if it no longer has an references.
removeKeyAll(OrderedObject) - Method in class com.coyotegulch.jisp.BTreeIndex
Removes the given key from the index, no matter how many references it might be associated with.
removeKeyAll(OrderedObject) - Method in interface com.coyotegulch.jisp.ObjectIndex
Removes the given key from the index, no matter how many references it might be associated with.
rewind() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Sets the current file pointer to the first byte beyond the file header.
rewriteObject(Serializable) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Re-writes a serializable object to the file, at the current file position.

S

StringKey - class com.coyotegulch.jisp.StringKey.
StringKey defines a variable-length string key.
StringKey(String) - Constructor for class com.coyotegulch.jisp.StringKey
Creates a new StringKey using key_value.
StringKey() - Constructor for class com.coyotegulch.jisp.StringKey
Creates a blank (null) StringKey.
seek(long) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Moves the current file position to the given position.
setClassLoader(ClassLoader) - Static method in class com.coyotegulch.jisp.Jisp
Set an external class loader for use by the Jisp object input and output streams.
skip() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Skips the record at the current file position, moving to the next record in sequence.
supportsDupes() - Method in class com.coyotegulch.jisp.BTreeIndex
Returns whether or not this index support duplicate keys.
supportsDupes() - Method in interface com.coyotegulch.jisp.ObjectIndex
Tells if this index supports duplicate keys.

T

ticker() - Method in class com.coyotegulch.jisp.BTreeIndex
Returns the number of keys added to this index since its creation.
toString() - Method in class com.coyotegulch.jisp.IntKey
Returns the String representation of a IntKey.
toString() - Method in class com.coyotegulch.jisp.LongKey
Returns the String representation of a LongKey.
toString() - Method in class com.coyotegulch.jisp.StringKey
Returns the String representation of a StringKey.

V

VERSION - Static variable in class com.coyotegulch.jisp.Jisp
Version number string.

W

write(OrderedObject[], Serializable) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
Writes an object to the database, associating it with the provided key, replacing an existing object with a new one.
writeExternal(ObjectOutput) - Method in class com.coyotegulch.jisp.IntKey
IntKey implements the writeExternal method to save its contents.
writeExternal(ObjectOutput) - Method in class com.coyotegulch.jisp.LongKey
LongKey implements the writeExternal method to save its contents.
writeExternal(ObjectOutput) - Method in class com.coyotegulch.jisp.StringKey
StringKey implements the writeExternal method to save its contents.
writeObject(Serializable) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
Writes a serializable object to the file.

A B C D E F G H I J K L M O R S T V W