public class AdvancedParams extends ExpansionParams implements com.exalead.util.Checkable, java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
AdvancedParams.PatternSearchOptimizationType |
DEFAULT_GENERATE_ANALYSIS, DEFAULT_GENERATE_FACET, DEFAULT_GENERATE_INDEX_SCHEMA, DEFAULT_GENERATE_META, DEFAULT_GENERATE_PREFIX, expandedPipelines, expandedSearchLogics, generateAnalysis, generateFacet, generateIndexSchema, generateMeta, generatePrefix
Constructor and Description |
---|
AdvancedParams() |
AdvancedParams(AdvancedParams o)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
void |
check(boolean deep,
java.lang.String errorContext)
Checks this AdvancedParams.
|
static AdvancedParams |
fromString(java.lang.String s)
String representation of this AdvancedParams.
|
int |
getCategoryFacetMaxPerLevel()
Displays a maximum of N values per level for this property (if a category facet is created).
|
java.lang.String |
getCategoryField()
Replaces the category field for this property (if a category facet is created).
|
java.lang.String |
getDateInputFormat()
Specifies an input format for DateFormatter for numerical properties with date or date_time type
|
java.lang.String |
getDateOutputFormat()
Specifies an output format for numerical properties with date or date_time type, used in full hits
|
int |
getDoublePrecision()
Number of figures after the decimal point (if this is a double property).
|
java.lang.String |
getFacetExplicitSortOrderValues()
Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).
|
int |
getFacetMaxInHits()
Displays a maximum of N values for this property (if a category facet is created).
|
java.lang.String |
getFacetRoot()
Replaces the default facet root path (Top/ClassProperties/
|
java.lang.String |
getFacetSortFunction()
Sorting method if a category facet is created for this property.
|
java.lang.Integer |
getForcedRankToTextMapping()
Sets the ranking value for chunks in mapping to text field.
-1 means that the chunk internal ranking value is kept. |
int |
getNumericalBits()
Number of bits used to store a numerical value.
|
java.lang.String |
getPatternSearchOptimizationType()
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
AdvancedParams.PatternSearchOptimizationType |
getPatternSearchOptimizationTypeAsEnum()
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
java.lang.String |
getUnit()
Unit Of Measurement in which the value is stored
|
static boolean |
isA(java.lang.String str,
AdvancedParams.PatternSearchOptimizationType item) |
boolean |
isDetectTitle()
Detect words set after # in path and use them as title
|
boolean |
isEnableTrustedQueries()
Precomputes the indexing of prefixes for the Trusted Queries widget.
|
boolean |
isFacetInHits()
Displays this property in the hits content (if a category facet is created).
|
boolean |
isFacetInNavigation()
Displays this property in the navigation (if a category facet is created).
|
boolean |
isFacetReverseSort()
Reverse sorting order if a category facet is created for this property.
|
boolean |
isGzip()
Activates content compression (if an alphanum field is created)
|
static boolean |
isOneOf(java.lang.String str,
AdvancedParams.PatternSearchOptimizationType... items) |
boolean |
isPatternSearchEnabled()
Calculates additional dictionaries to perform pattern search within words (native prefix, suffix, substring search using #anumpattern) without relying on pattern expansion.
This has a very high cost in indexing time and indexing size. |
AdvancedParams |
makeCopy()
Creates and returns a deep copy of this AdvancedParams.
|
static AdvancedParams |
readFrom(java.io.InputStream is)
Read this AdvancedParams from an XML fragment.
|
void |
setCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)
Displays a maximum of N values per level for this property (if a category facet is created).
|
void |
setCategoryField(java.lang.String categoryField)
Replaces the category field for this property (if a category facet is created).
|
void |
setDateInputFormat(java.lang.String dateInputFormat)
Specifies an input format for DateFormatter for numerical properties with date or date_time type
|
void |
setDateOutputFormat(java.lang.String dateOutputFormat)
Specifies an output format for numerical properties with date or date_time type, used in full hits
|
void |
setDetectTitle(boolean detectTitle)
Detect words set after # in path and use them as title
|
void |
setDoublePrecision(int doublePrecision)
Number of figures after the decimal point (if this is a double property).
|
void |
setEnableTrustedQueries(boolean enableTrustedQueries)
Precomputes the indexing of prefixes for the Trusted Queries widget.
|
void |
setFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)
Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).
|
void |
setFacetInHits(boolean facetInHits)
Displays this property in the hits content (if a category facet is created).
|
void |
setFacetInNavigation(boolean facetInNavigation)
Displays this property in the navigation (if a category facet is created).
|
void |
setFacetMaxInHits(int facetMaxInHits)
Displays a maximum of N values for this property (if a category facet is created).
|
void |
setFacetReverseSort(boolean facetReverseSort)
Reverse sorting order if a category facet is created for this property.
|
void |
setFacetRoot(java.lang.String facetRoot)
Replaces the default facet root path (Top/ClassProperties/
|
void |
setFacetSortFunction(java.lang.String facetSortFunction)
Sorting method if a category facet is created for this property.
|
void |
setForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)
Sets the ranking value for chunks in mapping to text field.
-1 means that the chunk internal ranking value is kept. |
void |
setGzip(boolean gzip)
Activates content compression (if an alphanum field is created)
|
void |
setNumericalBits(int numericalBits)
Number of bits used to store a numerical value.
|
void |
setPatternSearchEnabled(boolean patternSearchEnabled)
Calculates additional dictionaries to perform pattern search within words (native prefix, suffix, substring search using #anumpattern) without relying on pattern expansion.
This has a very high cost in indexing time and indexing size. |
void |
setPatternSearchOptimizationType(AdvancedParams.PatternSearchOptimizationType item)
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
void |
setPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
void |
setUnit(java.lang.String unit)
Unit Of Measurement in which the value is stored
|
java.lang.String |
toString()
String representation of this AdvancedParams.
|
AdvancedParams |
withCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel) |
AdvancedParams |
withCategoryFacetMaxPerLevel(java.lang.Integer categoryFacetMaxPerLevel) |
AdvancedParams |
withCategoryField(java.lang.String categoryField) |
AdvancedParams |
withDateInputFormat(java.lang.String dateInputFormat) |
AdvancedParams |
withDateOutputFormat(java.lang.String dateOutputFormat) |
AdvancedParams |
withDetectTitle(boolean detectTitle) |
AdvancedParams |
withDetectTitle(java.lang.Boolean detectTitle) |
AdvancedParams |
withDoublePrecision(int doublePrecision) |
AdvancedParams |
withDoublePrecision(java.lang.Integer doublePrecision) |
AdvancedParams |
withEnableTrustedQueries(boolean enableTrustedQueries) |
AdvancedParams |
withEnableTrustedQueries(java.lang.Boolean enableTrustedQueries) |
AdvancedParams |
withExpandedPipelines(java.lang.String expandedPipelines) |
AdvancedParams |
withExpandedSearchLogics(java.lang.String expandedSearchLogics) |
AdvancedParams |
withFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues) |
AdvancedParams |
withFacetInHits(boolean facetInHits) |
AdvancedParams |
withFacetInHits(java.lang.Boolean facetInHits) |
AdvancedParams |
withFacetInNavigation(boolean facetInNavigation) |
AdvancedParams |
withFacetInNavigation(java.lang.Boolean facetInNavigation) |
AdvancedParams |
withFacetMaxInHits(int facetMaxInHits) |
AdvancedParams |
withFacetMaxInHits(java.lang.Integer facetMaxInHits) |
AdvancedParams |
withFacetReverseSort(boolean facetReverseSort) |
AdvancedParams |
withFacetReverseSort(java.lang.Boolean facetReverseSort) |
AdvancedParams |
withFacetRoot(java.lang.String facetRoot) |
AdvancedParams |
withFacetSortFunction(java.lang.String facetSortFunction) |
AdvancedParams |
withForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping) |
AdvancedParams |
withGenerateAnalysis(boolean generateAnalysis) |
AdvancedParams |
withGenerateAnalysis(java.lang.Boolean generateAnalysis) |
AdvancedParams |
withGenerateFacet(boolean generateFacet) |
AdvancedParams |
withGenerateFacet(java.lang.Boolean generateFacet) |
AdvancedParams |
withGenerateIndexSchema(boolean generateIndexSchema) |
AdvancedParams |
withGenerateIndexSchema(java.lang.Boolean generateIndexSchema) |
AdvancedParams |
withGenerateMeta(boolean generateMeta) |
AdvancedParams |
withGenerateMeta(java.lang.Boolean generateMeta) |
AdvancedParams |
withGeneratePrefix(boolean generatePrefix) |
AdvancedParams |
withGeneratePrefix(java.lang.Boolean generatePrefix) |
AdvancedParams |
withGzip(boolean gzip) |
AdvancedParams |
withGzip(java.lang.Boolean gzip) |
AdvancedParams |
withNumericalBits(int numericalBits) |
AdvancedParams |
withNumericalBits(java.lang.Integer numericalBits) |
AdvancedParams |
withPatternSearchEnabled(boolean patternSearchEnabled) |
AdvancedParams |
withPatternSearchEnabled(java.lang.Boolean patternSearchEnabled) |
AdvancedParams |
withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType) |
AdvancedParams |
withUnit(java.lang.String unit) |
void |
writeTo(java.io.OutputStream os)
Write this AdvancedParams as an XML fragment
|
getExpandedPipelines, getExpandedSearchLogics, isGenerateAnalysis, isGenerateFacet, isGenerateIndexSchema, isGenerateMeta, isGeneratePrefix, setExpandedPipelines, setExpandedSearchLogics, setGenerateAnalysis, setGenerateFacet, setGenerateIndexSchema, setGenerateMeta, setGeneratePrefix
public java.lang.String facetSortFunction
public static final java.lang.String DEFAULT_FACET_SORT_FUNCTION
public boolean facetReverseSort
public static final boolean DEFAULT_FACET_REVERSE_SORT
public java.lang.String facetExplicitSortOrderValues
public boolean facetInHits
public static final boolean DEFAULT_FACET_IN_HITS
public boolean facetInNavigation
public static final boolean DEFAULT_FACET_IN_NAVIGATION
public java.lang.String facetRoot
public java.lang.String categoryField
public int categoryFacetMaxPerLevel
public static final int DEFAULT_CATEGORY_FACET_MAX_PER_LEVEL
public int facetMaxInHits
public static final int DEFAULT_FACET_MAX_IN_HITS
public int numericalBits
public static final int DEFAULT_NUMERICAL_BITS
public int doublePrecision
public static final int DEFAULT_DOUBLE_PRECISION
public boolean enableTrustedQueries
public static final boolean DEFAULT_ENABLE_TRUSTED_QUERIES
public java.lang.String dateInputFormat
public java.lang.String dateOutputFormat
public boolean gzip
public static final boolean DEFAULT_GZIP
public java.lang.String unit
public boolean patternSearchEnabled
public static final boolean DEFAULT_PATTERN_SEARCH_ENABLED
public java.lang.String patternSearchOptimizationType
public static final java.lang.String DEFAULT_PATTERN_SEARCH_OPTIMIZATION_TYPE
public java.lang.Integer forcedRankToTextMapping
public boolean detectTitle
public static final boolean DEFAULT_DETECT_TITLE
public AdvancedParams()
public AdvancedParams(AdvancedParams o)
public static boolean isA(java.lang.String str, AdvancedParams.PatternSearchOptimizationType item)
public static boolean isOneOf(java.lang.String str, AdvancedParams.PatternSearchOptimizationType... items)
public void setPatternSearchOptimizationType(AdvancedParams.PatternSearchOptimizationType item)
public AdvancedParams.PatternSearchOptimizationType getPatternSearchOptimizationTypeAsEnum()
public AdvancedParams withGenerateAnalysis(boolean generateAnalysis)
withGenerateAnalysis
in class ExpansionParams
public AdvancedParams withGenerateAnalysis(java.lang.Boolean generateAnalysis)
withGenerateAnalysis
in class ExpansionParams
public AdvancedParams withGenerateIndexSchema(boolean generateIndexSchema)
withGenerateIndexSchema
in class ExpansionParams
public AdvancedParams withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)
withGenerateIndexSchema
in class ExpansionParams
public AdvancedParams withGeneratePrefix(boolean generatePrefix)
withGeneratePrefix
in class ExpansionParams
public AdvancedParams withGeneratePrefix(java.lang.Boolean generatePrefix)
withGeneratePrefix
in class ExpansionParams
public AdvancedParams withGenerateFacet(boolean generateFacet)
withGenerateFacet
in class ExpansionParams
public AdvancedParams withGenerateFacet(java.lang.Boolean generateFacet)
withGenerateFacet
in class ExpansionParams
public AdvancedParams withGenerateMeta(boolean generateMeta)
withGenerateMeta
in class ExpansionParams
public AdvancedParams withGenerateMeta(java.lang.Boolean generateMeta)
withGenerateMeta
in class ExpansionParams
public AdvancedParams withExpandedPipelines(java.lang.String expandedPipelines)
withExpandedPipelines
in class ExpansionParams
public AdvancedParams withExpandedSearchLogics(java.lang.String expandedSearchLogics)
withExpandedSearchLogics
in class ExpansionParams
public void setFacetSortFunction(java.lang.String facetSortFunction)
public java.lang.String getFacetSortFunction()
public AdvancedParams withFacetSortFunction(java.lang.String facetSortFunction)
public void setFacetReverseSort(boolean facetReverseSort)
public boolean isFacetReverseSort()
public AdvancedParams withFacetReverseSort(boolean facetReverseSort)
public AdvancedParams withFacetReverseSort(java.lang.Boolean facetReverseSort)
public void setFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)
public java.lang.String getFacetExplicitSortOrderValues()
public AdvancedParams withFacetExplicitSortOrderValues(java.lang.String facetExplicitSortOrderValues)
public void setFacetInHits(boolean facetInHits)
public boolean isFacetInHits()
public AdvancedParams withFacetInHits(boolean facetInHits)
public AdvancedParams withFacetInHits(java.lang.Boolean facetInHits)
public void setFacetInNavigation(boolean facetInNavigation)
public boolean isFacetInNavigation()
public AdvancedParams withFacetInNavigation(boolean facetInNavigation)
public AdvancedParams withFacetInNavigation(java.lang.Boolean facetInNavigation)
public void setFacetRoot(java.lang.String facetRoot)
public java.lang.String getFacetRoot()
public AdvancedParams withFacetRoot(java.lang.String facetRoot)
public void setCategoryField(java.lang.String categoryField)
public java.lang.String getCategoryField()
public AdvancedParams withCategoryField(java.lang.String categoryField)
public void setCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)
public int getCategoryFacetMaxPerLevel()
public AdvancedParams withCategoryFacetMaxPerLevel(int categoryFacetMaxPerLevel)
public AdvancedParams withCategoryFacetMaxPerLevel(java.lang.Integer categoryFacetMaxPerLevel)
public void setFacetMaxInHits(int facetMaxInHits)
public int getFacetMaxInHits()
public AdvancedParams withFacetMaxInHits(int facetMaxInHits)
public AdvancedParams withFacetMaxInHits(java.lang.Integer facetMaxInHits)
public void setNumericalBits(int numericalBits)
public int getNumericalBits()
public AdvancedParams withNumericalBits(int numericalBits)
public AdvancedParams withNumericalBits(java.lang.Integer numericalBits)
public void setDoublePrecision(int doublePrecision)
public int getDoublePrecision()
public AdvancedParams withDoublePrecision(int doublePrecision)
public AdvancedParams withDoublePrecision(java.lang.Integer doublePrecision)
public void setEnableTrustedQueries(boolean enableTrustedQueries)
public boolean isEnableTrustedQueries()
public AdvancedParams withEnableTrustedQueries(boolean enableTrustedQueries)
public AdvancedParams withEnableTrustedQueries(java.lang.Boolean enableTrustedQueries)
public void setDateInputFormat(java.lang.String dateInputFormat)
public java.lang.String getDateInputFormat()
public AdvancedParams withDateInputFormat(java.lang.String dateInputFormat)
public void setDateOutputFormat(java.lang.String dateOutputFormat)
public java.lang.String getDateOutputFormat()
public AdvancedParams withDateOutputFormat(java.lang.String dateOutputFormat)
public void setGzip(boolean gzip)
public boolean isGzip()
public AdvancedParams withGzip(boolean gzip)
public AdvancedParams withGzip(java.lang.Boolean gzip)
public void setUnit(java.lang.String unit)
public java.lang.String getUnit()
public AdvancedParams withUnit(java.lang.String unit)
public void setPatternSearchEnabled(boolean patternSearchEnabled)
public boolean isPatternSearchEnabled()
public AdvancedParams withPatternSearchEnabled(boolean patternSearchEnabled)
public AdvancedParams withPatternSearchEnabled(java.lang.Boolean patternSearchEnabled)
public void setPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
public java.lang.String getPatternSearchOptimizationType()
public AdvancedParams withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
public void setForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)
public java.lang.Integer getForcedRankToTextMapping()
public AdvancedParams withForcedRankToTextMapping(java.lang.Integer forcedRankToTextMapping)
public void setDetectTitle(boolean detectTitle)
public boolean isDetectTitle()
public AdvancedParams withDetectTitle(boolean detectTitle)
public AdvancedParams withDetectTitle(java.lang.Boolean detectTitle)
public AdvancedParams makeCopy()
makeCopy
in class ExpansionParams
public static AdvancedParams readFrom(java.io.InputStream is) throws javax.xml.bind.JAXBException
javax.xml.bind.JAXBException
public void writeTo(java.io.OutputStream os) throws javax.xml.bind.JAXBException, java.io.IOException
writeTo
in class ExpansionParams
javax.xml.bind.JAXBException
java.io.IOException
public static AdvancedParams fromString(java.lang.String s) throws javax.xml.bind.JAXBException, java.io.UnsupportedEncodingException
javax.xml.bind.JAXBException
java.io.UnsupportedEncodingException
public java.lang.String toString()
toString
in class ExpansionParams
public void check(boolean deep, java.lang.String errorContext) throws com.exalead.util.TypedException
check
in interface com.exalead.util.Checkable
check
in class ExpansionParams
com.exalead.util.TypedException
Copyright © 2021 Dassault Systèmes, All Rights Reserved.