Class AjaxSolr.Parameter
Parameter
Defined in: Parameter.js.
Constructor Attributes | Constructor Name and Description |
---|---|
AjaxSolr.Parameter(properties)
Represents a Solr parameter.
|
Method Attributes | Method Name and Description |
---|---|
constructor(attributes)
|
|
<static> |
AjaxSolr.Parameter.escapeValue(value)
Escapes a value, to be used in, for example, an fq parameter.
|
local(name, value)
Returns the value of a local parameter.
|
|
parseString(str)
Parses a string formed by calling string().
|
|
<private> |
parseValueString(str)
Parses a URL-encoded string to return the value.
|
remove(name)
Deletes a local parameter.
|
|
string()
Returns the Solr parameter as a query string key-value pair.
|
|
val(value)
Returns the value.
|
|
<private> |
valueString(value)
Returns the value as a URL-encoded string.
|
Class Detail
AjaxSolr.Parameter(properties)
Represents a Solr parameter.
- Parameters:
- properties
- A map of fields to set. Refer to the list of public fields.
Method Detail
constructor(attributes)
- Parameters:
- {Object} attributes
- {String} attributes.name
- The parameter's name.
- {String} attributes.value Optional
- The parameter's value.
- {Object} attributes.local Optional
- The parameter's local parameters.
<static>
{String}
AjaxSolr.Parameter.escapeValue(value)
Escapes a value, to be used in, for example, an fq parameter. Surrounds
strings containing spaces or colons in double quotes.
- Parameters:
- {String|Number} value
- The value.
- Returns:
- {String} The escaped value.
local(name, value)
Returns the value of a local parameter. If called with a second argument,
sets the value of a local parameter.
- Parameters:
- {String} name
- The name of the local parameter.
- {String|Number|String[]|Number[]} value Optional
- The value to set.
- Returns:
- The value.
parseString(str)
Parses a string formed by calling string().
- Parameters:
- {String} str
- The string to parse.
<private>
{Array}
parseValueString(str)
Parses a URL-encoded string to return the value.
- Parameters:
- {String} str
- The URL-encoded string.
- Returns:
- {Array} The value.
remove(name)
Deletes a local parameter.
- Parameters:
- {String} name
- The name of the local parameter.
string()
Returns the Solr parameter as a query string key-value pair.
IE6 calls the default toString() if you write store.toString() . So, we need to choose another name for toString().
val(value)
Returns the value. If called with an argument, sets the value.
- Parameters:
- {String|Number|String[]|Number[]} value Optional
- The value to set.
- Returns:
- The value.
<private>
{String}
valueString(value)
Returns the value as a URL-encoded string.
- Parameters:
- {String|Number|String[]|Number[]} value
- The value.
- Returns:
- {String} The URL-encoded string.