Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- 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 in com.coyotegulch.jisp
-
Standard exception type thrown by B-Tree index classes.
- BTreeException() - Constructor for exception com.coyotegulch.jisp.BTreeException
-
Constructs a new
BTreeException
with anull
error message string. - BTreeException(String) - Constructor for exception com.coyotegulch.jisp.BTreeException
-
Constructs a new
BTreeException
with a specific error message string. - BTreeIndex - Class in com.coyotegulch.jisp
-
Associates a key value with a
long
reference. - BTreeIndex(String) - Constructor for class com.coyotegulch.jisp.BTreeIndex
-
Opens an existing file,
name
, as aBTreeIndex
. - BTreeIndex(String, int, KeyObject, boolean) - Constructor for class com.coyotegulch.jisp.BTreeIndex
-
Creates the specified file as a
BTreeIndex
, using the given order andnull
key value. - BTreeIterator - Class in com.coyotegulch.jisp
-
BTreeIterator
defines an object that references a specific object relative to other objects in anObjectIndex
. - 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 existingBtreeIterator
.
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.HashIndex
-
Deprecated.
- close() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
- 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(KeyObject) - Method in class com.coyotegulch.jisp.KeyObject
-
Compares the invoking object to
key
, returning one of theKEY_*
constants based on the relationship of the two keys. - compareTo(KeyObject) - Method in class com.coyotegulch.jisp.LongKey
-
Compares the invoking
LongKey
tokey
, returning one of theKEY_*
constants based on the relationship of the two keys. - compareTo(KeyObject) - Method in class com.coyotegulch.jisp.StringKey
-
Compares the invoking
StringKey
tokey
, returning one of theKEY_*
constants based on the relationship of the two keys. - computeOrder(int, int) - Static method in class com.coyotegulch.jisp.BTreeIndex
-
Calculates a suggested value for a B-tree order, based on a given number of records and a maximum "height" for the B-tree structure.
- count() - Method in class com.coyotegulch.jisp.BTreeIndex
-
Returns the number of keys stored in this index.
- createObjectInputStream(InputStream) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
- createObjectOutputStream(OutputStream) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
D
- DatabaseException - Exception in com.coyotegulch.jisp
-
Standard exception type thrown by the object database classes.
- DatabaseException() - Constructor for exception com.coyotegulch.jisp.DatabaseException
-
Constructs a new
DatabaseException
with null as its error message string. - DatabaseException(String) - Constructor for exception com.coyotegulch.jisp.DatabaseException
-
Constructs a new
DatabaseException
withmessage
as its error message string. - decode(HuffmanEncoded) - Static method in class com.coyotegulch.jisp.Huffman
-
Decodes a compressed object using the Huffman algorithm.
- DEL_LIST_END - Static variable in class com.coyotegulch.jisp.ObjectDatabaseFile
-
Marks the end of the list of deleted records
- 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
System.out
for analysis. - DuplicateKey - Exception in com.coyotegulch.jisp
-
A
ObjectIndex
throws aDuplicateKey
when a key being added to the index is identical to a key already stored there. - DuplicateKey() - Constructor for exception com.coyotegulch.jisp.DuplicateKey
-
Constructs a new
DuplicateKey
with null as its error message string. - DuplicateKey(String) - Constructor for exception com.coyotegulch.jisp.DuplicateKey
-
Constructs a new
DuplicateKey
withmessage
as its error message string.
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(KeyObject) - Method in class com.coyotegulch.jisp.BTreeIndex
-
Find the position of the object associated with a given key.
- findKey(KeyObject) - Method in class com.coyotegulch.jisp.HashIndex
-
Deprecated.Find the position of the object associated with a given key.
- findKey(KeyObject) - Method in interface com.coyotegulch.jisp.ObjectIndex
-
Find the position of the object associated with a given key.
- findKey(KeyObject, boolean) - Method in class com.coyotegulch.jisp.BTreeIndex
-
Find the position of an object associated with a given key, or its successor.
G
- getClassLoader() - Static method in class com.coyotegulch.jisp.Jisp
-
Get the current class loader.
- getFD() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
- getFilePointer() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
- getKey() - Method in class com.coyotegulch.jisp.BTreeIterator
-
Returns the key
Object
currently associated with this iterator. - getKey() - Method in interface com.coyotegulch.jisp.IndexIterator
-
Returns the key
Object
currently referenced by this iterator. - 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
- 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.
- hashCode() - Method in class com.coyotegulch.jisp.StringKey
-
Returns a hash code value for the object, which is, in effect, the the sum of the characters in the string key value.
- HashIndex - Class in com.coyotegulch.jisp
-
Deprecated.As of Jisp versioon 2.5.0, the HashIndex class is deprecated; it will be replaced in Jisp 3.0 by a more efficient and simpler hash-based index.
- HashIndex(String) - Constructor for class com.coyotegulch.jisp.HashIndex
-
Deprecated.Opens a file as a
HashIndex
. - HashIndex(String, int, int, KeyObject) - Constructor for class com.coyotegulch.jisp.HashIndex
-
Deprecated.Creates the file as a
HashIndex
. - Huffman - Class in com.coyotegulch.jisp
-
Compresses and decompresses objects using the Huffman algorithm.
- Huffman() - Constructor for class com.coyotegulch.jisp.Huffman
- HuffmanEncoded - Class in com.coyotegulch.jisp
-
A compressed object and its encoding table.
- HuffmanEncoded() - Constructor for class com.coyotegulch.jisp.HuffmanEncoded
- HuffmanException - Exception in com.coyotegulch.jisp
-
Standard exception type thrown by the Huffman compression.
- HuffmanException() - Constructor for exception com.coyotegulch.jisp.HuffmanException
-
Constructs a new
HuffmanException
with null as its error message string. - HuffmanException(String) - Constructor for exception com.coyotegulch.jisp.HuffmanException
-
Constructs a new
HuffmanException
withmessage
as its error message string. - HuffmanFilter - Class in com.coyotegulch.jisp
-
A filter to automatically compress and decompress database records using the Huffman algorithm.
- HuffmanFilter() - Constructor for class com.coyotegulch.jisp.HuffmanFilter
- HuffmanHeader - Class in com.coyotegulch.jisp
-
Tables and information required to reconstitute an object compressed with the Huffman algorithm.
- HuffmanHeader() - Constructor for class com.coyotegulch.jisp.HuffmanHeader
I
- IndexedObjectDatabase - Class in com.coyotegulch.jisp
-
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. - IndexIterator - Interface in com.coyotegulch.jisp
-
IndexIterator
defines an object that references a specific object relative to other objects in anObjectIndex
. - insert(KeyObject[], Serializable) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
-
Write a new object to the database, associating it with the provided keys.
- insertKey(KeyObject, long) - Method in class com.coyotegulch.jisp.BTreeIndex
-
Insert a key into the index, associating a "reference" value with the given key.
- insertKey(KeyObject, long) - Method in class com.coyotegulch.jisp.HashIndex
-
Deprecated.Insert a key into the database, associating a record position with the given key.
- insertKey(KeyObject, long) - Method in interface com.coyotegulch.jisp.ObjectIndex
-
Insert a key into the database, associating a record position with the given key.
- invalidate() - Method in class com.coyotegulch.jisp.BTreeIterator
-
Sets this iterator's state to invalid.
- 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
- 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 in com.coyotegulch.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.KeyObject
-
Returned by
compareTo
when the invoking key is greater than the parameter key. - KEY_ERROR - Static variable in class com.coyotegulch.jisp.KeyObject
-
Returned by
compareTo
when the invoking key has a different type from the parameter key. - KEY_LENGTH - Static variable in class com.coyotegulch.jisp.StringKey
- KEY_LESS - Static variable in class com.coyotegulch.jisp.KeyObject
-
Returned by
compareTo
when the invoking key is less than the parameter key. - KEY_MORE - Static variable in class com.coyotegulch.jisp.KeyObject
-
Returned by
compareTo
when the invoking key equals the parameter key. - KeyNotFound - Exception in com.coyotegulch.jisp
-
An
ObjectIndex
throwsKeyNotFound
when a requested key is not found in the index. - KeyNotFound() - Constructor for exception com.coyotegulch.jisp.KeyNotFound
-
Constructs a new
KeyNotFound
with null as its error message string. - KeyNotFound(String) - Constructor for exception com.coyotegulch.jisp.KeyNotFound
-
Constructs a new
KeyNotFound
withs
as its error message string. - KeyObject - Class in com.coyotegulch.jisp
-
KeyObject
defines an characteristics of an object to be used as a key * in anObjectIndex
. - KeyObject() - Constructor for class com.coyotegulch.jisp.KeyObject
L
- length() - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
- 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 in com.coyotegulch.jisp
-
LongKey
defines a key based on thelong
type. - LongKey() - Constructor for class com.coyotegulch.jisp.LongKey
-
Creates a blank
LongKey
(value = 0). - LongKey(long) - Constructor for class com.coyotegulch.jisp.LongKey
-
Creates a new
LongKey
with a specific value. - longValue() - Method in class com.coyotegulch.jisp.LongKey
-
Returns the
long
value of aLongKey
.
M
- m_dataFile - Variable in class com.coyotegulch.jisp.ObjectDatabaseFile
-
Physical file containing serialized objects
- 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_header - Variable in class com.coyotegulch.jisp.BTreeIndex
-
Header data for a file containing B-Tree pages.
- m_pageCache - Variable in class com.coyotegulch.jisp.BTreeIndex
-
A cache of pages that have already been loaded into memory.
- main(String[]) - Static method in class com.coyotegulch.jisp.Jisp
-
The main function, run from the jisp JAR file to display version number and license.
- makeNullKey() - Method in class com.coyotegulch.jisp.KeyObject
-
Returns a "null" (i.e., blank) key, to be used as a space-holder in certain kinds of
ObjectIndexes
. - makeNullKey() - Method in class com.coyotegulch.jisp.LongKey
-
Returns a "null" (i.e., blank)
LongKey
, to be used as a space-holder in certain kinds ofObjectIndexes
. - makeNullKey() - Method in class com.coyotegulch.jisp.StringKey
-
Returns a "null" (i.e., blank)
StringKey
, to be used as a space-holder in certain kinds ofObjectIndexes
. - 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(KeyObject) - Method in class com.coyotegulch.jisp.BTreeIterator
-
Moves this iterator to point to the given
key
. - moveTo(KeyObject) - Method in interface com.coyotegulch.jisp.IndexIterator
-
Moves this iterator to the record associated with the given
key
. - moveTo(KeyObject, boolean) - Method in class com.coyotegulch.jisp.BTreeIterator
-
Moves this iterator to point to the given
key
. - moveTo(KeyObject, boolean) - Method in interface com.coyotegulch.jisp.IndexIterator
-
Moves this iterator to the record associated with the given
key
.
O
- ObjectDatabaseCallback - Interface in com.coyotegulch.jisp
-
An interface to be implemented by objects that wish to be notified of record movements during the compaction of an
ObjectDatabaseFile
. - ObjectDatabaseFile - Class in com.coyotegulch.jisp
-
The
ObjectDatabaseFile
provides a random-access file that serializes objects to variable length records in a random-access file. - ObjectDatabaseFile(File, boolean) - Constructor for class com.coyotegulch.jisp.ObjectDatabaseFile
-
Creates or opens a file that stores objects in variable-length records.
- ObjectDatabaseFile(String, boolean) - Constructor for class com.coyotegulch.jisp.ObjectDatabaseFile
-
Creates or opens a file that stores objects in variable-length records.
- ObjectIndex - Interface in com.coyotegulch.jisp
-
ObjectIndex
defines the concept of anindex
that associateskey
values with references to serializable objects. - optimize() - Method in class com.coyotegulch.jisp.HashIndex
-
Deprecated.Improves the performance of this
HashIndex
by optimizing the index contents.
R
- read(IndexIterator) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
-
Read the object associated with a given iterator.
- read(KeyObject, ObjectIndex) - Method in class com.coyotegulch.jisp.IndexedObjectDatabase
-
Read the object associated with a given key.
- 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
- RecordFilter - Interface in com.coyotegulch.jisp
-
A filter to automatically performs translations on objects stored in database records.
- remove(KeyObject[]) - 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(KeyObject) - Method in class com.coyotegulch.jisp.BTreeIndex
-
Removes the given key from the index.
- removeKey(KeyObject) - Method in class com.coyotegulch.jisp.HashIndex
-
Deprecated.Removes the given key from the index.
- removeKey(KeyObject) - Method in interface com.coyotegulch.jisp.ObjectIndex
-
Removes the given key from the index.
- replaceKey(KeyObject, long) - Method in class com.coyotegulch.jisp.BTreeIndex
-
Replaces the reference for the given key.
- replaceKey(KeyObject, long) - Method in class com.coyotegulch.jisp.HashIndex
-
Deprecated.Replace the reference pos for the given key.
- replaceKey(KeyObject, long) - Method in interface com.coyotegulch.jisp.ObjectIndex
-
Replace the reference pos for the given key.
- 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
- seek(long) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
- 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.
- storeKey(KeyObject, long) - Method in class com.coyotegulch.jisp.BTreeIndex
-
Replaces or inserts the reference for the given key.
- storeKey(KeyObject, long) - Method in class com.coyotegulch.jisp.HashIndex
-
Deprecated.If the key already exists, replace the reference pos for the given key.
- storeKey(KeyObject, long) - Method in interface com.coyotegulch.jisp.ObjectIndex
-
If the key already exists, replace the reference pos for the given key.
- StringKey - Class in com.coyotegulch.jisp
-
StringKey
defines a 16-character fixed-length text key. - StringKey() - Constructor for class com.coyotegulch.jisp.StringKey
-
Creates a blank (null)
StringKey
. - StringKey(String) - Constructor for class com.coyotegulch.jisp.StringKey
-
Creates a new
StringKey
usingkey_value
.
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.KeyObject
-
Returns the
String
representation of aKeyObject
. - toString() - Method in class com.coyotegulch.jisp.LongKey
-
Returns the
String
representation of aLongKey
. - toString() - Method in class com.coyotegulch.jisp.StringKey
-
Returns the
String
representation of aStringKey
.
V
W
- write(KeyObject[], 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.LongKey
-
LongKey
implements thewriteExternal
method to save its contents. - writeExternal(ObjectOutput) - Method in class com.coyotegulch.jisp.StringKey
-
StringKey
implements thewriteExternal
method to save its contents. - writeObject(Serializable) - Method in class com.coyotegulch.jisp.ObjectDatabaseFile
-
Writes a serializable object to the file.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form