All Classes and Interfaces
Class
Description
Properties specific to ocs.
Properties are configured in the application.yml file.
Converts alphabetic, numeric, and symbolic Unicode characters which are not
in the first 127 ASCII characters (the "Basic Latin" Unicode block) into
their ASCII equivalents, if one exists for every searchable field.
Analyzer that combines the Querqy results for the original and the ASCIIfied query.
A term that is associated with other terms (e.g.
Converts attributes to a standard data field.
The boost_mode specified, how the score is combined with the score of the
query.
Takes a list of
/ separated category paths and splits them into
separate levels.
Filters everything that is not in the configured character point range.
Common keys for the payload attached to
SuggestRecords.A concept that consists of several tokens that have a specific meaning in their context.
super-interface for all extension interfaces that optionally can accepts
custom settings.
Factory that exposes the flexibility of Elasticsearch query-string-query to
OCS using a configuration.
Limiter where you can configure, which group of suggestions should get which
share in the result (e.g.
A internal exception because of invalid configuration.
Abstract class which handles reading and initializing
DocumentPreProcessor
implementations which need further configuration.ConfigureableDataprocessor implementations manipulate, extract,
enrich, ...
Simplest implementation, that just cut's off the given list with the
specified limit.
Base class which holds common data structure of either simple first level
items or for master and variant items.
Configuration wrapper for which Document-Pre/Post-Processors to be used and
custom settings for them.
A predefined broad query that tries to get good results without loosing too
much precision.
A simple 'data record' similar to a row inside a CSV file that contains any
data relevant for search.
Processor that is called after the document was transformed into a
IndexableItem, just right before it will be indexed.DocumentPreProcessor implementations can be used to alter product
data before they get transformed into
IndexableItems.A product set defined by dynamic search query text, filters and optional
sorting order.
A reusable query factory that receives the analyzed user query to build
Elasticsearch queries (one for Master level and one for the variant level).
utility for Searcher class to extract the creation of ESQueryBuilders based
on the given configuration
A query that consists of an analyzed query extended by filters (and maybe more in the future).
Extracts the category levels of a single category path field into separate
level and a leaf field if the *lvl and *leaf fields exists in the field
configuration.
A interface that is implemented by OCS, to give quick and easy access to the
configured fields.
Special class that cares about resolving the correct field configuration,
especially for "the category field" and dynamic fields.
Enum describing the usage of an field that will be indexed.
Enum describing the usage of an field that will be indexed.
The basis for a interval facet creator that should extract facets with fixed intervals.
A restricted range to numeric values only.
ConfigureableField implementations that holds all information needed
by the FlagFieldDataProcessor.ConfigureableDataprocessor implementation which fills a flag field
based on a pattern match in a source field.Run a full import into a new index.
This limiter groups the result by the specified payload entry and limits each
group to the specified size.
Hero products that should be displayed at the top of the result, come with
several uncomfortable requirements.
DataItem that can be used to be indexed directly.Creates a
ObjectMapper for IndexableItem.Represents a field configuration that is reversely fetched from the
search-index rather than from the configuration.
Provider for index specific settings.
Facet entry that describes a numerical interval.
A Limiter is used for results that have different kind of suggestions, for
example if several different data sources are used at different suggesters,
as it's done at the
CompoundQuerySuggester.Interface for internal utility function exposed to the provided plugins.
Non-turbo filter checks whether the marker in the event matches the marker
specified by user.
Merges all the data it gets from all specified data providers.
A set that only returns the min and the max value (based on natural ordering)
of all added values.
A service that provides mappings of modified (relaxed or sharpened) queries.
A term that consists of several terms that belong together.
A query that consists of several different analyzed queries.
Builds a multi-match-query
that uses the ngram sub-fields to handle decomposition and fuzziness.
Splits the string by every character that is not a letter, number, dash or underscore (which are considered as
word-bind characters)
Special QueryFactory used for arranged searches that do not want to have a main-result included.
Offers the possibility to run a
Runnable function, once in a
defined time frame.ConfigureableField implementations that holds all information needed
by the RemoveValuesDataProcessor.ConfigureableField implementations that holds all information needed
by the ReplacePatternInValuesDataProcessor.
Query factory that analyzes the search keywords and already checks
Elasticsearch about which terms hit documents together (including spell
correction and term shingles).
Main product containing the data that is common for all variants.
Configuration that describes how a single query is constructed and under
which conditions it is used.
Describes the condition under that the particular query is constructed.
A product set defined by a simple query string query, fields with corresponding weights, optional filters and
sorting order.
A single term for a query-string-query
The
QuerySuggestManager cares about the creation of
QuerySuggester objects and
also makes sure they are coupled to an internal asynchronous update process
which is scheduled according a configurable update rate.This builder should be used to set up the QuerySuggestManager
Creates a facet with a single
IntervalFacetEntry that contains the
global min and max value.Facet entry that describes a numerical interval.
Use carefully - don't use for userinput directly.
Query factory uses the QueryPredictor to determine, which terms work together.
DocumentPreProcessor implementation which
removes values from a fields value based on a regular expression.ConfigureableDataprocessor implementation which replaces all
occurrences of a regular expression within a fields value.The score_mode specifies how the computed scores are combined
Configuration that influences how the result hits are scored.
Specific configuration for each scoring rule.
A holder for different ways of boosting document matches.
Final search-configuration that contains all the fetched configuration
objects.
SPI Interface to provide search configurations.
Holder for several tenant specific objects.
Utility class to parse search parameters
SearchQuery model that contains all "explicit" parameters for a search
requests, so not the filters.
All parts that build together the final search query.
ConfigureableDataprocessor implementation which will make the indexer
skip the indexation of matching documents.Optional configuration that overwrites the default way to present and handle
sortings.
ConfigureableField implementations that holds all information needed
by the SplitValueDataProcessor.DocumentPreProcessor implementation which
splits a field value on a regular expression and adds the splitted values
into new fields.If suggestions are grouped by a certain value of their payload (e.g.
A configuration wrapper around all required settings.
used for exact filtering of one or more values.
A carrier of search queries on master and variant level.
Can be used to modify the user query prior it is processed by the
UserQueryAnalyzer, for example to normalize the query.
A variant-picking-strategy defines how variants are chosen to be result-hits
instead of their main product.
A term that accepts a weight and a optional fuzzy operator.
Summarize and normalize fields depending on configuration