Serialized Form
-
Package com.broadleafcommerce.search.api
-
Class com.broadleafcommerce.search.api.DistributedLockException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.InvalidSearchException extends Exception implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.SearchException extends Exception implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.SearchIndexException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.TypeAheadException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
-
Package com.broadleafcommerce.search.api.domain
-
Class com.broadleafcommerce.search.api.domain.Facet extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
displayOrder
Integer displayOrder
Order in which to display this facet on a list of facets. A lower number indicates this item will occur earlier in the returned facet list. -
facetRule
String facetRule
The rule required to be met for this facet to be active. This is by default a SpEL expression, but may be any expression language.- See Also:
- Spring SpEL documentation
-
label
String label
A value intended for display on a UI. For example, "Manufacturer", "Price", "Category", etc. -
multiSelect
boolean multiSelect
Determines whether or not this facet allows multiple values to be selected. -
name
String name
Name to use to identify the facet. Typically, this should correspond to aFieldDefinition.getAbbreviation()
. -
ranged
boolean ranged
Designates whether or not this facet is ranged. For example price might be a ranged facet ($0.00-49.99, $50.00-99.99, etc), or date ranges. -
ranges
List<FacetRange> ranges
The different range options available for filtering on this search facet.
-
-
Class com.broadleafcommerce.search.api.domain.FacetRange extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
displayOrder
Integer displayOrder
Order in which to display this range on a list of facet ranges. A lower number indicates this item will occur earlier in the returned facet range list. -
label
String label
The label for this facet range, suitable for display. -
maxValue
String maxValue
The highest value included in this facet range. -
minValue
String minValue
The lowest value included in this facet range.
-
-
Class com.broadleafcommerce.search.api.domain.FacetResponse extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
facet
Facet facet
The facet which was determined in the search. -
values
List<FacetValue> values
The values returned from search for this facet.
-
-
Class com.broadleafcommerce.search.api.domain.FacetValue extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
active
boolean active
Whether or not this facet value was active on the search -
displayOrder
Integer displayOrder
The display order for this facet value. Used only for sorting, not returned in JSON object. -
maxValue
String maxValue
If ranged, the upper bound of values matching this facet value -
minValue
String minValue
If ranged, the lower bound of values matching this facet value -
quantity
int quantity
The quantity of results matching this facet value -
ranged
boolean ranged
Whether or not this value is a range. -
value
String value
The value label for this facet value.
-
-
Class com.broadleafcommerce.search.api.domain.FieldDefinition extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
abbreviation
String abbreviation
Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names. -
combined
boolean combined
Whether or not this field should be a combination of multiple path values. If true, then instead of propertyPath, the multi-valued propertyPaths will be used and joined with the delimiter. -
delimiter
String delimiter
If this is a combined field, this is the delimiter string which should separate the values found from the propertyPaths. -
facet
Facet facet
The facet which is driven by this field. -
faceted
boolean faceted
Indicates if this field has a facet. -
facetVariantType
String facetVariantType
The field variant type which should be faceted on.If not provided, the first variant type will be used.
-
fieldQueries
List<FieldQuery> fieldQueries
Defines how this field should be queried by variants on particular query types. -
fieldVariantMap
Map<String,FieldVariant> fieldVariantMap
A map of each field variant type to the correspondingFieldVariant
. Populated byFieldDefinition.getVariantMap()
. -
id
String id
The context ID of the field. -
indexableType
String indexableType
The type to which this field belongs. Populated byIndexableType
type. -
label
String label
The label of the field, suitable for display. -
multiValued
boolean multiValued
Whether or not this field should contain a list of values. -
multiValuedCombinedPropertyRootPath
String multiValuedCombinedPropertyRootPath
For fields which are bothFieldDefinition.multiValued
ANDFieldDefinition.combined
, this will be path to the list containing the objects representing each value. For example, to combine property paths for each category in a list of all categories in the object being indexed, this would becategories[*]
. -
propertyPath
String propertyPath
The JSON path of this field excluding the root prefix, "$.". This is the path to the actual value that will be stored in the index, e.g. 'price', 'description', 'customer.name', etc.For more advanced mapping options, see the JSONPath documentation
-
propertyPaths
List<String> propertyPaths
If this is a combined field, these are the JSON paths to the fields to be combined into the final value, excluding the root prefix, "$.".For combined fields, all property paths should point to a single-valued object, the String value of which will be used.
For fields which are both
FieldDefinition.multiValued
ANDFieldDefinition.combined
, the root for this path will be an individual object in the list defined by theFieldDefinition.multiValuedCombinedPropertyRootPath
. For example, if the indexable domain was:{ "categories": [ { "id": "exampleId", "name": "exampleName" } ] }
, and theFieldDefinition.multiValuedCombinedPropertyRootPath
wascategories[*]
, then the propertyPaths might beid
orname
. -
searchable
boolean searchable
Whether or not the search query should be applied to this field on search. -
sortable
boolean sortable
Indicates if this field is sortable. -
sortOption
SortOption sortOption
The sort option which is driven by this field. -
sortVariantType
String sortVariantType
The field variant type which should be sorted on.If not provided, the first variant type will be used.
-
translatable
boolean translatable
Indicates if this field is translatable. -
variants
List<FieldVariant> variants
The specific typed variants for this field.
-
-
Class com.broadleafcommerce.search.api.domain.FieldQuery extends Object implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.domain.FieldVariant extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
field
FieldDefinition field
The field which this variant represents. -
includeInResponse
boolean includeInResponse
Determines whether or not this variant should be included in the search response. This must be a stored value in the search index. -
type
String type
The general type of value stored in this field.Should be a value of
FieldType
-
-
Class com.broadleafcommerce.search.api.domain.SearchRedirect extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
id
String id
The context ID of this search redirect. -
isRegex
boolean isRegex
Whether or not the queryMatch should be applied as a Regex. -
name
String name
A name to describe the purpose of this search redirect.Non-functional, only used as a description for administration.
-
queryMatch
String queryMatch
The value that a query must match to activate the redirect.If isRegex, the match will be applied as a Regex. Otherwise, an exact match is required.
-
redirectType
RedirectType redirectType
The type of redirect which should be performed. -
redirectUri
String redirectUri
The URI which the client should be redirected to if the search query matches.
-
-
Class com.broadleafcommerce.search.api.domain.SearchRedirectResponse extends Object implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.domain.SearchResponse extends org.springframework.data.domain.PageImpl<Object> implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
correctedQuery
boolean correctedQuery
If no results were found and a different query was executed than the original, this is set to true. -
facets
List<FacetResponse> facets
The facets returned in the search result. -
redirect
SearchRedirectResponse redirect
A redirect generated based on the original request query.If present, the rest of the response will be empty.
-
sorts
List<SortResponse> sorts
The sort options returned in the search result. -
spellCheckResult
SpellCheckResult spellCheckResult
Set if spellcheck returned any results. Contains the original query and any potential suggestions.
-
-
Class com.broadleafcommerce.search.api.domain.SortOption extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
displayOrder
Integer displayOrder
The display order of this sort option -
field
FieldDefinition field
The field to be sorted on -
label
String label
The label of this search option -
name
String name
Name to use to identify the sort option. Typically, this should correspond to aFieldDefinition.getAbbreviation()
.
-
-
Class com.broadleafcommerce.search.api.domain.SortResponse extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
active
boolean active
Whether or not this sort is active. -
descending
boolean descending
Whether the sort should be descending. Sort will be ascending by default.Only included for the active sort.
-
sortOption
SortOption sortOption
The Sort Option information for this sort.
-
-
Class com.broadleafcommerce.search.api.domain.SpellCheckResult extends Object implements Serializable
-
Serialized Fields
-
originalQuery
String originalQuery
The original search query. -
suggestedQueries
List<SpellCheckResult.SuggestedQuery> suggestedQueries
The suggested queries after spell correction, in order of most to least recommended. -
suggestionMap
Map<String,SpellCheckSuggestion> suggestionMap
Suggested spelling corrections of the original query to retrieve results.
-
-
-
Class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery extends Object implements Serializable
-
Class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion extends Object implements Serializable
-
Serialized Fields
-
incorrectWord
String incorrectWord
The original word in the search query that is misspelled. -
offsets
List<SpellCheckSuggestion.TermPosition> offsets
The offset positions of this string in the original query. This is a list, as it's possible for a single term to appear multiple times in a single query. -
suggestions
List<String> suggestions
The suggested terms to replace the corrected word, ordered by recommendation.
-
-
-
Class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition extends Object implements Serializable
-
Serialized Fields
-
endOffset
int endOffset
The ending index of the incorrectly spelled word in the original query. -
startOffset
int startOffset
The starting index of the incorrectly spelled word in the original query string.
-
-
-
-
Package com.broadleafcommerce.search.api.type
-
Class com.broadleafcommerce.search.api.type.DefaultFieldType extends FieldType implements Serializable
-
Class com.broadleafcommerce.search.api.type.FieldType extends Object implements Serializable
-
Serialized Fields
-
multiValued
boolean multiValued
Whether this type supports multiple values. -
type
String type
The named representation of the type.
-
-
-
Class com.broadleafcommerce.search.api.type.IndexableInitializationException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.search.api.type.IndexableType extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
behaviors
List<com.broadleafcommerce.data.tracking.core.TrackableBehavior> behaviors
The trackable behaviors which apply to objects of this indexable type. -
label
String label
The label representation of the indexable type shown for administration. -
parent
IndexableType parent
Some of these enumerated types can have a parent or common type. For example, imagine that there is a CATALOG type, which could be the parent of PRODUCT and CATEGORY. In this case, PRODUCT and CATEGORY would have a parent of CATALOG, and CATALOG would have no parent. -
translatable
boolean translatable
Whether or not objects of this indexable type are translatable. -
type
String type
The named representation of the indexable type. -
vendorBehavior
boolean vendorBehavior
Whether or not objects of this indexable type can be discriminated by vendor
-
-