com.exalead.search.v30

Class ExplicitGeoFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.ExplicitGeoFacet

All Implemented Interfaces:

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

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

Facet on geographical points based on disk and/or polygons

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 boolean	DEFAULT_USE_GEOMETRY_AS_DOMAIN_ID
java.lang.String	field
java.util.List<GeoDomain>	geoDomain
int	hitsMaxCategories
boolean	useGeometryAsDomainId

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

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 ExplicitGeoFacet.
static ExplicitGeoFacet	fromString(java.lang.String s) String representation of this ExplicitGeoFacet.
java.lang.String	getField() The point field on which to perform the synthesis.
java.util.List<GeoDomain>	getGeoDomain() List of GeoDomains
int	getHitsMaxCategories() Maximum number of categories displayed in hits.
boolean	isUseGeometryAsDomainId() The domain id will be computed with the geometric parameters.
ExplicitGeoFacet	makeCopy() Creates and returns a deep copy of this ExplicitGeoFacet.
static ExplicitGeoFacet	readFrom(java.io.InputStream is) Read this ExplicitGeoFacet from an XML fragment.
void	setField(java.lang.String field) The point field on which to perform the synthesis.
void	setHitsMaxCategories(int hitsMaxCategories) Maximum number of categories displayed in hits.
void	setUseGeometryAsDomainId(boolean useGeometryAsDomainId) The domain id will be computed with the geometric parameters.
java.lang.String	toString() String representation of this ExplicitGeoFacet.
ExplicitGeoFacet	withAdditionalFacetView(AdditionalFacetView... __values)
ExplicitGeoFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
ExplicitGeoFacet	withAggregateScores(boolean aggregateScores) Deprecated.
ExplicitGeoFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
ExplicitGeoFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
ExplicitGeoFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
ExplicitGeoFacet	withDataModelClass(java.lang.String dataModelClass)
ExplicitGeoFacet	withDataModelProperty(java.lang.String dataModelProperty)
ExplicitGeoFacet	withDataModelState(java.lang.String dataModelState)
ExplicitGeoFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
ExplicitGeoFacet	withField(java.lang.String field)
ExplicitGeoFacet	withFromDataModel(Facet fromDataModel)
ExplicitGeoFacet	withGeoDomain(java.util.Collection<GeoDomain> __values)
ExplicitGeoFacet	withGeoDomain(GeoDomain... __values) List of GeoDomains
ExplicitGeoFacet	withHitsMaxCategories(int hitsMaxCategories)
ExplicitGeoFacet	withHitsMaxCategories(java.lang.Integer hitsMaxCategories)
ExplicitGeoFacet	withId(java.lang.String id)
ExplicitGeoFacet	withImplementation(java.lang.String implementation)
ExplicitGeoFacet	withIndex(int index)
ExplicitGeoFacet	withIndex(java.lang.Integer index)
ExplicitGeoFacet	withInHits(boolean inHits)
ExplicitGeoFacet	withInHits(java.lang.Boolean inHits)
ExplicitGeoFacet	withInNavigation(boolean inNavigation)
ExplicitGeoFacet	withInNavigation(java.lang.Boolean inNavigation)
ExplicitGeoFacet	withMaxCategories(int maxCategories)
ExplicitGeoFacet	withMaxCategories(java.lang.Integer maxCategories)
ExplicitGeoFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
ExplicitGeoFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
ExplicitGeoFacet	withMaxSliceCategories(int maxSliceCategories)
ExplicitGeoFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
ExplicitGeoFacet	withMinDocsPerCategory(int minDocsPerCategory)
ExplicitGeoFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
ExplicitGeoFacet	withRefinementPolicy(java.lang.String refinementPolicy)
ExplicitGeoFacet	withReverse(boolean reverse)
ExplicitGeoFacet	withReverse(java.lang.Boolean reverse)
ExplicitGeoFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
ExplicitGeoFacet	withSortFunction(java.lang.String sortFunction)
ExplicitGeoFacet	withType(java.lang.String type)
ExplicitGeoFacet	withUseGeometryAsDomainId(boolean useGeometryAsDomainId)
ExplicitGeoFacet	withUseGeometryAsDomainId(java.lang.Boolean useGeometryAsDomainId)
ExplicitGeoFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this ExplicitGeoFacet 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

geoDomain

public java.util.List<GeoDomain> geoDomain

hitsMaxCategories

public int hitsMaxCategories

DEFAULT_HITS_MAX_CATEGORIES

public static final int DEFAULT_HITS_MAX_CATEGORIES

See Also:

Constant Field Values

useGeometryAsDomainId

public boolean useGeometryAsDomainId

DEFAULT_USE_GEOMETRY_AS_DOMAIN_ID

public static final boolean DEFAULT_USE_GEOMETRY_AS_DOMAIN_ID

See Also:

Constant Field Values

Constructor Detail

ExplicitGeoFacet

public ExplicitGeoFacet()

ExplicitGeoFacet

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

ExplicitGeoFacet

public ExplicitGeoFacet(ExplicitGeoFacet o)

Copy constructor

Method Detail

withVirtualRoot

public ExplicitGeoFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public ExplicitGeoFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public ExplicitGeoFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public ExplicitGeoFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public ExplicitGeoFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public ExplicitGeoFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public ExplicitGeoFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public ExplicitGeoFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public ExplicitGeoFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public ExplicitGeoFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public ExplicitGeoFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public ExplicitGeoFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public ExplicitGeoFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public ExplicitGeoFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public ExplicitGeoFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public ExplicitGeoFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public ExplicitGeoFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public ExplicitGeoFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public ExplicitGeoFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public ExplicitGeoFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public ExplicitGeoFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public ExplicitGeoFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public ExplicitGeoFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public ExplicitGeoFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public ExplicitGeoFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public ExplicitGeoFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public ExplicitGeoFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public ExplicitGeoFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public ExplicitGeoFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public ExplicitGeoFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public ExplicitGeoFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

@Deprecated
public ExplicitGeoFacet 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 ExplicitGeoFacet withField(java.lang.String field)

getGeoDomain

public java.util.List<GeoDomain> getGeoDomain()

List of GeoDomains

withGeoDomain

public ExplicitGeoFacet withGeoDomain(GeoDomain... __values)

List of GeoDomains

withGeoDomain

public ExplicitGeoFacet withGeoDomain(java.util.Collection<GeoDomain> __values)

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 ExplicitGeoFacet withHitsMaxCategories(int hitsMaxCategories)

withHitsMaxCategories

public ExplicitGeoFacet withHitsMaxCategories(java.lang.Integer hitsMaxCategories)

setUseGeometryAsDomainId

public void setUseGeometryAsDomainId(boolean useGeometryAsDomainId)

The domain id will be computed with the geometric parameters. Otherwise, an unique id will be used. (recommanded value: false, except for backward compatibility)

isUseGeometryAsDomainId

public boolean isUseGeometryAsDomainId()

The domain id will be computed with the geometric parameters. Otherwise, an unique id will be used. (recommanded value: false, except for backward compatibility)

withUseGeometryAsDomainId

public ExplicitGeoFacet withUseGeometryAsDomainId(boolean useGeometryAsDomainId)

withUseGeometryAsDomainId

public ExplicitGeoFacet withUseGeometryAsDomainId(java.lang.Boolean useGeometryAsDomainId)

makeCopy

public ExplicitGeoFacet makeCopy()

Creates and returns a deep copy of this ExplicitGeoFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

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

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

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ExplicitGeoFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ExplicitGeoFacet.

Overrides:

toString in class VirtualFacet

check

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

Checks this ExplicitGeoFacet.

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