SolrNet.Commands.Parameters.TermsParameters Class Reference

TermsComponent parameters. More...

List of all members.

Public Member Functions
	TermsParameters (string field)
	TermsComponent parameters.
	TermsParameters (IEnumerable< string > fields)
	TermsComponent parameters.
Properties
IEnumerable< string >	Fields [get, set]
	The name of the field to get the terms from. Required. (terms.fl)
string	Lower [get, set]
	Lower bound term to start at. Optional. If not specified, the empty string is used, meaning start at the beginning of the field. (terms.lower)
bool	LowerInclude [get, set]
	Include the lower bound term in the result set. Default is true. (terms.lower.incl)
string	Upper [get, set]
	The term to stop at. Either upper or terms.limit must be set. (terms.upper)
bool	UpperInclude [get, set]
	Include the upper bound term in the result set. Default is false. (terms.upper.incl)
int	MinCount [get, set]
	The minimum doc frequency to return in order to be included. Results are inclusive of the mincount (i.e. >= mincount) (terms.mincount)
int	MaxCount [get, set]
	The maximum doc frequency. Default is -1 to have no upper bound. Results are inclusive of the maxcount (i.e. less than maxcount) (terms.maxcount)
string	Prefix [get, set]
	Restrict matches to terms that start with the prefix. Optional. Use this for implementing AutoComplete! (terms.prefix)
string	Regex [get, set]
	Restrict matches to terms that match the regular expression. Optional. Requires Solr 3.1+ (terms.regex)
ICollection< RegexFlag >	RegexFlag [get, set]
	Flags to be used when evaluating the regular expression defined in the "terms.regex" parameter (see http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#compile%28java.lang.String,%20int%29 for more details). This parameter can be defined multiple times (each time with different flag). Requires Solr 3.1+ (terms.regex.flag)
int	Limit [get, set]
	The maximum number of terms to return. The default is 10. If less than 0, then include all terms. (terms.limit)
bool	Raw [get, set]
	If true, return the raw characters of the indexed term, regardless of if it is human readable. For instance, the indexed form of numeric numbers is not human readable. The default is false. (terms.raw)
TermsSort	Sort [get, set]
	If count, sorts the terms by the term frequency (highest count first). If index, returns the terms in index order. Default is to sort by count. (terms.sort)

---

Detailed Description

TermsComponent parameters.

---

Constructor & Destructor Documentation

SolrNet.Commands.Parameters.TermsParameters.TermsParameters

(

string

field )

TermsComponent parameters.

Parameters:

field

The name of the field to get the terms from.

SolrNet.Commands.Parameters.TermsParameters.TermsParameters

(

IEnumerable< string >

fields )

TermsComponent parameters.

Parameters:

fields

The list of names of the fields to get the terms from.

---

Property Documentation

IEnumerable<string> SolrNet.Commands.Parameters.TermsParameters.Fields [get, set]

The name of the field to get the terms from. Required. (terms.fl)

int SolrNet.Commands.Parameters.TermsParameters.Limit [get, set]

The maximum number of terms to return. The default is 10. If less than 0, then include all terms. (terms.limit)

string SolrNet.Commands.Parameters.TermsParameters.Lower [get, set]

Lower bound term to start at. Optional. If not specified, the empty string is used, meaning start at the beginning of the field. (terms.lower)

bool SolrNet.Commands.Parameters.TermsParameters.LowerInclude [get, set]

Include the lower bound term in the result set. Default is true. (terms.lower.incl)

int SolrNet.Commands.Parameters.TermsParameters.MaxCount [get, set]

The maximum doc frequency. Default is -1 to have no upper bound. Results are inclusive of the maxcount (i.e. less than maxcount) (terms.maxcount)

int SolrNet.Commands.Parameters.TermsParameters.MinCount [get, set]

The minimum doc frequency to return in order to be included. Results are inclusive of the mincount (i.e. >= mincount) (terms.mincount)

string SolrNet.Commands.Parameters.TermsParameters.Prefix [get, set]

Restrict matches to terms that start with the prefix. Optional. Use this for implementing AutoComplete! (terms.prefix)

bool SolrNet.Commands.Parameters.TermsParameters.Raw [get, set]

If true, return the raw characters of the indexed term, regardless of if it is human readable. For instance, the indexed form of numeric numbers is not human readable. The default is false. (terms.raw)

string SolrNet.Commands.Parameters.TermsParameters.Regex [get, set]

Restrict matches to terms that match the regular expression. Optional. Requires Solr 3.1+ (terms.regex)

ICollection<RegexFlag> SolrNet.Commands.Parameters.TermsParameters.RegexFlag [get, set]

Flags to be used when evaluating the regular expression defined in the "terms.regex" parameter (see http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#compile%28java.lang.String,%20int%29 for more details). This parameter can be defined multiple times (each time with different flag). Requires Solr 3.1+ (terms.regex.flag)

TermsSort SolrNet.Commands.Parameters.TermsParameters.Sort [get, set]

If count, sorts the terms by the term frequency (highest count first). If index, returns the terms in index order. Default is to sort by count. (terms.sort)

string SolrNet.Commands.Parameters.TermsParameters.Upper [get, set]

The term to stop at. Either upper or terms.limit must be set. (terms.upper)

bool SolrNet.Commands.Parameters.TermsParameters.UpperInclude [get, set]

Include the upper bound term in the result set. Default is false. (terms.upper.incl)

---

The documentation for this class was generated from the following file:

• SolrNet/Commands/Parameters/TermsParameters.cs