com.exalead.search.query

Class FacetingHelpers

java.lang.Object

com.exalead.search.query.FacetingHelpers

public class FacetingHelpers
extends java.lang.Object

Set of helpers to define with generic facets and requirements. A facet refinement is in one of the forms: [+/-]f/facetId/specificString [+/-]kKID (KID=numerical) The following specific forms are recognized: - Refine on a standard category group: f/facetId/Cpath/relative/to/facet/root

Constructor Summary

Constructors

Constructor and Description
FacetingHelpers()

Method Summary

Modifier and Type	Method and Description
static void	dedupNestedRefinements(java.util.List<RefinementHandler.SplitRefinement> splitRefinements) Sort refinement in reverse alphabetical order, because we want to reject all refinements that are prefix of other refinements.
static java.util.Map<java.lang.String,Facet>	getCleanFacetMap(Normalizer norm, java.util.List<Facet> facets) Create a map of facets, perform some cleanup and normalization
static java.util.Map<java.lang.String,Facet>	getClonedFacetMap(java.util.List<Facet> facets)
static java.util.List<RefinementHandler>	getExcludeRefinesForFacet(java.util.List<RefinementHandler> allRefines, java.lang.String facetId) Extract the list of excluding refinements belonging to a given facet
static GeoDomain	getGeoDomainFromId(ExplicitGeoFacet geofacet, int domainId)
static java.util.List<RefinementHandler>	getRefinesForFacet(java.util.List<RefinementHandler> allRefines, java.lang.String facetId) Extract the list of refinements belonging to a given facet
static java.util.List<RefinementHandler>	getRefinesNotForFacet(java.util.List<RefinementHandler> allRefines, java.lang.String facetId) Extract the list of refinements not belonging to a given facet
static java.util.List<java.lang.String>	getRefineStrings(java.util.List<RefinementHandler> refines)
static Node	getSmartRefineNode(java.util.List<RefinementHandler> refines) Compute a node used to refine on a list of refines.
static java.util.Collection<VirtualFieldDefinition>	getVirtualFieldsForRefinements(java.util.Map<java.lang.String,java.util.List<RefinementHandler>> parsedRefinements) Generate the virtual fields needed by the given parsed refinements.
static boolean	hasDisjunctiveRefinements(java.util.Map<java.lang.String,java.util.List<RefinementHandler>> refinements) Check whether disjunctive refinements exist, requiring switch to specific mode
static GeoDomain	parseGeoDomainGeometry(java.lang.String facetSpecific)
static int	parseGeoDomainId(java.lang.String facetSpecific)
static java.util.Map<java.lang.String,java.util.List<RefinementHandler>>	parseRefinesPerGroup(java.util.Map<java.lang.String,Facet> facets, java.util.List<java.lang.String> refinements, QueryContext queryContext) Get a map of parsed refinements, by group.
static java.lang.String	refinementPolicy(int refinementPolicyId)
static int	refinementPolicyId(java.lang.String refinementPolicy)
static java.lang.String	type(int typeId)
static int	typeId(java.lang.String type)
static void	updateGeoFacet(java.lang.String domainDescription, ExplicitGeoFacet geofacet)
static void	zapCategoryRefinement(java.util.Map<java.lang.String,Facet> facets, java.lang.String zapId, java.util.Set<java.lang.String> refinesSet, QueryContext queryContext) Zap an existing category refinement

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetingHelpers

public FacetingHelpers()

Method Detail

getCleanFacetMap

public static java.util.Map<java.lang.String,Facet> getCleanFacetMap(Normalizer norm,
                                                                     java.util.List<Facet> facets)

Create a map of facets, perform some cleanup and normalization

getClonedFacetMap

public static java.util.Map<java.lang.String,Facet> getClonedFacetMap(java.util.List<Facet> facets)

dedupNestedRefinements

public static void dedupNestedRefinements(java.util.List<RefinementHandler.SplitRefinement> splitRefinements)

Sort refinement in reverse alphabetical order, because we want to reject all refinements that are prefix of other refinements. This is more efficient for generic facets, and this is mandatory for MultiDim facets.

parseRefinesPerGroup

public static java.util.Map<java.lang.String,java.util.List<RefinementHandler>> parseRefinesPerGroup(java.util.Map<java.lang.String,Facet> facets,
                                                                                                     java.util.List<java.lang.String> refinements,
                                                                                                     QueryContext queryContext)
                                                                                              throws QueryProcessingException

Get a map of parsed refinements, by group. All refinements contain all necessary information

Parameters:

queryContext -

Throws:

QueryProcessingException

hasDisjunctiveRefinements

public static boolean hasDisjunctiveRefinements(java.util.Map<java.lang.String,java.util.List<RefinementHandler>> refinements)

Check whether disjunctive refinements exist, requiring switch to specific mode

getRefinesNotForFacet

public static java.util.List<RefinementHandler> getRefinesNotForFacet(java.util.List<RefinementHandler> allRefines,
                                                                      java.lang.String facetId)
                                                               throws QueryProcessingException

Extract the list of refinements not belonging to a given facet

Throws:

QueryProcessingException

getRefinesForFacet

public static java.util.List<RefinementHandler> getRefinesForFacet(java.util.List<RefinementHandler> allRefines,
                                                                   java.lang.String facetId)
                                                            throws QueryProcessingException

Extract the list of refinements belonging to a given facet

Throws:

QueryProcessingException

getExcludeRefinesForFacet

public static java.util.List<RefinementHandler> getExcludeRefinesForFacet(java.util.List<RefinementHandler> allRefines,
                                                                          java.lang.String facetId)
                                                                   throws QueryProcessingException

Extract the list of excluding refinements belonging to a given facet

Throws:

QueryProcessingException

getSmartRefineNode

public static Node getSmartRefineNode(java.util.List<RefinementHandler> refines)
                               throws QueryProcessingException

Compute a node used to refine on a list of refines. Pays attention to the refine policy.

Throws:

QueryProcessingException

getRefineStrings

public static java.util.List<java.lang.String> getRefineStrings(java.util.List<RefinementHandler> refines)

zapCategoryRefinement

public static void zapCategoryRefinement(java.util.Map<java.lang.String,Facet> facets,
                                         java.lang.String zapId,
                                         java.util.Set<java.lang.String> refinesSet,
                                         QueryContext queryContext)
                                  throws java.lang.IllegalArgumentException,
                                         QueryProcessingException

Zap an existing category refinement

Throws:

java.lang.IllegalArgumentException

QueryProcessingException

getVirtualFieldsForRefinements

public static java.util.Collection<VirtualFieldDefinition> getVirtualFieldsForRefinements(java.util.Map<java.lang.String,java.util.List<RefinementHandler>> parsedRefinements)

Generate the virtual fields needed by the given parsed refinements. For each refined facet with custom expr (e.g. expr="#random()*100 + myfield"), we generate a virtual field with the given expression to be used for refinements

refinementPolicyId

public static int refinementPolicyId(java.lang.String refinementPolicy)

refinementPolicy

public static java.lang.String refinementPolicy(int refinementPolicyId)

typeId

public static int typeId(java.lang.String type)

type

public static java.lang.String type(int typeId)

updateGeoFacet

public static void updateGeoFacet(java.lang.String domainDescription,
                                  ExplicitGeoFacet geofacet)
                           throws java.lang.Exception

Throws:

java.lang.Exception

parseGeoDomainGeometry

public static GeoDomain parseGeoDomainGeometry(java.lang.String facetSpecific)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

parseGeoDomainId

public static int parseGeoDomainId(java.lang.String facetSpecific)

getGeoDomainFromId

public static GeoDomain getGeoDomainFromId(ExplicitGeoFacet geofacet,
                                           int domainId)
                                    throws java.lang.Exception

Throws:

java.lang.Exception