Package io.vertigo.studio.notebook.search

Class FacetSketch

java.lang.Object

io.vertigo.studio.notebook.AbstractSketch

io.vertigo.studio.notebook.search.FacetSketch

All Implemented Interfaces:

Sketch

public final class FacetSketch
extends AbstractSketch

Définition de Facette. Une facette porte sur un champ donné de l'index. On distingue deux types de facettes. - celles remontant les terms d'un champ - celles remontant les valeurs d'une facette discrétisée par une liste de segments. Une facette - est identifiés par un nom unique au sein de son index. - posséde un Titre. Exemple : Pour une liste d'articles, on créera des définitions de facette - pour segmenter les prix, . 0-10€ . 10-50€ . >50€ - pour donner les principaux fabricants, (facette de type 'term') - etc..

Author:

pchretien, mlaroche

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FacetSketch.FacetOrder	Facet order : alpha, count, definition

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREFIX

Fields inherited from interface io.vertigo.studio.notebook.Sketch

REGEX_SKETCH_NAME

Method Summary

Modifier and Type	Method	Description
static FacetSketch	createCustomFacetSketch(String name, DtSketch indexDtSketch, DtSketchField dtField, io.vertigo.core.locale.MessageText label, Map<String,String> facetParams, boolean multiSelectable, FacetSketch.FacetOrder order)	Creates a new facetSketch of type 'custom'.
static FacetSketch	createFacetSketchByRange(String name, DtSketch indexDtSketch, DtSketchField dtField, io.vertigo.core.locale.MessageText label, List<FacetSketchValue> facetValues, boolean multiSelectable, FacetSketch.FacetOrder order)	Creates a new facetSketch of type 'range'.
static FacetSketch	createFacetSketchByTerm(String name, DtSketch indexDtSketch, DtSketchField dtField, io.vertigo.core.locale.MessageText label, boolean multiSelectable, FacetSketch.FacetOrder order)	Creates a new facetSketch of type 'term'.
DtSketchField	getDtField()	Ce champ est nécessairement inclus dans l'index.
Map<String,String>	getFacetParams()
List<FacetSketchValue>	getFacetRanges()
DtSketch	getIndexDtSketch()	Le DtSketch de l'index.
io.vertigo.core.locale.MessageText	getLabel()
FacetSketch.FacetOrder	getOrder()
boolean	isCustomFacet()
boolean	isMultiSelectable()
boolean	isRangeFacet()

Methods inherited from class io.vertigo.studio.notebook.AbstractSketch

getKey, getLocalName, toString

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Method Detail

createFacetSketchByRange

public static FacetSketch createFacetSketchByRange(String name,
                                                   DtSketch indexDtSketch,
                                                   DtSketchField dtField,
                                                   io.vertigo.core.locale.MessageText label,
                                                   List<FacetSketchValue> facetValues,
                                                   boolean multiSelectable,
                                                   FacetSketch.FacetOrder order)

Creates a new facetSketch of type 'range'. A range facet is defined by a list of filters. Examples : [0 -10[ [0-100[ [100-*[

Parameters:

name - the name of the facet

indexDtSketch - the dtSketch of the facet

dtField - the field of the facet

label - the label of the facet

facetValues - the list of filters

multiSelectable - Can select multiple values

order - Facet Order

Returns:

new facetSketch of type 'range'

createFacetSketchByTerm

public static FacetSketch createFacetSketchByTerm(String name,
                                                  DtSketch indexDtSketch,
                                                  DtSketchField dtField,
                                                  io.vertigo.core.locale.MessageText label,
                                                  boolean multiSelectable,
                                                  FacetSketch.FacetOrder order)

Creates a new facetSketch of type 'term'.

Parameters:

name - the name of the facet

indexDtSketch - the dtSketch of the facet

dtField - the field of the facet

label - the label of the facet

multiSelectable - Can select multiple values

order - Facet Order

Returns:

new facetSketch of type 'term'

createCustomFacetSketch

public static FacetSketch createCustomFacetSketch(String name,
                                                  DtSketch indexDtSketch,
                                                  DtSketchField dtField,
                                                  io.vertigo.core.locale.MessageText label,
                                                  Map<String,String> facetParams,
                                                  boolean multiSelectable,
                                                  FacetSketch.FacetOrder order)

Creates a new facetSketch of type 'custom'.

Parameters:

name - the name of the facet

indexDtSketch - the dtSketch of the facet

dtField - the field of the facet

label - the label of the facet

multiSelectable - Can select multiple values

order - Facet Order

Returns:

new facetSketch of type 'term'

getLabel

public io.vertigo.core.locale.MessageText getLabel()

Returns:

the label of the facet

getIndexDtSketch

public DtSketch getIndexDtSketch()

Le DtSketch de l'index.

Returns:

DtSketch sur lequel porte la facette

getDtField

public DtSketchField getDtField()

Ce champ est nécessairement inclus dans l'index.

Returns:

Champ sur lequel porte la facette

getFacetRanges

public List<FacetSketchValue> getFacetRanges()

Returns:

Liste des sélections/range.

getFacetParams

public Map<String,String> getFacetParams()

Returns:

Liste des params.

isRangeFacet

public boolean isRangeFacet()

Returns:

if the facet is of type 'range'

isCustomFacet

public boolean isCustomFacet()

Returns:

if the facet is of type 'custom'

isMultiSelectable

public boolean isMultiSelectable()

Returns:

if the facet is multiSelectable

getOrder

public FacetSketch.FacetOrder getOrder()

Returns:

facet order