Index
All Classes and Interfaces|All Packages|Serialized Form
A
- allowOriginalFieldName() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.FieldMapping
-
Whether to allow the use of the original field name in addition to the alias.
B
- BETWEEN - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
E
- entityClass() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RestrictedPageable
-
Entity class whose fields define the set of properties that may be used for sorting.
- entityClass() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RsqlSpec
-
The entity class for which the Specification should be built.
- EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
F
- field() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.FieldMapping
-
The actual field name or path on the entity.
- FieldMapping - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
-
Defines a mapping between a query parameter field name and an actual entity field name.
- fieldMappings() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RsqlSpec
G
- GREATER_THAN - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- GREATER_THAN_OR_EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
I
- IGNORE_CASE - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- IGNORE_CASE_LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- IGNORE_CASE_NOT_LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- IN - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- in.co.akshitbansal.springwebquery - package in.co.akshitbansal.springwebquery
- in.co.akshitbansal.springwebquery.annotation - package in.co.akshitbansal.springwebquery.annotation
- in.co.akshitbansal.springwebquery.enums - package in.co.akshitbansal.springwebquery.enums
- in.co.akshitbansal.springwebquery.exception - package in.co.akshitbansal.springwebquery.exception
- in.co.akshitbansal.springwebquery.util - package in.co.akshitbansal.springwebquery.util
- IS_NULL - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
L
- LESS_THAN - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- LESS_THAN_OR_EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
N
- name() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.FieldMapping
-
The alias name to use in RSQL query strings.
- NOT_BETWEEN - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- NOT_EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- NOT_IN - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- NOT_LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
- NOT_NULL - Enum constant in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
O
- operators() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RsqlFilterable
-
The set of RSQL operators that are allowed for filtering this field.
P
- paramName() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RsqlSpec
-
The name of the query parameter that contains the RSQL string.
Q
- QueryException - Exception Class in in.co.akshitbansal.springwebquery.exception
-
Exception thrown when an RSQL query or pagination request violates configured field or operator restrictions.
- QueryException(String) - Constructor for exception class in.co.akshitbansal.springwebquery.exception.QueryException
-
Constructs a new query exception with the specified detail message.
- QueryException(String, Throwable) - Constructor for exception class in.co.akshitbansal.springwebquery.exception.QueryException
-
Constructs a new query exception with the specified detail message and cause.
R
- ReflectionUtil - Class in in.co.akshitbansal.springwebquery.util
- ReflectionUtil() - Constructor for class in.co.akshitbansal.springwebquery.util.ReflectionUtil
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class in.co.akshitbansal.springwebquery.RestrictedPageableArgumentResolver
-
Resolves the given
Pageableargument from the web request. - resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class in.co.akshitbansal.springwebquery.RsqlSpecificationArgumentResolver
-
Resolves the controller method argument into a
Specification. - resolveField(Class<?>, String) - Static method in class in.co.akshitbansal.springwebquery.util.ReflectionUtil
-
Resolves a
Fieldfor the given dot-separated field path, starting from the supplied root type and traversing the type hierarchy and container types as needed. - RestrictedPageable - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
-
Marks a
Pageablecontroller method parameter as subject to field-level sorting restrictions. - RestrictedPageableArgumentResolver - Class in in.co.akshitbansal.springwebquery
-
A custom
HandlerMethodArgumentResolverthat wraps a standardPageableHandlerMethodArgumentResolverto enforce restrictions on pageable sorting fields based on entity metadata. - RestrictedPageableArgumentResolver() - Constructor for class in.co.akshitbansal.springwebquery.RestrictedPageableArgumentResolver
- RsqlFilterable - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
-
Marks an entity field as filterable via RSQL (RESTful Service Query Language) queries.
- RsqlOperator - Enum Class in in.co.akshitbansal.springwebquery.enums
-
Enumeration of supported RSQL comparison operators.
- RsqlSpec - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
-
Marks a controller method parameter to be automatically resolved as a
Specificationfrom an RSQL query string. - RsqlSpecificationArgumentResolver - Class in in.co.akshitbansal.springwebquery
-
Spring MVC
HandlerMethodArgumentResolverthat resolves controller method parameters annotated withRsqlSpecinto Spring Data JPASpecifications. - RsqlSpecificationArgumentResolver() - Constructor for class in.co.akshitbansal.springwebquery.RsqlSpecificationArgumentResolver
S
- Sortable - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
-
Marks an entity field as eligible for sorting in API query requests.
- supportsParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.RestrictedPageableArgumentResolver
-
Determines whether the given method parameter is supported by this resolver.
- supportsParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.RsqlSpecificationArgumentResolver
-
Determines whether this resolver supports the given method parameter.
V
- ValidationRSQLVisitor - Class in in.co.akshitbansal.springwebquery
-
RSQL AST visitor that validates RSQL queries against a given entity class.
- ValidationRSQLVisitor(Class<?>, FieldMapping[]) - Constructor for class in.co.akshitbansal.springwebquery.ValidationRSQLVisitor
- valueOf(String) - Static method in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class in.co.akshitbansal.springwebquery.enums.RsqlOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visit(AndNode, Void) - Method in class in.co.akshitbansal.springwebquery.ValidationRSQLVisitor
-
Visits an
AndNodein the RSQL AST and recursively validates all child nodes. - visit(ComparisonNode, Void) - Method in class in.co.akshitbansal.springwebquery.ValidationRSQLVisitor
-
Visits a
ComparisonNodein the RSQL AST and validates the field and operator against the entity class. - visit(OrNode, Void) - Method in class in.co.akshitbansal.springwebquery.ValidationRSQLVisitor
-
Visits an
OrNodein the RSQL AST and recursively validates all child nodes.
All Classes and Interfaces|All Packages|Serialized Form