com.exalead.datamodel.v10

Class AdvancedPointParams

java.lang.Object

com.exalead.datamodel.v10.ExpansionParams

com.exalead.datamodel.v10.AdvancedParams

com.exalead.datamodel.v10.AdvancedPointParams

All Implemented Interfaces:

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

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

Advanced configuration options of a point 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
static boolean	DEFAULT_GENERATE_FROM_SEPARATE_METAS
java.lang.String	firstCoordinateMeta
boolean	generateFromSeparateMetas
java.lang.String	secondCoordinateMeta

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
AdvancedPointParams()
AdvancedPointParams(AdvancedPointParams o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AdvancedPointParams.
static AdvancedPointParams	fromString(java.lang.String s) String representation of this AdvancedPointParams.
java.lang.String	getFirstCoordinateMeta() This meta will be used to define the first coordinate of the point
java.lang.String	getSecondCoordinateMeta() This meta will be used to define the second coordinate of the point
boolean	isGenerateFromSeparateMetas() Content generated by several metas
AdvancedPointParams	makeCopy() Creates and returns a deep copy of this AdvancedPointParams.
static AdvancedPointParams	readFrom(java.io.InputStream is) Read this AdvancedPointParams from an XML fragment.
void	setFirstCoordinateMeta(java.lang.String firstCoordinateMeta) This meta will be used to define the first coordinate of the point
void	setGenerateFromSeparateMetas(boolean generateFromSeparateMetas) Content generated by several metas
void	setSecondCoordinateMeta(java.lang.String secondCoordinateMeta) This meta will be used to define the second coordinate of the point
java.lang.String	toString() String representation of this AdvancedPointParams.
AdvancedPointParams	withCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)
AdvancedPointParams	withCategoryFacetMaxPerLevel(java.lang.Integer categoryFacetMaxPerLevel)
AdvancedPointParams	withCategoryField(java.lang.String categoryField)
AdvancedPointParams	withDateInputFormat(java.lang.String dateInputFormat)
AdvancedPointParams	withDateOutputFormat(java.lang.String dateOutputFormat)
AdvancedPointParams	withDetectTitle(boolean detectTitle)
AdvancedPointParams	withDetectTitle(java.lang.Boolean detectTitle)
AdvancedPointParams	withDoublePrecision(int doublePrecision)
AdvancedPointParams	withDoublePrecision(java.lang.Integer doublePrecision)
AdvancedPointParams	withEnableTrustedQueries(boolean enableTrustedQueries)
AdvancedPointParams	withEnableTrustedQueries(java.lang.Boolean enableTrustedQueries)
AdvancedPointParams	withExpandedPipelines(java.lang.String expandedPipelines)
AdvancedPointParams	withExpandedSearchLogics(java.lang.String expandedSearchLogics)
AdvancedPointParams	withFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)
AdvancedPointParams	withFacetInHits(boolean facetInHits)
AdvancedPointParams	withFacetInHits(java.lang.Boolean facetInHits)
AdvancedPointParams	withFacetInNavigation(boolean facetInNavigation)
AdvancedPointParams	withFacetInNavigation(java.lang.Boolean facetInNavigation)
AdvancedPointParams	withFacetMaxInHits(int facetMaxInHits)
AdvancedPointParams	withFacetMaxInHits(java.lang.Integer facetMaxInHits)
AdvancedPointParams	withFacetReverseSort(boolean facetReverseSort)
AdvancedPointParams	withFacetReverseSort(java.lang.Boolean facetReverseSort)
AdvancedPointParams	withFacetRoot(java.lang.String facetRoot)
AdvancedPointParams	withFacetSortFunction(java.lang.String facetSortFunction)
AdvancedPointParams	withFirstCoordinateMeta(java.lang.String firstCoordinateMeta)
AdvancedPointParams	withForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)
AdvancedPointParams	withGenerateAnalysis(boolean generateAnalysis)
AdvancedPointParams	withGenerateAnalysis(java.lang.Boolean generateAnalysis)
AdvancedPointParams	withGenerateFacet(boolean generateFacet)
AdvancedPointParams	withGenerateFacet(java.lang.Boolean generateFacet)
AdvancedPointParams	withGenerateFromSeparateMetas(boolean generateFromSeparateMetas)
AdvancedPointParams	withGenerateFromSeparateMetas(java.lang.Boolean generateFromSeparateMetas)
AdvancedPointParams	withGenerateIndexSchema(boolean generateIndexSchema)
AdvancedPointParams	withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)
AdvancedPointParams	withGenerateMeta(boolean generateMeta)
AdvancedPointParams	withGenerateMeta(java.lang.Boolean generateMeta)
AdvancedPointParams	withGeneratePrefix(boolean generatePrefix)
AdvancedPointParams	withGeneratePrefix(java.lang.Boolean generatePrefix)
AdvancedPointParams	withGzip(boolean gzip)
AdvancedPointParams	withGzip(java.lang.Boolean gzip)
AdvancedPointParams	withNumericalBits(int numericalBits)
AdvancedPointParams	withNumericalBits(java.lang.Integer numericalBits)
AdvancedPointParams	withPatternSearchEnabled(boolean patternSearchEnabled)
AdvancedPointParams	withPatternSearchEnabled(java.lang.Boolean patternSearchEnabled)
AdvancedPointParams	withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
AdvancedPointParams	withSecondCoordinateMeta(java.lang.String secondCoordinateMeta)
AdvancedPointParams	withUnit(java.lang.String unit)
void	writeTo(java.io.OutputStream os) Write this AdvancedPointParams 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

generateFromSeparateMetas

public boolean generateFromSeparateMetas

DEFAULT_GENERATE_FROM_SEPARATE_METAS

public static final boolean DEFAULT_GENERATE_FROM_SEPARATE_METAS

See Also:

Constant Field Values

firstCoordinateMeta

public java.lang.String firstCoordinateMeta

secondCoordinateMeta

public java.lang.String secondCoordinateMeta

Constructor Detail

AdvancedPointParams

public AdvancedPointParams()

AdvancedPointParams

public AdvancedPointParams(AdvancedPointParams o)

Copy constructor

Method Detail

withFacetSortFunction

public AdvancedPointParams withFacetSortFunction(java.lang.String facetSortFunction)

Overrides:

withFacetSortFunction in class AdvancedParams

withFacetReverseSort

public AdvancedPointParams withFacetReverseSort(boolean facetReverseSort)

Overrides:

withFacetReverseSort in class AdvancedParams

withFacetReverseSort

public AdvancedPointParams withFacetReverseSort(java.lang.Boolean facetReverseSort)

Overrides:

withFacetReverseSort in class AdvancedParams

withFacetExplicitSortOrderValues

public AdvancedPointParams withFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)

Overrides:

withFacetExplicitSortOrderValues in class AdvancedParams

withFacetInHits

public AdvancedPointParams withFacetInHits(boolean facetInHits)

Overrides:

withFacetInHits in class AdvancedParams

withFacetInHits

public AdvancedPointParams withFacetInHits(java.lang.Boolean facetInHits)

Overrides:

withFacetInHits in class AdvancedParams

withFacetInNavigation

public AdvancedPointParams withFacetInNavigation(boolean facetInNavigation)

Overrides:

withFacetInNavigation in class AdvancedParams

withFacetInNavigation

public AdvancedPointParams withFacetInNavigation(java.lang.Boolean facetInNavigation)

Overrides:

withFacetInNavigation in class AdvancedParams

withFacetRoot

public AdvancedPointParams withFacetRoot(java.lang.String facetRoot)

Overrides:

withFacetRoot in class AdvancedParams

withCategoryField

public AdvancedPointParams withCategoryField(java.lang.String categoryField)

Overrides:

withCategoryField in class AdvancedParams

withCategoryFacetMaxPerLevel

public AdvancedPointParams withCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)

Overrides:

withCategoryFacetMaxPerLevel in class AdvancedParams

withCategoryFacetMaxPerLevel

public AdvancedPointParams withCategoryFacetMaxPerLevel(java.lang.Integer categoryFacetMaxPerLevel)

Overrides:

withCategoryFacetMaxPerLevel in class AdvancedParams

withFacetMaxInHits

public AdvancedPointParams withFacetMaxInHits(int facetMaxInHits)

Overrides:

withFacetMaxInHits in class AdvancedParams

withFacetMaxInHits

public AdvancedPointParams withFacetMaxInHits(java.lang.Integer facetMaxInHits)

Overrides:

withFacetMaxInHits in class AdvancedParams

withNumericalBits

public AdvancedPointParams withNumericalBits(int numericalBits)

Overrides:

withNumericalBits in class AdvancedParams

withNumericalBits

public AdvancedPointParams withNumericalBits(java.lang.Integer numericalBits)

Overrides:

withNumericalBits in class AdvancedParams

withDoublePrecision

public AdvancedPointParams withDoublePrecision(int doublePrecision)

Overrides:

withDoublePrecision in class AdvancedParams

withDoublePrecision

public AdvancedPointParams withDoublePrecision(java.lang.Integer doublePrecision)

Overrides:

withDoublePrecision in class AdvancedParams

withEnableTrustedQueries

public AdvancedPointParams withEnableTrustedQueries(boolean enableTrustedQueries)

Overrides:

withEnableTrustedQueries in class AdvancedParams

withEnableTrustedQueries

public AdvancedPointParams withEnableTrustedQueries(java.lang.Boolean enableTrustedQueries)

Overrides:

withEnableTrustedQueries in class AdvancedParams

withDateInputFormat

public AdvancedPointParams withDateInputFormat(java.lang.String dateInputFormat)

Overrides:

withDateInputFormat in class AdvancedParams

withDateOutputFormat

public AdvancedPointParams withDateOutputFormat(java.lang.String dateOutputFormat)

Overrides:

withDateOutputFormat in class AdvancedParams

withGzip

public AdvancedPointParams withGzip(boolean gzip)

Overrides:

withGzip in class AdvancedParams

withGzip

public AdvancedPointParams withGzip(java.lang.Boolean gzip)

Overrides:

withGzip in class AdvancedParams

withUnit

public AdvancedPointParams withUnit(java.lang.String unit)

Overrides:

withUnit in class AdvancedParams

withPatternSearchEnabled

public AdvancedPointParams withPatternSearchEnabled(boolean patternSearchEnabled)

Overrides:

withPatternSearchEnabled in class AdvancedParams

withPatternSearchEnabled

public AdvancedPointParams withPatternSearchEnabled(java.lang.Boolean patternSearchEnabled)

Overrides:

withPatternSearchEnabled in class AdvancedParams

withPatternSearchOptimizationType

public AdvancedPointParams withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)

Overrides:

withPatternSearchOptimizationType in class AdvancedParams

withForcedRankToTextMapping

public AdvancedPointParams withForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)

Overrides:

withForcedRankToTextMapping in class AdvancedParams

withDetectTitle

public AdvancedPointParams withDetectTitle(boolean detectTitle)

Overrides:

withDetectTitle in class AdvancedParams

withDetectTitle

public AdvancedPointParams withDetectTitle(java.lang.Boolean detectTitle)

Overrides:

withDetectTitle in class AdvancedParams

withGenerateAnalysis

public AdvancedPointParams withGenerateAnalysis(boolean generateAnalysis)

Overrides:

withGenerateAnalysis in class AdvancedParams

withGenerateAnalysis

public AdvancedPointParams withGenerateAnalysis(java.lang.Boolean generateAnalysis)

Overrides:

withGenerateAnalysis in class AdvancedParams

withGenerateIndexSchema

public AdvancedPointParams withGenerateIndexSchema(boolean generateIndexSchema)

Overrides:

withGenerateIndexSchema in class AdvancedParams

withGenerateIndexSchema

public AdvancedPointParams withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)

Overrides:

withGenerateIndexSchema in class AdvancedParams

withGeneratePrefix

public AdvancedPointParams withGeneratePrefix(boolean generatePrefix)

Overrides:

withGeneratePrefix in class AdvancedParams

withGeneratePrefix

public AdvancedPointParams withGeneratePrefix(java.lang.Boolean generatePrefix)

Overrides:

withGeneratePrefix in class AdvancedParams

withGenerateFacet

public AdvancedPointParams withGenerateFacet(boolean generateFacet)

Overrides:

withGenerateFacet in class AdvancedParams

withGenerateFacet

public AdvancedPointParams withGenerateFacet(java.lang.Boolean generateFacet)

Overrides:

withGenerateFacet in class AdvancedParams

withGenerateMeta

public AdvancedPointParams withGenerateMeta(boolean generateMeta)

Overrides:

withGenerateMeta in class AdvancedParams

withGenerateMeta

public AdvancedPointParams withGenerateMeta(java.lang.Boolean generateMeta)

Overrides:

withGenerateMeta in class AdvancedParams

withExpandedPipelines

public AdvancedPointParams withExpandedPipelines(java.lang.String expandedPipelines)

Overrides:

withExpandedPipelines in class AdvancedParams

withExpandedSearchLogics

public AdvancedPointParams withExpandedSearchLogics(java.lang.String expandedSearchLogics)

Overrides:

withExpandedSearchLogics in class AdvancedParams

setGenerateFromSeparateMetas

public void setGenerateFromSeparateMetas(boolean generateFromSeparateMetas)

Content generated by several metas

isGenerateFromSeparateMetas

public boolean isGenerateFromSeparateMetas()

Content generated by several metas

withGenerateFromSeparateMetas

public AdvancedPointParams withGenerateFromSeparateMetas(boolean generateFromSeparateMetas)

withGenerateFromSeparateMetas

public AdvancedPointParams withGenerateFromSeparateMetas(java.lang.Boolean generateFromSeparateMetas)

setFirstCoordinateMeta

public void setFirstCoordinateMeta(java.lang.String firstCoordinateMeta)

This meta will be used to define the first coordinate of the point

getFirstCoordinateMeta

public java.lang.String getFirstCoordinateMeta()

This meta will be used to define the first coordinate of the point

withFirstCoordinateMeta

public AdvancedPointParams withFirstCoordinateMeta(java.lang.String firstCoordinateMeta)

setSecondCoordinateMeta

public void setSecondCoordinateMeta(java.lang.String secondCoordinateMeta)

This meta will be used to define the second coordinate of the point

getSecondCoordinateMeta

public java.lang.String getSecondCoordinateMeta()

This meta will be used to define the second coordinate of the point

withSecondCoordinateMeta

public AdvancedPointParams withSecondCoordinateMeta(java.lang.String secondCoordinateMeta)

makeCopy

public AdvancedPointParams makeCopy()

Creates and returns a deep copy of this AdvancedPointParams.

Overrides:

makeCopy in class AdvancedParams

readFrom

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

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

Overrides:

writeTo in class AdvancedParams

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AdvancedPointParams.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AdvancedPointParams.

Overrides:

toString in class AdvancedParams

check

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

Checks this AdvancedPointParams.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AdvancedParams

Throws:

com.exalead.util.TypedException