Package com.broadleafcommerce.search.provider.solr.rsql

Interface SolrRSQLFilterBuilder

All Known Implementing Classes:

DefaultSolrRSQLFilterBuilder

public interface SolrRSQLFilterBuilder

Method Summary

Modifier and Type	Method	Description
String	createFilter(cz.jirutka.rsql.parser.ast.ComparisonNode comparisonNode, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields, String locale)	Create a filter query based on a comparison Node and root domain fields.
String	createFilter(cz.jirutka.rsql.parser.ast.LogicalNode logicalNode, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields, String locale)	Create a filter query based on a logical Node and root domain fields.
String	createFilter(cz.jirutka.rsql.parser.ast.Node node, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields, String locale)	Create a filter query based on a generic Node and root domain fields.
String	createFilter(String selector, cz.jirutka.rsql.parser.ast.ComparisonOperator operator, List<String> arguments, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields, String locale)	Create a filter query based on a set of comparison parameters and a root domain fields.

Method Detail

createFilter

String createFilter(cz.jirutka.rsql.parser.ast.Node node,
                    List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields,
                    String locale)

Create a filter query based on a generic Node and root domain fields.

Parameters:

node - A generic node structure in a structured RSQL query

fields - The fields for the root domain

locale - (optional) the locale of the query

Returns:

The query criteria

createFilter

String createFilter(cz.jirutka.rsql.parser.ast.LogicalNode logicalNode,
                    List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields,
                    String locale)

Create a filter query based on a logical Node and root domain fields. Logical nodes are 'and'/'or' combinations of comparison nodes.

Parameters:

logicalNode - A logical node structure in a structured RSQL query

fields - The fields for the root domain

locale - (optional) the locale of the query

Returns:

The query criteria

createFilter

String createFilter(cz.jirutka.rsql.parser.ast.ComparisonNode comparisonNode,
                    List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields,
                    String locale)

Create a filter query based on a comparison Node and root domain fields. Comparison nodes filter values on a specific field.

Parameters:

comparisonNode - A comparison node structure in a structured RSQL query

fields - The fields for the root domain

locale - (optional) the locale of the query

Returns:

The query criteria

createFilter

String createFilter(String selector,
                    cz.jirutka.rsql.parser.ast.ComparisonOperator operator,
                    List<String> arguments,
                    List<com.broadleafcommerce.search.api.domain.FieldDefinition> fields,
                    String locale)

Create a filter query based on a set of comparison parameters and a root domain fields.

Parameters:

selector - The field

operator - The type of comparison (=,!=,lt,etc...)

arguments - One or more values to check against the field

fields - The fields for the root domain

locale - (optional) the locale of the query

Returns:

The query criteria