type of arguments this Operator can generate queries from
Determines the arity of the operator, that is the number of arguments/operands it takes.
The operator symbol that is used to generate the query.
Reserved characters for Elasticsearch queries. These characters can be escaped with a \ character.
Represents the placeholder "block" in operator display names.
Reserved characters for Elasticsearch queries. These characters cannot be escaped and must be removed from queries.
the arity of the operator.
Checks whether the provided array contains at leas as many arguments, as is the operators number of operands. Throws an error if not enough arguments is provided.
an array of potential operands
Simple implementation of query generation. Will not be suitable for all Operator derivatives.
Escapes the first argument from the args array, calls the [query()]{@link Operator#query} function for each keyword and combines
the results with an OR operator.
query that wos constructed with the given arguments and keywords. Returns an empty query if no arguments are provided.
The name template is used when generating search GUI, and so the arity of the operator should match the number of INPUT_PLACEHOLDER constant occurrences in the returned array.
an array of translation paths that represent the operator name, as it should be displayed to the user. The INPUT_PLACEHOLDER constant (or any falsy value) can be used to place visual input placeholder blocks in the operator name where user input is expected.
the operator class in a serializable form
Escapes all escapable Elasticsearch symbols. Removes all unescapable Elasticsearch symbols.
For a list of symbols see Elasticsearch's Query string query doc.
user input that should have special characters escaped
user input with the escapable characters escaped and the unescapable characters removed
Applies the provided function to all keywords and combines the resulting queries with an OR operator.
keywords that the function is call on
function that generates a Query object for each keyword
Creates a Query string query string literal with the provided arguments.
Elasticsearch index keyword for the field you want to query
The value that you want to query the property for
The operator you want to use to query the indexed field. Consult the Elasticsearch's documentation for more information.
combines the input strings by this pattern: ([elasticKeyword]:[operator][arg])
If the value contains a space character, or if force is set to true.
user input that should be wrapped with double quotes
if set to true the value will be wrapped regardless of it's content
Generated using TypeDoc
Represents the low level abstraction of query generation that is responsible for the creation of queries themselves.
Operators are ment to be stateless and held as singleton instances, as they can be shared without any issues. This library uses the OperatorService to store the singleton instances, but you can use your own solution, or instantiate them multiple times if you prefer.