org.apache.solr.common.params
Interface FacetParams


public interface FacetParams

Facet parameters


Nested Class Summary
static class FacetParams.FacetDateOther
          An enumeration of the legal values for FACET_DATE_OTHER...
 
Field Summary
static String FACET
          Should facet counts be calculated?
static String FACET_DATE
          Any field whose terms the user wants to enumerate over for Facet Contraint Counts (multi-value)
static String FACET_DATE_END
          Date string indicating the endinging point for a date facet range.
static String FACET_DATE_GAP
          Date Math string indicating the interval of sub-ranges for a date facet range.
static String FACET_DATE_HARD_END
          Boolean indicating how counts should be computed if the range between 'start' and 'end' is not evenly divisible by 'gap'.
static String FACET_DATE_OTHER
          String indicating what "other" ranges should be computed for a date facet range (multi-value).
static String FACET_DATE_START
          Date string indicating the starting point for a date facet range.
static String FACET_ENUM_CACHE_MINDF
          When faceting by enumerating the terms in a field, only use the filterCache for terms with a df >= to this parameter.
static String FACET_FIELD
          Any field whose terms the user wants to enumerate over for Facet Constraint Counts (multi-value)
static String FACET_LIMIT
          Numeric option indicating the maximum number of facet field counts be included in the response for each field - in descending order of count.
static String FACET_MINCOUNT
          Numeric option indicating the minimum number of hits before a facet should be included in the response.
static String FACET_MISSING
          Boolean option indicating whether the response should include a facet field count for all records which have no value for the facet field.
static String FACET_OFFSET
          The offset into the list of facets.
static String FACET_PREFIX
          Only return constraints of a facet field with the given prefix.
static String FACET_QUERY
          Any lucene formated queries the user would like to use for Facet Constraint Counts (multi-value)
static String FACET_SORT
          Boolean option: true causes facets to be sorted by the count, false results in natural index order.
static String FACET_ZEROS
          Boolean option indicating whether facet field counts of "0" should be included in the response.
 

Field Detail

FACET

static final String FACET
Should facet counts be calculated?

See Also:
Constant Field Values

FACET_QUERY

static final String FACET_QUERY
Any lucene formated queries the user would like to use for Facet Constraint Counts (multi-value)

See Also:
Constant Field Values

FACET_FIELD

static final String FACET_FIELD
Any field whose terms the user wants to enumerate over for Facet Constraint Counts (multi-value)

See Also:
Constant Field Values

FACET_OFFSET

static final String FACET_OFFSET
The offset into the list of facets. Can be overridden on a per field basis.

See Also:
Constant Field Values

FACET_LIMIT

static final String FACET_LIMIT
Numeric option indicating the maximum number of facet field counts be included in the response for each field - in descending order of count. Can be overridden on a per field basis.

See Also:
Constant Field Values

FACET_MINCOUNT

static final String FACET_MINCOUNT
Numeric option indicating the minimum number of hits before a facet should be included in the response. Can be overridden on a per field basis.

See Also:
Constant Field Values

FACET_ZEROS

static final String FACET_ZEROS
Boolean option indicating whether facet field counts of "0" should be included in the response. Can be overridden on a per field basis.

See Also:
Constant Field Values

FACET_MISSING

static final String FACET_MISSING
Boolean option indicating whether the response should include a facet field count for all records which have no value for the facet field. Can be overridden on a per field basis.

See Also:
Constant Field Values

FACET_SORT

static final String FACET_SORT
Boolean option: true causes facets to be sorted by the count, false results in natural index order.

See Also:
Constant Field Values

FACET_PREFIX

static final String FACET_PREFIX
Only return constraints of a facet field with the given prefix.

See Also:
Constant Field Values

FACET_ENUM_CACHE_MINDF

static final String FACET_ENUM_CACHE_MINDF
When faceting by enumerating the terms in a field, only use the filterCache for terms with a df >= to this parameter.

See Also:
Constant Field Values

FACET_DATE

static final String FACET_DATE
Any field whose terms the user wants to enumerate over for Facet Contraint Counts (multi-value)

See Also:
Constant Field Values

FACET_DATE_START

static final String FACET_DATE_START
Date string indicating the starting point for a date facet range. Can be overriden on a per field basis.

See Also:
Constant Field Values

FACET_DATE_END

static final String FACET_DATE_END
Date string indicating the endinging point for a date facet range. Can be overriden on a per field basis.

See Also:
Constant Field Values

FACET_DATE_GAP

static final String FACET_DATE_GAP
Date Math string indicating the interval of sub-ranges for a date facet range. Can be overriden on a per field basis.

See Also:
Constant Field Values

FACET_DATE_HARD_END

static final String FACET_DATE_HARD_END
Boolean indicating how counts should be computed if the range between 'start' and 'end' is not evenly divisible by 'gap'. If this value is true, then all counts of ranges involving the 'end' point will use the exact endpoint specified -- this includes the 'between' and 'after' counts as well as the last range computed using the 'gap'. If the value is false, then 'gap' is used to compute the effective endpoint closest to the 'end' param which results in the range between 'start' and 'end' being evenly divisible by 'gap'. The default is false. Can be overriden on a per field basis.

See Also:
Constant Field Values

FACET_DATE_OTHER

static final String FACET_DATE_OTHER
String indicating what "other" ranges should be computed for a date facet range (multi-value). Can be overriden on a per field basis.

See Also:
FacetParams.FacetDateOther, Constant Field Values


Copyright © 2008 Apache Software Foundation. All Rights Reserved.