org.alfresco.repo.search.impl.solr.facet

Class SolrFacetHelper

java.lang.Object

org.alfresco.repo.search.impl.solr.facet.SolrFacetHelper

public class SolrFacetHelper
extends Object

A helper class to overcome the limitation of Solr 1.4 for dealing with facets.

Notice: probably this class or most of its functionalities will be removed when we upgrade to Solr 4

Author:

Jamal Kaabi-Mofrad

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrFacetHelper.ContentSizeBucketsDisplayHandler A simple handler to get the appropriate display label for the content size buckets.
static class	SolrFacetHelper.DateBucketsDisplayHandler A simple handler to get the appropriate display label for the date buckets.
static class	SolrFacetHelper.FacetLabel A class to encapsulate the result of the facet label display handler
static interface	SolrFacetHelper.FacetLabelDisplayHandler Solr facet value and facet query result display label handler
static class	SolrFacetHelper.MimetypeDisplayHandler A simple handler to get the Mimetype display label.
static class	SolrFacetHelper.UserNameDisplayHandler A simple handler to get the full user name from the userID

Constructor Summary

Constructors

Constructor and Description
SolrFacetHelper(ServiceRegistry serviceRegistry) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	createFacetQueriesFromSearchQuery(String searchQuery) Creates Created and Modified facet queries by trying to extract the date range from the Created and/or Modified filter(s) within the search query.
Set<String>	getBucketedFieldFacets() Gets predefined set of field facets which are used to construct bucketing
List<String>	getDefaultFacetQueries() Gets the predefined set of facet queries.
SolrFacetHelper.FacetLabelDisplayHandler	getDisplayHandler(String qName) Gets the appropriate facet display label handler

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrFacetHelper

public SolrFacetHelper(ServiceRegistry serviceRegistry)

Constructor

Parameters:

serviceRegistry -

Method Detail

getDefaultFacetQueries

public List<String> getDefaultFacetQueries()

Gets the predefined set of facet queries. Currently the facet queries are:

Created date buckets Modified date buckets Content size buckets

Returns:

list of facet queries

createFacetQueriesFromSearchQuery

public List<String> createFacetQueriesFromSearchQuery(String searchQuery)

Creates Created and Modified facet queries by trying to extract the date range from the Created and/or Modified filter(s) within the search query. If either of the Created or Modified filter is missing from the search query, the default set of facet queries will be created for the missing date filter. Also, creates the default Content.Size facet queries.

Returns:

list of facet queries

getDisplayHandler

public SolrFacetHelper.FacetLabelDisplayHandler getDisplayHandler(String qName)

Gets the appropriate facet display label handler

Parameters:

qName - the field facet QName

Returns:

the diplayHandler object or null if there is no handler registered for the given @{code qName}

getBucketedFieldFacets

public Set<String> getBucketedFieldFacets()

Gets predefined set of field facets which are used to construct bucketing

Returns:

an unmodifiable view of the set of predefined field facets