com.exalead.search.query.refinements

Class FacetRefinementHandler

java.lang.Object

com.exalead.search.query.refinements.RefinementHandler

com.exalead.search.query.refinements.FacetRefinementHandler

Direct Known Subclasses:

AutoTileGeoFacetRefinementHandler, AutoTileGeoV2FacetRefinementHandler, CategoryFacetRefinementHandler, ConcatValueFacetRefinementHandler, EnumFacetRefinementHandler, FalseFacetRefinementHandler, GeoFacetRefinementHandler, Hierarchical2DFacetRefinementHandler, MultiDimFacetRefinementHandler, ValueFacetRefinementHandler, VirtualFacetRefinementHandler

public abstract class FacetRefinementHandler
extends RefinementHandler

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.search.query.refinements.RefinementHandler

RefinementHandler.RefinementPolicy, RefinementHandler.SplitRefinement

Field Summary

Fields

Modifier and Type	Field and Description
protected Facet	facet
protected Node	refinementNode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FacetRefinementHandler(Facet facet, boolean exclude)

Method Summary

Modifier and Type	Method and Description
protected abstract void	buildRefinementNode() create a refinement node depending on the type of refinement
abstract java.lang.String	getCpath() return the full path for the refinement (e.g.
java.lang.String	getId() get the refinement id.
Node	getRefinementNode()
RefinementHandler.RefinementPolicy	getRefinementPolicy() get refinement policy
abstract java.lang.String	getRelpath() return the path relative to the (virtual)Root for the refinement (e.g.
boolean	isExclude()
static java.util.List<java.lang.String>	zapRefinement(Facet f, RefinementHandler.SplitRefinement sr, java.util.Map<java.lang.String,Facet> facetsMap) Take a facet and the facet-specific aprt of the refinement and return the zapped refinement, or null if there is nothing more to refine.

Methods inherited from class com.exalead.search.query.refinements.RefinementHandler

parse, splitRefinement

Methods inherited from class java.lang.Object

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

Field Detail

facet

protected Facet facet

refinementNode

protected Node refinementNode

Constructor Detail

FacetRefinementHandler

protected FacetRefinementHandler(Facet facet,
                                 boolean exclude)

Method Detail

zapRefinement

public static java.util.List<java.lang.String> zapRefinement(Facet f,
                                                             RefinementHandler.SplitRefinement sr,
                                                             java.util.Map<java.lang.String,Facet> facetsMap)
                                                      throws QueryProcessingException

Take a facet and the facet-specific aprt of the refinement and return the zapped refinement, or null if there is nothing more to refine.

Throws:

QueryProcessingException

isExclude

public boolean isExclude()

getRefinementPolicy

public RefinementHandler.RefinementPolicy getRefinementPolicy()

get refinement policy

getId

public java.lang.String getId()

Description copied from class: RefinementHandler

get the refinement id. in the case of a ParsedRelatedTermRefinement, this is "RELATED_TERM". For a ParsedFacetRefinement, it is the facet id.

Specified by:

getId in class RefinementHandler

getCpath

public abstract java.lang.String getCpath()

return the full path for the refinement (e.g. Top/Places/France/Paris)

getRelpath

public abstract java.lang.String getRelpath()

return the path relative to the (virtual)Root for the refinement (e.g. France/Paris)

buildRefinementNode

protected abstract void buildRefinementNode()
                                     throws QueryProcessingException

create a refinement node depending on the type of refinement

Throws:

QueryProcessingException

getRefinementNode

public Node getRefinementNode()

Specified by:

getRefinementNode in class RefinementHandler