com.exalead.search.v30

Class AutoTileGeoFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.AutoTileGeoFacet

All Implemented Interfaces:

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

public class AutoTileGeoFacet
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 double	DEFAULT_X_BIN_SIZE
static double	DEFAULT_X_MAX
static double	DEFAULT_X_MIN
static double	DEFAULT_Y_BIN_SIZE
static double	DEFAULT_Y_MAX
static double	DEFAULT_Y_MIN
java.lang.String	field
double	xBinSize
double	xMax
double	xMin
double	yBinSize
double	yMax
double	yMin

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
AutoTileGeoFacet()
AutoTileGeoFacet(AutoTileGeoFacet o) Copy constructor
AutoTileGeoFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String field)
AutoTileGeoFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String field, double xBinSize, double yBinSize)

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 AutoTileGeoFacet.
static AutoTileGeoFacet	fromString(java.lang.String s) String representation of this AutoTileGeoFacet.
java.lang.String	getField() The point field on which to perform the synthesis.
double	getXBinSize() Size of a tile in the X direction.
double	getXMax() Maximum bounding box X value.
double	getXMin() Minimum bounding box X value.
double	getYBinSize() Size of a tile in the Y direction.
double	getYMax() Maximum bounding box Y value.
double	getYMin() Minimum bounding box Y value.
AutoTileGeoFacet	makeCopy() Creates and returns a deep copy of this AutoTileGeoFacet.
static AutoTileGeoFacet	readFrom(java.io.InputStream is) Read this AutoTileGeoFacet from an XML fragment.
void	setField(java.lang.String field) The point field on which to perform the synthesis.
void	setXBinSize(double xBinSize) Size of a tile in the X direction.
void	setXMax(double xMax) Maximum bounding box X value.
void	setXMin(double xMin) Minimum bounding box X value.
void	setYBinSize(double yBinSize) Size of a tile in the Y direction.
void	setYMax(double yMax) Maximum bounding box Y value.
void	setYMin(double yMin) Minimum bounding box Y value.
java.lang.String	toString() String representation of this AutoTileGeoFacet.
AutoTileGeoFacet	withAdditionalFacetView(AdditionalFacetView... __values)
AutoTileGeoFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
AutoTileGeoFacet	withAggregateScores(boolean aggregateScores) Deprecated.
AutoTileGeoFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
AutoTileGeoFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
AutoTileGeoFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
AutoTileGeoFacet	withDataModelClass(java.lang.String dataModelClass)
AutoTileGeoFacet	withDataModelProperty(java.lang.String dataModelProperty)
AutoTileGeoFacet	withDataModelState(java.lang.String dataModelState)
AutoTileGeoFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
AutoTileGeoFacet	withField(java.lang.String field)
AutoTileGeoFacet	withFromDataModel(Facet fromDataModel)
AutoTileGeoFacet	withId(java.lang.String id)
AutoTileGeoFacet	withImplementation(java.lang.String implementation)
AutoTileGeoFacet	withIndex(int index)
AutoTileGeoFacet	withIndex(java.lang.Integer index)
AutoTileGeoFacet	withInHits(boolean inHits)
AutoTileGeoFacet	withInHits(java.lang.Boolean inHits)
AutoTileGeoFacet	withInNavigation(boolean inNavigation)
AutoTileGeoFacet	withInNavigation(java.lang.Boolean inNavigation)
AutoTileGeoFacet	withMaxCategories(int maxCategories)
AutoTileGeoFacet	withMaxCategories(java.lang.Integer maxCategories)
AutoTileGeoFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
AutoTileGeoFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
AutoTileGeoFacet	withMaxSliceCategories(int maxSliceCategories)
AutoTileGeoFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
AutoTileGeoFacet	withMinDocsPerCategory(int minDocsPerCategory)
AutoTileGeoFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
AutoTileGeoFacet	withRefinementPolicy(java.lang.String refinementPolicy)
AutoTileGeoFacet	withReverse(boolean reverse)
AutoTileGeoFacet	withReverse(java.lang.Boolean reverse)
AutoTileGeoFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
AutoTileGeoFacet	withSortFunction(java.lang.String sortFunction)
AutoTileGeoFacet	withType(java.lang.String type)
AutoTileGeoFacet	withVirtualRoot(java.lang.String virtualRoot)
AutoTileGeoFacet	withXBinSize(double xBinSize)
AutoTileGeoFacet	withXMax(double xMax)
AutoTileGeoFacet	withXMin(double xMin)
AutoTileGeoFacet	withYBinSize(double yBinSize)
AutoTileGeoFacet	withYMax(double yMax)
AutoTileGeoFacet	withYMin(double yMin)
void	writeTo(java.io.OutputStream os) Write this AutoTileGeoFacet 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

xBinSize

public double xBinSize

DEFAULT_X_BIN_SIZE

public static final double DEFAULT_X_BIN_SIZE

See Also:

Constant Field Values

yBinSize

public double yBinSize

DEFAULT_Y_BIN_SIZE

public static final double DEFAULT_Y_BIN_SIZE

See Also:

Constant Field Values

Constructor Detail

AutoTileGeoFacet

public AutoTileGeoFacet()

AutoTileGeoFacet

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

AutoTileGeoFacet

public AutoTileGeoFacet(java.lang.String id,
                        java.lang.String virtualRoot,
                        java.lang.String field,
                        double xBinSize,
                        double yBinSize)

AutoTileGeoFacet

public AutoTileGeoFacet(AutoTileGeoFacet o)

Copy constructor

Method Detail

withVirtualRoot

public AutoTileGeoFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public AutoTileGeoFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public AutoTileGeoFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public AutoTileGeoFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public AutoTileGeoFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public AutoTileGeoFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public AutoTileGeoFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public AutoTileGeoFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public AutoTileGeoFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public AutoTileGeoFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public AutoTileGeoFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public AutoTileGeoFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public AutoTileGeoFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public AutoTileGeoFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public AutoTileGeoFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public AutoTileGeoFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public AutoTileGeoFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public AutoTileGeoFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public AutoTileGeoFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public AutoTileGeoFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public AutoTileGeoFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public AutoTileGeoFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public AutoTileGeoFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public AutoTileGeoFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public AutoTileGeoFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public AutoTileGeoFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public AutoTileGeoFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public AutoTileGeoFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public AutoTileGeoFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public AutoTileGeoFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public AutoTileGeoFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setField

public void setField(java.lang.String field)

The point field on which to perform the synthesis.

getField

public java.lang.String getField()

The point field on which to perform the synthesis.

withField

public AutoTileGeoFacet 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 AutoTileGeoFacet 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 AutoTileGeoFacet 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 AutoTileGeoFacet 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 AutoTileGeoFacet withYMax(double yMax)

setXBinSize

public void setXBinSize(double xBinSize)

Size of a tile in the X direction.

getXBinSize

public double getXBinSize()

Size of a tile in the X direction.

withXBinSize

public AutoTileGeoFacet withXBinSize(double xBinSize)

setYBinSize

public void setYBinSize(double yBinSize)

Size of a tile in the Y direction.

getYBinSize

public double getYBinSize()

Size of a tile in the Y direction.

withYBinSize

public AutoTileGeoFacet withYBinSize(double yBinSize)

makeCopy

public AutoTileGeoFacet makeCopy()

Creates and returns a deep copy of this AutoTileGeoFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

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

Read this AutoTileGeoFacet 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 AutoTileGeoFacet as an XML fragment

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AutoTileGeoFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AutoTileGeoFacet.

Overrides:

toString in class VirtualFacet

check

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

Checks this AutoTileGeoFacet.

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