org.jahia.services.search.facets

Class SimpleJahiaJcrFacets

java.lang.Object

org.jahia.services.search.facets.SimpleJahiaJcrFacets

public class SimpleJahiaJcrFacets
extends Object

A class that generates simple Facet information for a request. More advanced facet implementations may compose or subclass this class to leverage any of it's functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.analysis.Analyzer	defaultAnalyzer
protected org.apache.lucene.util.OpenBitSet	docs The main set of documents all facet counts should be relative to
protected org.apache.solr.common.util.SimpleOrderedMap<Object>	facetResponse
Date	NOW
protected org.apache.solr.common.params.SolrParams	params Configuration params behavior should be driven by
static org.apache.lucene.document.FieldSelector	PARENT_AND_TRANSLATION_FIELDS
static String	PROPNAME_INDEX_SEPARATOR
protected org.apache.solr.handler.component.ResponseBuilder	rb
protected org.apache.solr.common.params.SolrParams	required
protected org.apache.jackrabbit.spi.commons.conversion.NamePathResolver	resolver Name and Path resolver.
protected org.apache.lucene.search.IndexSearcher	searcher Searcher to use for all calculations
protected javax.jcr.Session	session Name and Path resolver.
static org.apache.lucene.document.FieldSelector	TRANSLATION_FIELDS

Constructor Summary

Constructors

Constructor and Description
SimpleJahiaJcrFacets(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.util.OpenBitSet docs, org.apache.solr.common.params.SolrParams params, org.apache.jackrabbit.core.query.lucene.SearchIndex index, javax.jcr.Session session, org.apache.jackrabbit.core.query.lucene.NamespaceMappings nsMappings)

Method Summary

Modifier and Type	Method and Description
void	addException(String msg, Exception e)
org.apache.lucene.util.OpenBitSet	getDocIdSet(List<org.apache.lucene.search.Query> queries, String locale) Returns the set of document ids matching all queries.
org.apache.solr.common.util.NamedList<Object>	getFacetCounts() Looks at various Params to determing if any simple Facet Constraint count computations are desired.
org.apache.solr.common.util.NamedList<Object>	getFacetDateCounts() Deprecated. Use getFacetRangeCounts which is more generalized
void	getFacetDateCounts(String dateFacet, org.apache.solr.common.util.NamedList<Object> resOuter) Deprecated. Use getFacetRangeCounts which is more generalized
org.apache.solr.common.util.NamedList<Object>	getFacetFieldCounts() Returns a list of value constraints and the associated facet counts for each facet field specified in the params.
org.apache.solr.common.util.NamedList<Object>	getFacetQueryCounts() Returns a list of facet counts for each of the facet queries specified in the params
org.apache.solr.common.util.NamedList<Object>	getFacetRangeCounts() Returns a list of value constraints and the associated facet counts for each facet numerical field, range, and interval specified in the SolrParams
org.apache.solr.common.util.NamedList<Object>	getFacetTermEnumCounts(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.util.OpenBitSet docs, String field, String fieldName, int offset, int limit, int mincount, boolean missing, String sort, String prefix, String locale, ExtendedPropertyDefinition epd) Returns a list of terms in the specified field along with the corresponding count of documents in the set that match that constraint.
org.apache.solr.common.util.NamedList<Object>	getFieldCacheCounts(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.util.OpenBitSet docs, String fieldName, int offset, int limit, int mincount, boolean missing, String sort, String prefix, String locale, ExtendedPropertyDefinition epd) Use the Lucene FieldCache to get counts for each unique field value in docs.
int	getFieldMissingCount(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.util.OpenBitSet docs, String fieldName, String locale) Returns a count of the documents in the set which do not have any terms for for the specified field.
String	getFieldNameInIndex(String field, String propertyFieldName, ExtendedPropertyDefinition epd, String langCode)
org.apache.solr.common.util.NamedList<Object>	getTermCounts(String field, ExtendedPropertyDefinition epd, String fieldNameInIndex, String locale)
int	maxDoc()
protected int	rangeCount(org.apache.lucene.search.Query rangeQuery) Macro for getting the numDocs of a ConstantScoreRangeQuery over docs
protected int	rangeCount(org.apache.solr.schema.SchemaField sf, Date low, Date high, boolean iLow, boolean iHigh) Deprecated. Use rangeCount(SchemaField,String,String,boolean,boolean) which is more generalized
protected int	rangeCount(org.apache.solr.schema.SchemaField sf, String low, String high, boolean iLow, boolean iHigh) Macro for getting the numDocs of range over docs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPNAME_INDEX_SEPARATOR

public static final String PROPNAME_INDEX_SEPARATOR

See Also:

Constant Field Values

docs

protected org.apache.lucene.util.OpenBitSet docs

The main set of documents all facet counts should be relative to

params

protected org.apache.solr.common.params.SolrParams params

Configuration params behavior should be driven by

required

protected org.apache.solr.common.params.SolrParams required

searcher

protected org.apache.lucene.search.IndexSearcher searcher

Searcher to use for all calculations

rb

protected org.apache.solr.handler.component.ResponseBuilder rb

facetResponse

protected org.apache.solr.common.util.SimpleOrderedMap<Object> facetResponse

NOW

public final Date NOW

defaultAnalyzer

protected org.apache.lucene.analysis.Analyzer defaultAnalyzer

resolver

protected final org.apache.jackrabbit.spi.commons.conversion.NamePathResolver resolver

Name and Path resolver.

session

protected final javax.jcr.Session session

Name and Path resolver.

PARENT_AND_TRANSLATION_FIELDS

public static final org.apache.lucene.document.FieldSelector PARENT_AND_TRANSLATION_FIELDS

TRANSLATION_FIELDS

public static final org.apache.lucene.document.FieldSelector TRANSLATION_FIELDS

Constructor Detail

SimpleJahiaJcrFacets

public SimpleJahiaJcrFacets(org.apache.lucene.search.IndexSearcher searcher,
                            org.apache.lucene.util.OpenBitSet docs,
                            org.apache.solr.common.params.SolrParams params,
                            org.apache.jackrabbit.core.query.lucene.SearchIndex index,
                            javax.jcr.Session session,
                            org.apache.jackrabbit.core.query.lucene.NamespaceMappings nsMappings)

Method Detail

getFacetCounts

public org.apache.solr.common.util.NamedList<Object> getFacetCounts()

Looks at various Params to determing if any simple Facet Constraint count computations are desired.

Returns:

a NamedList of Facet Count info or null

See Also:

getFacetQueryCounts(), getFacetFieldCounts(), getFacetDateCounts(), FacetParams.FACET

addException

public void addException(String msg,
                         Exception e)

getFacetQueryCounts

public org.apache.solr.common.util.NamedList<Object> getFacetQueryCounts()
                                                                  throws IOException,
                                                                         org.apache.lucene.queryParser.ParseException

Returns a list of facet counts for each of the facet queries specified in the params

Throws:

IOException

org.apache.lucene.queryParser.ParseException

See Also:

FacetParams.FACET_QUERY

getTermCounts

public org.apache.solr.common.util.NamedList<Object> getTermCounts(String field,
                                                                   ExtendedPropertyDefinition epd,
                                                                   String fieldNameInIndex,
                                                                   String locale)
                                                            throws IOException,
                                                                   javax.jcr.RepositoryException

Throws:

IOException

javax.jcr.RepositoryException

getFacetFieldCounts

public org.apache.solr.common.util.NamedList<Object> getFacetFieldCounts()
                                                                  throws IOException

Returns a list of value constraints and the associated facet counts for each facet field specified in the params.

Throws:

IOException

See Also:

FacetParams.FACET_FIELD, getFieldMissingCount(org.apache.lucene.search.IndexSearcher, org.apache.lucene.util.OpenBitSet, java.lang.String, java.lang.String), getFacetTermEnumCounts(org.apache.lucene.search.IndexSearcher, org.apache.lucene.util.OpenBitSet, java.lang.String, java.lang.String, int, int, int, boolean, java.lang.String, java.lang.String, java.lang.String, org.jahia.services.content.nodetypes.ExtendedPropertyDefinition)

getFieldMissingCount

public int getFieldMissingCount(org.apache.lucene.search.IndexSearcher searcher,
                                org.apache.lucene.util.OpenBitSet docs,
                                String fieldName,
                                String locale)
                         throws IOException

Returns a count of the documents in the set which do not have any terms for for the specified field.

Throws:

IOException

See Also:

FacetParams.FACET_MISSING

getFieldCacheCounts

public org.apache.solr.common.util.NamedList<Object> getFieldCacheCounts(org.apache.lucene.search.IndexSearcher searcher,
                                                                         org.apache.lucene.util.OpenBitSet docs,
                                                                         String fieldName,
                                                                         int offset,
                                                                         int limit,
                                                                         int mincount,
                                                                         boolean missing,
                                                                         String sort,
                                                                         String prefix,
                                                                         String locale,
                                                                         ExtendedPropertyDefinition epd)
                                                                  throws IOException

Use the Lucene FieldCache to get counts for each unique field value in docs. The field must have at most one indexed token per document.

Throws:

IOException

getFacetTermEnumCounts

public org.apache.solr.common.util.NamedList<Object> getFacetTermEnumCounts(org.apache.lucene.search.IndexSearcher searcher,
                                                                            org.apache.lucene.util.OpenBitSet docs,
                                                                            String field,
                                                                            String fieldName,
                                                                            int offset,
                                                                            int limit,
                                                                            int mincount,
                                                                            boolean missing,
                                                                            String sort,
                                                                            String prefix,
                                                                            String locale,
                                                                            ExtendedPropertyDefinition epd)
                                                                     throws IOException

Returns a list of terms in the specified field along with the corresponding count of documents in the set that match that constraint. This method uses the FilterCache to get the intersection count between docs and the DocSet for each term in the filter.

Throws:

IOException

See Also:

FacetParams.FACET_LIMIT, FacetParams.FACET_ZEROS, FacetParams.FACET_MISSING

getFieldNameInIndex

public String getFieldNameInIndex(String field,
                                  String propertyFieldName,
                                  ExtendedPropertyDefinition epd,
                                  String langCode)

getFacetDateCounts

@Deprecated
public org.apache.solr.common.util.NamedList<Object> getFacetDateCounts()
                                                                             throws JahiaException,
                                                                                    IOException,
                                                                                    javax.jcr.RepositoryException

Deprecated. Use getFacetRangeCounts which is more generalized

Returns a list of value constraints and the associated facet counts for each facet date field, range, and interval specified in the SolrParams

Throws:

JahiaException

IOException

javax.jcr.RepositoryException

See Also:

FacetParams.FACET_DATE

getFacetDateCounts

@Deprecated
public void getFacetDateCounts(String dateFacet,
                                           org.apache.solr.common.util.NamedList<Object> resOuter)
                                    throws IOException,
                                           org.apache.lucene.queryParser.ParseException,
                                           javax.jcr.RepositoryException,
                                           JahiaException

Deprecated. Use getFacetRangeCounts which is more generalized

Throws:

IOException

org.apache.lucene.queryParser.ParseException

javax.jcr.RepositoryException

JahiaException

getFacetRangeCounts

public org.apache.solr.common.util.NamedList<Object> getFacetRangeCounts()

Returns a list of value constraints and the associated facet counts for each facet numerical field, range, and interval specified in the SolrParams

See Also:

FacetParams.FACET_RANGE

rangeCount

protected int rangeCount(org.apache.solr.schema.SchemaField sf,
                         String low,
                         String high,
                         boolean iLow,
                         boolean iHigh)
                  throws IOException

Macro for getting the numDocs of range over docs

Throws:

IOException

See Also:

SolrIndexSearcher.numDocs(org.apache.lucene.search.Query, org.apache.solr.search.DocSet), TermRangeQuery

rangeCount

@Deprecated
protected int rangeCount(org.apache.solr.schema.SchemaField sf,
                                     Date low,
                                     Date high,
                                     boolean iLow,
                                     boolean iHigh)
                              throws IOException

Deprecated. Use rangeCount(SchemaField,String,String,boolean,boolean) which is more generalized

Throws:

IOException

rangeCount

protected int rangeCount(org.apache.lucene.search.Query rangeQuery)
                  throws IOException

Macro for getting the numDocs of a ConstantScoreRangeQuery over docs

Throws:

IOException

getDocIdSet

public org.apache.lucene.util.OpenBitSet getDocIdSet(List<org.apache.lucene.search.Query> queries,
                                                     String locale)
                                              throws IOException

Returns the set of document ids matching all queries. This method is cache-aware and attempts to retrieve the answer from the cache if possible. If the answer was not cached, it may have been inserted into the cache as a result of this call. This method can handle negative queries.

The DocSet returned should not be modified.

Throws:

IOException

maxDoc

public int maxDoc()
           throws IOException

Throws:

IOException