Index

A C D E F G H I J K L M N O P R S T U W

A

AbstractFilesystemStore - Class in org.apache.excalibur.store.impl: Stores objects on the filesystem: String objects as text files, all other objects are serialized.
AbstractFilesystemStore() - Constructor for class org.apache.excalibur.store.impl.AbstractFilesystemStore
AbstractFilesystemStore.FSEnumeration - Class in org.apache.excalibur.store.impl
AbstractFilesystemStore.FSEnumeration() - Constructor for class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration
AbstractJispFilesystemStore - Class in org.apache.excalibur.store.impl: This store is based on the Jisp library (http://www.coyotegulch.com/jisp/index.html).
AbstractJispFilesystemStore() - Constructor for class org.apache.excalibur.store.impl.AbstractJispFilesystemStore
AbstractJispFilesystemStore.BTreeObjectEnumeration - Class in org.apache.excalibur.store.impl
AbstractJispFilesystemStore.BTreeObjectEnumeration(BTreeIterator, AbstractJispFilesystemStore) - Constructor for class org.apache.excalibur.store.impl.AbstractJispFilesystemStore.BTreeObjectEnumeration
AbstractReadWriteStore - Class in org.apache.excalibur.store.impl: This is a base implementation for stores that are synchronized by using a read/write lock.
AbstractReadWriteStore() - Constructor for class org.apache.excalibur.store.impl.AbstractReadWriteStore
adaptiveThreadInterval - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
add(String) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration
addKeys(AbstractFilesystemStore.FSEnumeration, File) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore
array - Variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration

C

calcToFree(Store) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl: This method claculates the number of Elements to be freememory out of the Cache.
characterCaseDiff - Static variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore
charactersDontNeedingEncoding - Static variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore: A BitSet defining the characters which don't need encoding
checkMemory() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl: The "checker" thread checks if memory is running low in the jvm.
checkSerializable(Object) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore: This method checks if an object is seriazable.
clear() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Clear the Store of all elements
clear() - Method in class org.apache.excalibur.store.impl.MemoryStore: Clear the Store of all elements
clear() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore: Clear the Store of all elements
clear() - Method in interface org.apache.excalibur.store.Store: Clear the Store of all data it holds
compareTo(KeyObject) - Method in class org.apache.excalibur.store.impl.JispKey: Compares two Keys
containsKey(Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Test if the the index file contains the given key
containsKey(Object) - Method in class org.apache.excalibur.store.impl.MemoryStore: Indicates if the given key is associated to a contained object.
containsKey(Object) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore: Indicates if the given key is associated to a contained object.
containsKey(Object) - Method in interface org.apache.excalibur.store.Store: Indicates if the given key is associated to a contained object.
countKeys(File) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

D

decode(String) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Inverse of encode exept it do not use path.
deserializeObject(File) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: This method deserializes an object from an input stream.
deserializeString(File) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Load a text file contents as a String.
dispose() - Method in class org.apache.excalibur.store.impl.JispFilesystemStore
dispose() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore: Dispose the component
doClear() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Clear the Store of all elements
doClear() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore: Clear the Store of all elements
doClear() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Clear the Store of all data it holds
doContainsKey(Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Indicates if the given key is associated to a contained object.
doContainsKey(Object) - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore: Test if the the index file contains the given key
doContainsKey(Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Indicates if the given key is associated to a contained object.
doFree() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore
doFree() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore
doFree() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Try to free some used memory.
doGet(Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Get the File object associated with the given unique key name.
doGet(Object) - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore: Returns a Object from the store associated with the Key Object
doGet(Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Get the object associated to the given unique key.
doGetKeys() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Returns the list of stored files as an Enumeration of Files
doGetKeys() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore: Returns a Enumeration of all Keys in the indexed file.
doGetKeys() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Returns the list of used keys as an Enumeration of Objects.
doGetSize() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Returns count of the objects in the store, or -1 if could not be obtained.
doGetSize() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore
doGetSize() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Returns count of the objects in the store, or -1 if could not be obtained.
doRemove(Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Remove the object associated to the given key.
doRemove(Object) - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore: Removes a value from the data file with the given key.
doRemove(Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Remove the object associated to the given key.
doRun - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
doStore(Object, Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore: Store the given object in a persistent state.
doStore(Object, Object) - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore: Store the given object in the indexed data file.
doStore(Object, Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore: Store the given object.





E

encode(String) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

Returns a String that uniquely identifies the object.





F

fileFromKey(Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore
 
firstRun - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl

Flag to ignore memory bursts during startup (1st janitor run)

fraction - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
free() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore
 
free() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

Frees some values of the data file.

 TODO: implementation

free() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore

Frees some values of the data file.


free() - Method in class org.apache.excalibur.store.impl.MemoryStore
 
free() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Frees some of the fast memory used by this store.

free() - Method in interface org.apache.excalibur.store.Store

Try to free some used memory.

freeMemory() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

Round Robin alghorithm for freeing the registered caches.

freePhysicalMemory() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

This method forces the garbage collector





G

get(Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore

Returns a Object from the store associated with the Key Object

get(Object) - Method in class org.apache.excalibur.store.impl.MemoryStore

Get the object associated to the given unique key.

get(Object) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Get the object associated to the given unique key.

get(Object) - Method in interface org.apache.excalibur.store.Store

Get the object associated to the given unique key.

getAdaptiveThreadInterval() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getChildInstrumentables() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
getChildInstrumentables() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore
 
getDirectoryPath() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

Returns the repository's full pathname

getFullFilename(File) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

Get the complete filename corresponding to a (typically relative)
 File.

getIndex() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getInstrumentableName() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
getInstrumentableName() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore
 
getInstruments() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
getInstruments() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore
 
getJVM() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getKey() - Method in class org.apache.excalibur.store.impl.JispKey

Return the real key

getMaxHeapSize() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getMinFreeMemory() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getNullKey() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

Return the Null JispKey

getObject(Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore
 
getPriority() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getStoreList() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
getString(Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore
 
getThreadInterval() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 




H

hasMoreElements() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration
 
hasMoreElements() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore.BTreeObjectEnumeration
 
hold(Object, Object) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

This method holds the requested object in a HashMap combined
 with a LinkedList to create the MRU.





I

index - Variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration
 
index - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
interval - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl

The calculated delay for the next checker run in ms

inUse - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl

Amount of memory in use before sleep().

invokeGC - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl

Should the gc be called on low memory?

iterator() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

This method return a java.util.Iterator of every registered stores

 The iterators returned is fail-fast: if list is structurally
 modified at any time after the iterator is created, in any way, the
 iterator will throw a ConcurrentModificationException.


iterator() - Method in interface org.apache.excalibur.store.StoreJanitor

get an iterator to list registered stores





J

JispFilesystemStore - Class in org.apache.excalibur.store.impl

This store is based on the Jisp library
 (http://www.coyotegulch.com/jisp/index.html).

JispFilesystemStore() - Constructor for class org.apache.excalibur.store.impl.JispFilesystemStore
 
JispKey - Class in org.apache.excalibur.store.impl

Wrapper class for Keys to be compatible with the
 Jisp KeyObject.

JispKey() - Constructor for class org.apache.excalibur.store.impl.JispKey
 
JispKey(Object) - Constructor for class org.apache.excalibur.store.impl.JispKey

Constructor for the JispKey object

jvm - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 




K

keys() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore

Returns a Enumeration of all Keys in the indexed file.


keys() - Method in class org.apache.excalibur.store.impl.MemoryStore

Returns the list of used keys as an Enumeration of Objects.

keys() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Returns the list of used keys as an Enumeration.

keys() - Method in interface org.apache.excalibur.store.Store

Returns the list of used keys as an Enumeration of Objects.





L

length - Variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration
 
lock - Variable in class org.apache.excalibur.store.impl.AbstractReadWriteStore

The lock

longDiv(long, long) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 




M

m_cache - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_Database - Variable in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

The database

m_directoryFile - Variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore

The directory repository

m_directoryFile - Variable in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

The directory repository

m_directoryPath - Variable in class org.apache.excalibur.store.impl.AbstractFilesystemStore
 
m_hitsInstrument - Variable in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
m_hitsInstrument - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_Index - Variable in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

And the index

m_instrumentableName - Variable in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
m_instrumentableName - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_Iterator - Variable in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore.BTreeObjectEnumeration
 
m_Key - Variable in class org.apache.excalibur.store.impl.JispKey
 
m_manager - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_maxobjects - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_missesInstrument - Variable in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
m_missesInstrument - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_mrulist - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_Next - Variable in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore.BTreeObjectEnumeration
 
m_persistent - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_persistentStore - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_sizeInstrument - Variable in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
m_sizeInstrument - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_Store - Variable in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore.BTreeObjectEnumeration
 
m_storeJanitor - Variable in class org.apache.excalibur.store.impl.MRUMemoryStore
 
m_table - Variable in class org.apache.excalibur.store.impl.MemoryStore

The shared store

makeNullKey() - Method in class org.apache.excalibur.store.impl.JispKey

Composes a null Kewy

maxHeapSize - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
maxRateOfChange - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl

Used memory change rate in bytes per second

memoryInUse() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

Calculate the JVM memory in use now.

memoryLow() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

Method to check if memory is running low in the JVM.

MemoryStore - Class in org.apache.excalibur.store.impl
 
MemoryStore() - Constructor for class org.apache.excalibur.store.impl.MemoryStore
 
minFreeMemory - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
minThreadInterval - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
minTimeToFill(long) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

Calculate amount of time needed to fill all free memory with given
 fill rate.

MRUMemoryStore - Class in org.apache.excalibur.store.impl

This class provides a cache algorithm for the requested documents.

MRUMemoryStore() - Constructor for class org.apache.excalibur.store.impl.MRUMemoryStore
 




N

nextElement() - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore.FSEnumeration
 
nextElement() - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore.BTreeObjectEnumeration
 
NULL_KEY - Static variable in class org.apache.excalibur.store.impl.JispKey
 




O

org.apache.excalibur.store - package org.apache.excalibur.store
 
org.apache.excalibur.store.impl - package org.apache.excalibur.store.impl
 




P

parameterize(Parameters) - Method in class org.apache.excalibur.store.impl.JispFilesystemStore

Configure the Component.

  A few options can be used
  
     directory - The directory to store the two files belowe
    
     data-file = the name of the data file (Default: store.dat)
    
     index-file = the name of the index file (Default: store.idx)
    
     order = The page size of the B-Tree
  

parameterize(Parameters) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Initialize the MRUMemoryStore.

parameterize(Parameters) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

Parameterize the StoreJanitorImpl.

PERSISTENT_STORE - Static variable in interface org.apache.excalibur.store.Store

The role for a persistent store

priority - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 




R

readExternal(ObjectInput) - Method in class org.apache.excalibur.store.impl.JispKey

The object implements the readExternal method to restore its contents
 by calling the methods of DataInput for primitive types and readObject
 for objects, strings and arrays.

register(Store) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

This method register the stores

register(Store) - Method in interface org.apache.excalibur.store.StoreJanitor

register method for the stores

remove(Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore

Removes a value from the data file with the given key.

remove(Object) - Method in class org.apache.excalibur.store.impl.MemoryStore

Remove the object associated to the given key.

remove(Object) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Remove the object associated to the given key.

remove(Object) - Method in interface org.apache.excalibur.store.Store

Remove the object associated to the given key.

ROLE - Static variable in interface org.apache.excalibur.store.Store

The role for a persistent store

ROLE - Static variable in interface org.apache.excalibur.store.StoreJanitor
 
run() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

The "checker" thread loop.





S

secondRun - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl

Flag to ignore memory bursts during startup (2nd janitor run)

serializeObject(File, Object) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

This method serializes an object to an output stream.

serializeString(File, String) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

Dump a String to a text file.

serialVersionUID - Static variable in class org.apache.excalibur.store.impl.JispKey
 
service(ServiceManager) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Get components of the ComponentLocator

setDirectory(String) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

Sets the repository's location

setDirectory(File) - Method in class org.apache.excalibur.store.impl.AbstractFilesystemStore

Sets the repository's location

setDirectory(File) - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

Sets the repository's location

setIndex(int) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
setInstrumentableName(String) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
setInstrumentableName(String) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore
 
size() - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore
 
size() - Method in class org.apache.excalibur.store.impl.MemoryStore

Returns count of the objects in the store, or -1 if could not be
 obtained.

size() - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Returns count of the objects in the store, or -1 if could not be
 obtained.

size() - Method in interface org.apache.excalibur.store.Store

Returns count of the objects in the store, or -1 if could not be
 obtained.

start() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
stop() - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
store(Object, Object) - Method in class org.apache.excalibur.store.impl.AbstractReadWriteStore

Store the given object in the indexed data file.

store(Object, Object) - Method in class org.apache.excalibur.store.impl.MemoryStore

Store the given object in a persistent state.

store(Object, Object) - Method in class org.apache.excalibur.store.impl.MRUMemoryStore

Store the given object in a persistent state.

Store - Interface in org.apache.excalibur.store

A Store is an object managing arbitrary data.

store(Object, Object) - Method in interface org.apache.excalibur.store.Store

Store the given object.

StoreJanitor - Interface in org.apache.excalibur.store

Interface for the StoreJanitors

StoreJanitorImpl - Class in org.apache.excalibur.store.impl

This class is a implentation of a StoreJanitor.

StoreJanitorImpl() - Constructor for class org.apache.excalibur.store.impl.StoreJanitorImpl
 
storelist - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 




T

threadInterval - Variable in class org.apache.excalibur.store.impl.StoreJanitorImpl
 
TRANSIENT_STORE - Static variable in interface org.apache.excalibur.store.Store

The role for a transient store





U

unregister(Store) - Method in class org.apache.excalibur.store.impl.StoreJanitorImpl

This method unregister the stores

unregister(Store) - Method in interface org.apache.excalibur.store.StoreJanitor

unregister method for the stores





W

wrapKeyObject(Object) - Method in class org.apache.excalibur.store.impl.AbstractJispFilesystemStore

This method wraps around the key Object a Jisp KeyObject.

writeExternal(ObjectOutput) - Method in class org.apache.excalibur.store.impl.JispKey

The object implements the writeExternal method to save its contents
 by calling the methods of DataOutput for its primitive values or
 calling the writeObject method of ObjectOutput for objects, strings,
 and arrays.


A C D E F G H I J K L M N O P R S T U W