com.exalead.search.v30

Class AutoTileGeoV2Facet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.AutoTileGeoV2Facet

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class AutoTileGeoV2Facet
extends VirtualFacet
implements com.exalead.util.Checkable, java.io.Serializable

Configuration for a facet.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.search.v30.VirtualFacet

VirtualFacet.Transformer<T>, VirtualFacet.Visitor

Nested classes/interfaces inherited from class com.exalead.search.v30.Facet

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type

Nested classes/interfaces inherited from class com.exalead.search.v30.FacetView

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HITS_MAX_CATEGORIES
static double	DEFAULT_X_MAX
static double	DEFAULT_X_MIN
static int	DEFAULT_X_NB_CELLS
static double	DEFAULT_Y_MAX
static double	DEFAULT_Y_MIN
static int	DEFAULT_Y_NB_CELLS
java.lang.String	field
int	hitsMaxCategories
double	xMax
double	xMin
int	xNbCells
double	yMax
double	yMin
int	yNbCells

Fields inherited from class com.exalead.search.v30.VirtualFacet

virtualRoot

Fields inherited from class com.exalead.search.v30.Facet

additionalFacetView, aggregationFunction, dataModelClass, dataModelProperty, dataModelState, DEFAULT_IMPLEMENTATION, DEFAULT_IN_HITS, DEFAULT_IN_NAVIGATION, DEFAULT_MAX_SLICE_CATEGORIES, DEFAULT_REFINEMENT_POLICY, fromDataModel, id, implementation, index, inHits, inNavigation, maxSliceCategories, refinementPolicy, type

Fields inherited from class com.exalead.search.v30.FacetView

aggregateScores, DEFAULT_AGGREGATE_SCORES, DEFAULT_MAX_CATEGORIES, DEFAULT_MAX_CATEGORIES_PER_LEVEL, DEFAULT_MIN_DOCS_PER_CATEGORY, DEFAULT_REVERSE, DEFAULT_SORT_FUNCTION, explicitSortOrderValues, maxCategories, maxCategoriesPerLevel, minDocsPerCategory, reverse, sortAggregationFunction, sortFunction

Constructor Summary

Constructors

Constructor and Description
AutoTileGeoV2Facet()
AutoTileGeoV2Facet(AutoTileGeoV2Facet o) Copy constructor
AutoTileGeoV2Facet(java.lang.String id, java.lang.String virtualRoot, java.lang.String field)
AutoTileGeoV2Facet(java.lang.String id, java.lang.String virtualRoot, java.lang.String field, int xNbCells, int yNbCells)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Facet.Transformer<T> transformer, T[] t)
void	accept(Facet.Visitor visitor)
<T> T	accept(FacetView.Transformer<T> transformer, T[] t)
void	accept(FacetView.Visitor visitor)
<T> T	accept(VirtualFacet.Transformer<T> transformer, T[] t)
void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this AutoTileGeoV2Facet.
static AutoTileGeoV2Facet	fromString(java.lang.String s) String representation of this AutoTileGeoV2Facet.
java.lang.String	getField() The geov2 field on which to perform the synthesis.
int	getHitsMaxCategories() Maximum number of categories displayed in hits.
double	getXMax() Maximum bounding box X value.
double	getXMin() Minimum bounding box X value.
int	getXNbCells() Number of tiles in the X direction.
double	getYMax() Maximum bounding box Y value.
double	getYMin() Minimum bounding box Y value.
int	getYNbCells() Number of tiles in the Y direction.
AutoTileGeoV2Facet	makeCopy() Creates and returns a deep copy of this AutoTileGeoV2Facet.
static AutoTileGeoV2Facet	readFrom(java.io.InputStream is) Read this AutoTileGeoV2Facet from an XML fragment.
void	setField(java.lang.String field) The geov2 field on which to perform the synthesis.
void	setHitsMaxCategories(int hitsMaxCategories) Maximum number of categories displayed in hits.
void	setXMax(double xMax) Maximum bounding box X value.
void	setXMin(double xMin) Minimum bounding box X value.
void	setXNbCells(int xNbCells) Number of tiles in the X direction.
void	setYMax(double yMax) Maximum bounding box Y value.
void	setYMin(double yMin) Minimum bounding box Y value.
void	setYNbCells(int yNbCells) Number of tiles in the Y direction.
java.lang.String	toString() String representation of this AutoTileGeoV2Facet.
AutoTileGeoV2Facet	withAdditionalFacetView(AdditionalFacetView... __values)
AutoTileGeoV2Facet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
AutoTileGeoV2Facet	withAggregateScores(boolean aggregateScores) Deprecated.
AutoTileGeoV2Facet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
AutoTileGeoV2Facet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
AutoTileGeoV2Facet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
AutoTileGeoV2Facet	withDataModelClass(java.lang.String dataModelClass)
AutoTileGeoV2Facet	withDataModelProperty(java.lang.String dataModelProperty)
AutoTileGeoV2Facet	withDataModelState(java.lang.String dataModelState)
AutoTileGeoV2Facet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
AutoTileGeoV2Facet	withField(java.lang.String field)
AutoTileGeoV2Facet	withFromDataModel(Facet fromDataModel)
AutoTileGeoV2Facet	withHitsMaxCategories(int hitsMaxCategories)
AutoTileGeoV2Facet	withHitsMaxCategories(java.lang.Integer hitsMaxCategories)
AutoTileGeoV2Facet	withId(java.lang.String id)
AutoTileGeoV2Facet	withImplementation(java.lang.String implementation)
AutoTileGeoV2Facet	withIndex(int index)
AutoTileGeoV2Facet	withIndex(java.lang.Integer index)
AutoTileGeoV2Facet	withInHits(boolean inHits)
AutoTileGeoV2Facet	withInHits(java.lang.Boolean inHits)
AutoTileGeoV2Facet	withInNavigation(boolean inNavigation)
AutoTileGeoV2Facet	withInNavigation(java.lang.Boolean inNavigation)
AutoTileGeoV2Facet	withMaxCategories(int maxCategories)
AutoTileGeoV2Facet	withMaxCategories(java.lang.Integer maxCategories)
AutoTileGeoV2Facet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
AutoTileGeoV2Facet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
AutoTileGeoV2Facet	withMaxSliceCategories(int maxSliceCategories)
AutoTileGeoV2Facet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
AutoTileGeoV2Facet	withMinDocsPerCategory(int minDocsPerCategory)
AutoTileGeoV2Facet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
AutoTileGeoV2Facet	withRefinementPolicy(java.lang.String refinementPolicy)
AutoTileGeoV2Facet	withReverse(boolean reverse)
AutoTileGeoV2Facet	withReverse(java.lang.Boolean reverse)
AutoTileGeoV2Facet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
AutoTileGeoV2Facet	withSortFunction(java.lang.String sortFunction)
AutoTileGeoV2Facet	withType(java.lang.String type)
AutoTileGeoV2Facet	withVirtualRoot(java.lang.String virtualRoot)
AutoTileGeoV2Facet	withXMax(double xMax)
AutoTileGeoV2Facet	withXMin(double xMin)
AutoTileGeoV2Facet	withXNbCells(int xNbCells)
AutoTileGeoV2Facet	withXNbCells(java.lang.Integer xNbCells)
AutoTileGeoV2Facet	withYMax(double yMax)
AutoTileGeoV2Facet	withYMin(double yMin)
AutoTileGeoV2Facet	withYNbCells(int yNbCells)
AutoTileGeoV2Facet	withYNbCells(java.lang.Integer yNbCells)
void	writeTo(java.io.OutputStream os) Write this AutoTileGeoV2Facet as an XML fragment

Methods inherited from class com.exalead.search.v30.VirtualFacet

getVirtualRoot, setVirtualRoot

Methods inherited from class com.exalead.search.v30.Facet

getAdditionalFacetView, getAdditionalFacetViewAsMap, getAdditionalFacetViewById, getAggregationFunction, getAggregationFunctionAsMap, getAggregationFunctionById, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getId, getImplementation, getImplementationAsEnum, getIndex, getMaxSliceCategories, getRefinementPolicy, getRefinementPolicyAsEnum, getType, getTypeAsEnum, isA, isA, isA, isInHits, isInNavigation, isOneOf, isOneOf, isOneOf, removeAdditionalFacetViewById, removeAggregationFunctionById, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setId, setImplementation, setImplementation, setIndex, setInHits, setInNavigation, setMaxSliceCategories, setRefinementPolicy, setRefinementPolicy, setType, setType

Methods inherited from class com.exalead.search.v30.FacetView

getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction

Methods inherited from class java.lang.Object

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

Field Detail

field

public java.lang.String field

xMin

public double xMin

DEFAULT_X_MIN

public static final double DEFAULT_X_MIN

See Also:

Constant Field Values

yMin

public double yMin

DEFAULT_Y_MIN

public static final double DEFAULT_Y_MIN

See Also:

Constant Field Values

xMax

public double xMax

DEFAULT_X_MAX

public static final double DEFAULT_X_MAX

See Also:

Constant Field Values

yMax

public double yMax

DEFAULT_Y_MAX

public static final double DEFAULT_Y_MAX

See Also:

Constant Field Values

xNbCells

public int xNbCells

DEFAULT_X_NB_CELLS

public static final int DEFAULT_X_NB_CELLS

See Also:

Constant Field Values

yNbCells

public int yNbCells

DEFAULT_Y_NB_CELLS

public static final int DEFAULT_Y_NB_CELLS

See Also:

Constant Field Values

hitsMaxCategories

public int hitsMaxCategories

DEFAULT_HITS_MAX_CATEGORIES

public static final int DEFAULT_HITS_MAX_CATEGORIES

See Also:

Constant Field Values

Constructor Detail

AutoTileGeoV2Facet

public AutoTileGeoV2Facet()

AutoTileGeoV2Facet

public AutoTileGeoV2Facet(java.lang.String id,
                          java.lang.String virtualRoot,
                          java.lang.String field)

AutoTileGeoV2Facet

public AutoTileGeoV2Facet(java.lang.String id,
                          java.lang.String virtualRoot,
                          java.lang.String field,
                          int xNbCells,
                          int yNbCells)

AutoTileGeoV2Facet

public AutoTileGeoV2Facet(AutoTileGeoV2Facet o)

Copy constructor

Method Detail

withVirtualRoot

public AutoTileGeoV2Facet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public AutoTileGeoV2Facet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public AutoTileGeoV2Facet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public AutoTileGeoV2Facet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public AutoTileGeoV2Facet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public AutoTileGeoV2Facet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public AutoTileGeoV2Facet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public AutoTileGeoV2Facet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public AutoTileGeoV2Facet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public AutoTileGeoV2Facet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public AutoTileGeoV2Facet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public AutoTileGeoV2Facet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public AutoTileGeoV2Facet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public AutoTileGeoV2Facet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public AutoTileGeoV2Facet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public AutoTileGeoV2Facet withAggregationFunction(AggregationFunction... __values)

A numerical computation to perform on hits matching each value of the facet.

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

public AutoTileGeoV2Facet withAggregationFunction(java.util.Collection<AggregationFunction> __values)

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public AutoTileGeoV2Facet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

public AutoTileGeoV2Facet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public AutoTileGeoV2Facet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public AutoTileGeoV2Facet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public AutoTileGeoV2Facet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public AutoTileGeoV2Facet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public AutoTileGeoV2Facet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public AutoTileGeoV2Facet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public AutoTileGeoV2Facet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public AutoTileGeoV2Facet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public AutoTileGeoV2Facet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public AutoTileGeoV2Facet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public AutoTileGeoV2Facet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public AutoTileGeoV2Facet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public AutoTileGeoV2Facet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public AutoTileGeoV2Facet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

@Deprecated
public AutoTileGeoV2Facet withAggregateScores(java.lang.Boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setField

public void setField(java.lang.String field)

The geov2 field on which to perform the synthesis.

getField

public java.lang.String getField()

The geov2 field on which to perform the synthesis.

withField

public AutoTileGeoV2Facet withField(java.lang.String field)

setXMin

public void setXMin(double xMin)

Minimum bounding box X value.

getXMin

public double getXMin()

Minimum bounding box X value.

withXMin

public AutoTileGeoV2Facet withXMin(double xMin)

setYMin

public void setYMin(double yMin)

Minimum bounding box Y value.

getYMin

public double getYMin()

Minimum bounding box Y value.

withYMin

public AutoTileGeoV2Facet withYMin(double yMin)

setXMax

public void setXMax(double xMax)

Maximum bounding box X value.

getXMax

public double getXMax()

Maximum bounding box X value.

withXMax

public AutoTileGeoV2Facet withXMax(double xMax)

setYMax

public void setYMax(double yMax)

Maximum bounding box Y value.

getYMax

public double getYMax()

Maximum bounding box Y value.

withYMax

public AutoTileGeoV2Facet withYMax(double yMax)

setXNbCells

public void setXNbCells(int xNbCells)

Number of tiles in the X direction.

getXNbCells

public int getXNbCells()

Number of tiles in the X direction.

withXNbCells

public AutoTileGeoV2Facet withXNbCells(int xNbCells)

withXNbCells

public AutoTileGeoV2Facet withXNbCells(java.lang.Integer xNbCells)

setYNbCells

public void setYNbCells(int yNbCells)

Number of tiles in the Y direction.

getYNbCells

public int getYNbCells()

Number of tiles in the Y direction.

withYNbCells

public AutoTileGeoV2Facet withYNbCells(int yNbCells)

withYNbCells

public AutoTileGeoV2Facet withYNbCells(java.lang.Integer yNbCells)

setHitsMaxCategories

public void setHitsMaxCategories(int hitsMaxCategories)

Maximum number of categories displayed in hits.

getHitsMaxCategories

public int getHitsMaxCategories()

Maximum number of categories displayed in hits.

withHitsMaxCategories

public AutoTileGeoV2Facet withHitsMaxCategories(int hitsMaxCategories)

withHitsMaxCategories

public AutoTileGeoV2Facet withHitsMaxCategories(java.lang.Integer hitsMaxCategories)

makeCopy

public AutoTileGeoV2Facet makeCopy()

Creates and returns a deep copy of this AutoTileGeoV2Facet.

Overrides:

makeCopy in class VirtualFacet

readFrom

public static AutoTileGeoV2Facet readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException

Read this AutoTileGeoV2Facet from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this AutoTileGeoV2Facet as an XML fragment

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static AutoTileGeoV2Facet fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException

String representation of this AutoTileGeoV2Facet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AutoTileGeoV2Facet.

Overrides:

toString in class VirtualFacet

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this AutoTileGeoV2Facet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(VirtualFacet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(Facet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public void accept(FacetView.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(VirtualFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Facet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(FacetView.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException