lucene-solr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Solr Wiki] Update of "SimpleFacetParameters" by FergusMcMenemie
Date Mon, 15 Jun 2009 12:08:02 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by FergusMcMenemie:
http://wiki.apache.org/solr/SimpleFacetParameters

The comment on the change is:
typos and some clarification

------------------------------------------------------------------------------
- Solr provides a [http://lucene.apache.org/solr/docs/api/org/apache/solr/request/SimpleFacets.html
Simple Faceting toolkit] which can be reused by various Request Handlers to include "Facet
counts" based on some simple criteria. Both the StandardRequestHandler and the DisMaxRequestHandler
currently use these utilities.
+ Solr provides a [http://lucene.apache.org/solr/docs/api/org/apache/solr/request/SimpleFacets.html
Simple Faceting toolkit] which can be reused by various Request Handlers to include a "Facet
counts" section within a search response. This extra section provides a breakdown or summary
of the results based on some simple criteria, which can used to help implement more advanced
search interfaces. Use of faceting does not affect the results section of a search response.
Both the StandardRequestHandler and the DisMaxRequestHandler currently use these utilities.
  
- For More information on General Issues involved with Faceted searchs in Solr, please read
the SolrFacetingOverview.
+ For More information on General Issues involved with Faceted searches in Solr, please read
the SolrFacetingOverview.
  
  
  [[TableOfContents]]
  
  = Parameters =
  
- These are the parameters used to drive the Simple Faceting behavior, grouped based on the
type of faceting they support.
+ These are the parameters used to drive the Simple Faceting behavior, grouped by the type
of faceting they support.
  
  Note that many parameters may be overridden on a per-field basis with the following syntax:
  
-    `f.<fieldName>.<originalParam>=<value>`
+    `f.<fieldName>.<FacetParam>=<value>`
  
+ eg. 
+ {{{
+   facet.limit=10
- eg. `f.category.facet.limit=5`
+   f.category.facet.limit=5
+ }}}
+ Indicating that 10 terms will be returned for all specified facet.fields, excepting category.
Which if specified will return 5 terms.
  
  == facet ==
  
@@ -23, +28 @@

  
  The default value is blank.
  
- == Arbitrary Query Faceting: facet.query ==
+ == facet.query : Arbitrary Query Faceting  ==
  
- This param allows you to specify an arbitrary query in the Lucene default syntax to generate
a facet count.  It can be particularly useful for numeric range based facets, or prefix based
facets.
+ This param allows you to specify an arbitrary query in the Lucene default syntax to generate
a facet count. By default faceting will automatically determine the unique terms for a field
and return a count for each term. facet.query allows you to determine the terms or expressions
you want to see a count of, you would normally specify a number of facet.querys to do anything
useful. It can be particularly useful for numeric range based facets, or prefix based facets.
  
  This parameter can be specified multiple times to indicate that multiple queries should
be used as separate facet constraints.
  
@@ -167, +172 @@

  
  === facet.date.hardend ===
  
- A Boolean parameter instructing Solr what do do in the event that {{{facet.date.gap}}} does
not divide evenly between {{{facet.date.start}}} and {{{facet.date.end}}}.  If this is true,
the last date range constraint will have an upper bound of {{{facet.date.end}}}; if false,
the last date range will have the smallest possible upper bound greater then {{{facet.date.end}}}
such that the range is exactly {{{facet.date.gap}}} wide.
+ A Boolean parameter instructing Solr what to do in the event that {{{facet.date.gap}}} does
not divide evenly between {{{facet.date.start}}} and {{{facet.date.end}}}.  If this is true,
the last date range constraint will have an upper bound of {{{facet.date.end}}}; if false,
the last date range will have the smallest possible upper bound greater then {{{facet.date.end}}}
such that the range is exactly {{{facet.date.gap}}} wide.
  
  The default is false.
  

Mime
View raw message