Class Index | File Index

Classes


Class AjaxSolr.ParameterHashStore


Extends AjaxSolr.ParameterStore.
ParameterHashStore
Defined in: ParameterHashStore.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
A parameter store that stores the values of exposed parameters in the URL hash to maintain the application's state.
Field Summary
Field Attributes Field Name and Description
<private>  
A local copy of the URL hash, so we can detect changes to it.
 
The interval in milliseconds to use in setInterval().
<private>  
Reference to the setInterval() function.
Fields borrowed from class AjaxSolr.ParameterStore:
exposed, manager, params
Method Summary
Method Attributes Method Name and Description
 
init()
If loading and saving the hash take longer than interval, we'll hit a race condition.
 
Checks the hash for changes, and loads Solr parameters from the hash and sends a request to Solr if it observes a change or if the hash is empty
 
save()
Stores the values of the exposed parameters in both the local hash and the URL hash.
 
Methods borrowed from class AjaxSolr.ParameterStore:
add, addByValue, exposedReset, exposedString, find, get, isMultiple, load, parseString, remove, removeByValue, string, values
Class Detail
AjaxSolr.ParameterHashStore()
A parameter store that stores the values of exposed parameters in the URL hash to maintain the application's state.

The ParameterHashStore observes the hash for changes and loads Solr parameters from the hash if it observes a change or if the hash is empty.

Field Detail
<private> {String} hash
A local copy of the URL hash, so we can detect changes to it.
Default Value:
""

{Number} interval
The interval in milliseconds to use in setInterval(). Do not set the interval too low as you may set up a race condition.
See:
ParameterHashStore#init()
Default Value:
250

<private> {Function} intervalId
Reference to the setInterval() function.
Method Detail
init()
If loading and saving the hash take longer than interval, we'll hit a race condition. However, this should never happen.

intervalFunction(self)
Checks the hash for changes, and loads Solr parameters from the hash and sends a request to Solr if it observes a change or if the hash is empty
Parameters:
self

save()
Stores the values of the exposed parameters in both the local hash and the URL hash. No other code should be made to change these two values.

storedString()
See:
ParameterStore#storedString()

Documentation generated by JsDoc Toolkit 2.3.0 on Wed Sep 07 2011 22:31:36 GMT-0400 (EDT)