Architecture: ParameterStore

Table of Contents

• Architectural overview
• Manager
• ParameterStore
• Widgets
• Theming

The ParameterStore, as its name suggests, stores Solr parameters.

The ParameterStore defines functions for getting, setting, and removing Solr parameters. Some Solr parameters – like facet.field and fq – may be specified multiple times, while others – like q and start – may be specified only once. The isMultiple method returns true if the parameter may be specified multiple times.

The following functions, which operate on Solr parameters, behave different depending on whether the parameter may be specified multiple times or only once: get, values, add, remove, find, addByValue, and removeByValue. See the documentation for details.

Available parameters

For a list of possible parameters, please consult the links below:

• http://wiki.apache.org/solr/CoreQueryParameters
• http://wiki.apache.org/solr/CommonQueryParameters
• http://wiki.apache.org/solr/SimpleFacetParameters
• http://wiki.apache.org/solr/HighlightingParameters
• http://wiki.apache.org/solr/MoreLikeThis
• http://wiki.apache.org/solr/SpellCheckComponent
• http://wiki.apache.org/solr/StatsComponent
• http://wiki.apache.org/solr/TermsComponent
• http://wiki.apache.org/solr/TermVectorComponent
• http://wiki.apache.org/solr/LocalParams

Exposed parameters

Widgets expose parameters to the user; for example, the demo site‘s tagcloud widget exposes the fq parameter. Whenever the user changes the values of parameters, the application’s state changes. In order for the user to bookmark states and to move between states with the browser’s navigation buttons, each state must be saved. The easiest method is to store the exposed parameters in the URL hash (see the ParameterHashStore class). However, you may implement your own storage method by extending this class.

Extending the ParameterStore

The ParameterStore init abstract method is called by the Manager init method. If extending the ParameterStore class, you may implement its init method to perform any one-time initializations.

More documentation coming soon.