com.exalead.datamodel.v10

Class AdvancedGeoParams

java.lang.Object

com.exalead.datamodel.v10.ExpansionParams

com.exalead.datamodel.v10.AdvancedParams

com.exalead.datamodel.v10.AdvancedGeoParams

All Implemented Interfaces:

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

public class AdvancedGeoParams
extends AdvancedParams
implements com.exalead.util.Checkable, java.io.Serializable

Advanced configuration options of a geo property

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.datamodel.v10.AdvancedParams

AdvancedParams.PatternSearchOptimizationType

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	bboxSuffix
static java.lang.String	DEFAULT_BBOX_SUFFIX
static int	DEFAULT_MAX_BLOCK_SIZE
static int	DEFAULT_PRECISION
int	maxBlockSize
int	precision

Fields inherited from class com.exalead.datamodel.v10.AdvancedParams

categoryFacetMaxPerLevel, categoryField, dateInputFormat, dateOutputFormat, DEFAULT_CATEGORY_FACET_MAX_PER_LEVEL, DEFAULT_DETECT_TITLE, DEFAULT_DOUBLE_PRECISION, DEFAULT_ENABLE_TRUSTED_QUERIES, DEFAULT_FACET_IN_HITS, DEFAULT_FACET_IN_NAVIGATION, DEFAULT_FACET_MAX_IN_HITS, DEFAULT_FACET_REVERSE_SORT, DEFAULT_FACET_SORT_FUNCTION, DEFAULT_GZIP, DEFAULT_NUMERICAL_BITS, DEFAULT_PATTERN_SEARCH_ENABLED, DEFAULT_PATTERN_SEARCH_OPTIMIZATION_TYPE, detectTitle, doublePrecision, enableTrustedQueries, facetExplicitSortOrderValues, facetInHits, facetInNavigation, facetMaxInHits, facetReverseSort, facetRoot, facetSortFunction, forcedRankToTextMapping, gzip, numericalBits, patternSearchEnabled, patternSearchOptimizationType, unit

Fields inherited from class com.exalead.datamodel.v10.ExpansionParams

DEFAULT_GENERATE_ANALYSIS, DEFAULT_GENERATE_FACET, DEFAULT_GENERATE_INDEX_SCHEMA, DEFAULT_GENERATE_META, DEFAULT_GENERATE_PREFIX, expandedPipelines, expandedSearchLogics, generateAnalysis, generateFacet, generateIndexSchema, generateMeta, generatePrefix

Constructor Summary

Constructors

Constructor and Description
AdvancedGeoParams()
AdvancedGeoParams(AdvancedGeoParams o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AdvancedGeoParams.
static AdvancedGeoParams	fromString(java.lang.String s) String representation of this AdvancedGeoParams.
java.lang.String	getBboxSuffix() Meta name suffix for BBox.
int	getMaxBlockSize() Maximum number of objects in lookup structure leaves.
int	getPrecision() The number of decimals that will be used in geometrical representations and computations.
AdvancedGeoParams	makeCopy() Creates and returns a deep copy of this AdvancedGeoParams.
static AdvancedGeoParams	readFrom(java.io.InputStream is) Read this AdvancedGeoParams from an XML fragment.
void	setBboxSuffix(java.lang.String bboxSuffix) Meta name suffix for BBox.
void	setMaxBlockSize(int maxBlockSize) Maximum number of objects in lookup structure leaves.
void	setPrecision(int precision) The number of decimals that will be used in geometrical representations and computations.
java.lang.String	toString() String representation of this AdvancedGeoParams.
AdvancedGeoParams	withBboxSuffix(java.lang.String bboxSuffix)
AdvancedGeoParams	withCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)
AdvancedGeoParams	withCategoryFacetMaxPerLevel(java.lang.Integer categoryFacetMaxPerLevel)
AdvancedGeoParams	withCategoryField(java.lang.String categoryField)
AdvancedGeoParams	withDateInputFormat(java.lang.String dateInputFormat)
AdvancedGeoParams	withDateOutputFormat(java.lang.String dateOutputFormat)
AdvancedGeoParams	withDetectTitle(boolean detectTitle)
AdvancedGeoParams	withDetectTitle(java.lang.Boolean detectTitle)
AdvancedGeoParams	withDoublePrecision(int doublePrecision)
AdvancedGeoParams	withDoublePrecision(java.lang.Integer doublePrecision)
AdvancedGeoParams	withEnableTrustedQueries(boolean enableTrustedQueries)
AdvancedGeoParams	withEnableTrustedQueries(java.lang.Boolean enableTrustedQueries)
AdvancedGeoParams	withExpandedPipelines(java.lang.String expandedPipelines)
AdvancedGeoParams	withExpandedSearchLogics(java.lang.String expandedSearchLogics)
AdvancedGeoParams	withFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)
AdvancedGeoParams	withFacetInHits(boolean facetInHits)
AdvancedGeoParams	withFacetInHits(java.lang.Boolean facetInHits)
AdvancedGeoParams	withFacetInNavigation(boolean facetInNavigation)
AdvancedGeoParams	withFacetInNavigation(java.lang.Boolean facetInNavigation)
AdvancedGeoParams	withFacetMaxInHits(int facetMaxInHits)
AdvancedGeoParams	withFacetMaxInHits(java.lang.Integer facetMaxInHits)
AdvancedGeoParams	withFacetReverseSort(boolean facetReverseSort)
AdvancedGeoParams	withFacetReverseSort(java.lang.Boolean facetReverseSort)
AdvancedGeoParams	withFacetRoot(java.lang.String facetRoot)
AdvancedGeoParams	withFacetSortFunction(java.lang.String facetSortFunction)
AdvancedGeoParams	withForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)
AdvancedGeoParams	withGenerateAnalysis(boolean generateAnalysis)
AdvancedGeoParams	withGenerateAnalysis(java.lang.Boolean generateAnalysis)
AdvancedGeoParams	withGenerateFacet(boolean generateFacet)
AdvancedGeoParams	withGenerateFacet(java.lang.Boolean generateFacet)
AdvancedGeoParams	withGenerateIndexSchema(boolean generateIndexSchema)
AdvancedGeoParams	withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)
AdvancedGeoParams	withGenerateMeta(boolean generateMeta)
AdvancedGeoParams	withGenerateMeta(java.lang.Boolean generateMeta)
AdvancedGeoParams	withGeneratePrefix(boolean generatePrefix)
AdvancedGeoParams	withGeneratePrefix(java.lang.Boolean generatePrefix)
AdvancedGeoParams	withGzip(boolean gzip)
AdvancedGeoParams	withGzip(java.lang.Boolean gzip)
AdvancedGeoParams	withMaxBlockSize(int maxBlockSize)
AdvancedGeoParams	withMaxBlockSize(java.lang.Integer maxBlockSize)
AdvancedGeoParams	withNumericalBits(int numericalBits)
AdvancedGeoParams	withNumericalBits(java.lang.Integer numericalBits)
AdvancedGeoParams	withPatternSearchEnabled(boolean patternSearchEnabled)
AdvancedGeoParams	withPatternSearchEnabled(java.lang.Boolean patternSearchEnabled)
AdvancedGeoParams	withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
AdvancedGeoParams	withPrecision(int precision)
AdvancedGeoParams	withPrecision(java.lang.Integer precision)
AdvancedGeoParams	withUnit(java.lang.String unit)
void	writeTo(java.io.OutputStream os) Write this AdvancedGeoParams as an XML fragment

Methods inherited from class com.exalead.datamodel.v10.AdvancedParams

getCategoryFacetMaxPerLevel, getCategoryField, getDateInputFormat, getDateOutputFormat, getDoublePrecision, getFacetExplicitSortOrderValues, getFacetMaxInHits, getFacetRoot, getFacetSortFunction, getForcedRankToTextMapping, getNumericalBits, getPatternSearchOptimizationType, getPatternSearchOptimizationTypeAsEnum, getUnit, isA, isDetectTitle, isEnableTrustedQueries, isFacetInHits, isFacetInNavigation, isFacetReverseSort, isGzip, isOneOf, isPatternSearchEnabled, setCategoryFacetMaxPerLevel, setCategoryField, setDateInputFormat, setDateOutputFormat, setDetectTitle, setDoublePrecision, setEnableTrustedQueries, setFacetExplicitSortOrderValues, setFacetInHits, setFacetInNavigation, setFacetMaxInHits, setFacetReverseSort, setFacetRoot, setFacetSortFunction, setForcedRankToTextMapping, setGzip, setNumericalBits, setPatternSearchEnabled, setPatternSearchOptimizationType, setPatternSearchOptimizationType, setUnit

Methods inherited from class com.exalead.datamodel.v10.ExpansionParams

getExpandedPipelines, getExpandedSearchLogics, isGenerateAnalysis, isGenerateFacet, isGenerateIndexSchema, isGenerateMeta, isGeneratePrefix, setExpandedPipelines, setExpandedSearchLogics, setGenerateAnalysis, setGenerateFacet, setGenerateIndexSchema, setGenerateMeta, setGeneratePrefix

Methods inherited from class java.lang.Object

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

Field Detail

maxBlockSize

public int maxBlockSize

DEFAULT_MAX_BLOCK_SIZE

public static final int DEFAULT_MAX_BLOCK_SIZE

See Also:

Constant Field Values

precision

public int precision

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

bboxSuffix

public java.lang.String bboxSuffix

DEFAULT_BBOX_SUFFIX

public static final java.lang.String DEFAULT_BBOX_SUFFIX

See Also:

Constant Field Values

Constructor Detail

AdvancedGeoParams

public AdvancedGeoParams()

AdvancedGeoParams

public AdvancedGeoParams(AdvancedGeoParams o)

Copy constructor

Method Detail

withFacetSortFunction

public AdvancedGeoParams withFacetSortFunction(java.lang.String facetSortFunction)

Overrides:

withFacetSortFunction in class AdvancedParams

withFacetReverseSort

public AdvancedGeoParams withFacetReverseSort(boolean facetReverseSort)

Overrides:

withFacetReverseSort in class AdvancedParams

withFacetReverseSort

public AdvancedGeoParams withFacetReverseSort(java.lang.Boolean facetReverseSort)

Overrides:

withFacetReverseSort in class AdvancedParams

withFacetExplicitSortOrderValues

public AdvancedGeoParams withFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)

Overrides:

withFacetExplicitSortOrderValues in class AdvancedParams

withFacetInHits

public AdvancedGeoParams withFacetInHits(boolean facetInHits)

Overrides:

withFacetInHits in class AdvancedParams

withFacetInHits

public AdvancedGeoParams withFacetInHits(java.lang.Boolean facetInHits)

Overrides:

withFacetInHits in class AdvancedParams

withFacetInNavigation

public AdvancedGeoParams withFacetInNavigation(boolean facetInNavigation)

Overrides:

withFacetInNavigation in class AdvancedParams

withFacetInNavigation

public AdvancedGeoParams withFacetInNavigation(java.lang.Boolean facetInNavigation)

Overrides:

withFacetInNavigation in class AdvancedParams

withFacetRoot

public AdvancedGeoParams withFacetRoot(java.lang.String facetRoot)

Overrides:

withFacetRoot in class AdvancedParams

withCategoryField

public AdvancedGeoParams withCategoryField(java.lang.String categoryField)

Overrides:

withCategoryField in class AdvancedParams

withCategoryFacetMaxPerLevel

public AdvancedGeoParams withCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)

Overrides:

withCategoryFacetMaxPerLevel in class AdvancedParams

withCategoryFacetMaxPerLevel

public AdvancedGeoParams withCategoryFacetMaxPerLevel(java.lang.Integer categoryFacetMaxPerLevel)

Overrides:

withCategoryFacetMaxPerLevel in class AdvancedParams

withFacetMaxInHits

public AdvancedGeoParams withFacetMaxInHits(int facetMaxInHits)

Overrides:

withFacetMaxInHits in class AdvancedParams

withFacetMaxInHits

public AdvancedGeoParams withFacetMaxInHits(java.lang.Integer facetMaxInHits)

Overrides:

withFacetMaxInHits in class AdvancedParams

withNumericalBits

public AdvancedGeoParams withNumericalBits(int numericalBits)

Overrides:

withNumericalBits in class AdvancedParams

withNumericalBits

public AdvancedGeoParams withNumericalBits(java.lang.Integer numericalBits)

Overrides:

withNumericalBits in class AdvancedParams

withDoublePrecision

public AdvancedGeoParams withDoublePrecision(int doublePrecision)

Overrides:

withDoublePrecision in class AdvancedParams

withDoublePrecision

public AdvancedGeoParams withDoublePrecision(java.lang.Integer doublePrecision)

Overrides:

withDoublePrecision in class AdvancedParams

withEnableTrustedQueries

public AdvancedGeoParams withEnableTrustedQueries(boolean enableTrustedQueries)

Overrides:

withEnableTrustedQueries in class AdvancedParams

withEnableTrustedQueries

public AdvancedGeoParams withEnableTrustedQueries(java.lang.Boolean enableTrustedQueries)

Overrides:

withEnableTrustedQueries in class AdvancedParams

withDateInputFormat

public AdvancedGeoParams withDateInputFormat(java.lang.String dateInputFormat)

Overrides:

withDateInputFormat in class AdvancedParams

withDateOutputFormat

public AdvancedGeoParams withDateOutputFormat(java.lang.String dateOutputFormat)

Overrides:

withDateOutputFormat in class AdvancedParams

withGzip

public AdvancedGeoParams withGzip(boolean gzip)

Overrides:

withGzip in class AdvancedParams

withGzip

public AdvancedGeoParams withGzip(java.lang.Boolean gzip)

Overrides:

withGzip in class AdvancedParams

withUnit

public AdvancedGeoParams withUnit(java.lang.String unit)

Overrides:

withUnit in class AdvancedParams

withPatternSearchEnabled

public AdvancedGeoParams withPatternSearchEnabled(boolean patternSearchEnabled)

Overrides:

withPatternSearchEnabled in class AdvancedParams

withPatternSearchEnabled

public AdvancedGeoParams withPatternSearchEnabled(java.lang.Boolean patternSearchEnabled)

Overrides:

withPatternSearchEnabled in class AdvancedParams

withPatternSearchOptimizationType

public AdvancedGeoParams withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)

Overrides:

withPatternSearchOptimizationType in class AdvancedParams

withForcedRankToTextMapping

public AdvancedGeoParams withForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)

Overrides:

withForcedRankToTextMapping in class AdvancedParams

withDetectTitle

public AdvancedGeoParams withDetectTitle(boolean detectTitle)

Overrides:

withDetectTitle in class AdvancedParams

withDetectTitle

public AdvancedGeoParams withDetectTitle(java.lang.Boolean detectTitle)

Overrides:

withDetectTitle in class AdvancedParams

withGenerateAnalysis

public AdvancedGeoParams withGenerateAnalysis(boolean generateAnalysis)

Overrides:

withGenerateAnalysis in class AdvancedParams

withGenerateAnalysis

public AdvancedGeoParams withGenerateAnalysis(java.lang.Boolean generateAnalysis)

Overrides:

withGenerateAnalysis in class AdvancedParams

withGenerateIndexSchema

public AdvancedGeoParams withGenerateIndexSchema(boolean generateIndexSchema)

Overrides:

withGenerateIndexSchema in class AdvancedParams

withGenerateIndexSchema

public AdvancedGeoParams withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)

Overrides:

withGenerateIndexSchema in class AdvancedParams

withGeneratePrefix

public AdvancedGeoParams withGeneratePrefix(boolean generatePrefix)

Overrides:

withGeneratePrefix in class AdvancedParams

withGeneratePrefix

public AdvancedGeoParams withGeneratePrefix(java.lang.Boolean generatePrefix)

Overrides:

withGeneratePrefix in class AdvancedParams

withGenerateFacet

public AdvancedGeoParams withGenerateFacet(boolean generateFacet)

Overrides:

withGenerateFacet in class AdvancedParams

withGenerateFacet

public AdvancedGeoParams withGenerateFacet(java.lang.Boolean generateFacet)

Overrides:

withGenerateFacet in class AdvancedParams

withGenerateMeta

public AdvancedGeoParams withGenerateMeta(boolean generateMeta)

Overrides:

withGenerateMeta in class AdvancedParams

withGenerateMeta

public AdvancedGeoParams withGenerateMeta(java.lang.Boolean generateMeta)

Overrides:

withGenerateMeta in class AdvancedParams

withExpandedPipelines

public AdvancedGeoParams withExpandedPipelines(java.lang.String expandedPipelines)

Overrides:

withExpandedPipelines in class AdvancedParams

withExpandedSearchLogics

public AdvancedGeoParams withExpandedSearchLogics(java.lang.String expandedSearchLogics)

Overrides:

withExpandedSearchLogics in class AdvancedParams

setMaxBlockSize

public void setMaxBlockSize(int maxBlockSize)

Maximum number of objects in lookup structure leaves.

getMaxBlockSize

public int getMaxBlockSize()

Maximum number of objects in lookup structure leaves.

withMaxBlockSize

public AdvancedGeoParams withMaxBlockSize(int maxBlockSize)

withMaxBlockSize

public AdvancedGeoParams withMaxBlockSize(java.lang.Integer maxBlockSize)

setPrecision

public void setPrecision(int precision)

The number of decimals that will be used in geometrical representations and computations.

getPrecision

public int getPrecision()

The number of decimals that will be used in geometrical representations and computations.

withPrecision

public AdvancedGeoParams withPrecision(int precision)

withPrecision

public AdvancedGeoParams withPrecision(java.lang.Integer precision)

setBboxSuffix

public void setBboxSuffix(java.lang.String bboxSuffix)

Meta name suffix for BBox.

getBboxSuffix

public java.lang.String getBboxSuffix()

Meta name suffix for BBox.

withBboxSuffix

public AdvancedGeoParams withBboxSuffix(java.lang.String bboxSuffix)

makeCopy

public AdvancedGeoParams makeCopy()

Creates and returns a deep copy of this AdvancedGeoParams.

Overrides:

makeCopy in class AdvancedParams

readFrom

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

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

Overrides:

writeTo in class AdvancedParams

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AdvancedGeoParams.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AdvancedGeoParams.

Overrides:

toString in class AdvancedParams

check

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

Checks this AdvancedGeoParams.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AdvancedParams

Throws:

com.exalead.util.TypedException