Index

A B C D E F G I L M N O P Q R S T V W 
All Classes and Interfaces|All Packages|Serialized Form

A

absolute() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.MapsTo
Whether this mapping starts a new absolute path from the entity root.
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.
annotationUtil - Variable in class in.co.akshitbansal.springwebquery.resolver.RsqlSpecArgumentResolver
Utility for annotation resolution and validation support in subclasses.
AnnotationUtil - Class in in.co.akshitbansal.springwebquery.util
Utility methods for resolving query-related annotations from controller metadata and validating FieldMapping declarations.
AnnotationUtil(Set<? extends RsqlCustomOperator<?>>) - Constructor for class in.co.akshitbansal.springwebquery.util.AnnotationUtil
Creates an annotation utility backed by registered custom operator instances.

B

BETWEEN - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Range operator (=between= or =bt=).

C

customOperators() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RsqlFilterable
The set of custom RSQL operators that are allowed for filtering this field.
customPredicates - Variable in class in.co.akshitbansal.springwebquery.resolver.RsqlSpecArgumentResolver
Custom predicates adapted for rsql-jpa specification conversion.

D

DtoAwareRestrictedPageableArgumentResolver - Class in in.co.akshitbansal.springwebquery.resolver
DTO-based resolver for Pageable parameters annotated with RestrictedPageable.
DtoAwareRestrictedPageableArgumentResolver() - Constructor for class in.co.akshitbansal.springwebquery.resolver.DtoAwareRestrictedPageableArgumentResolver
 
DtoAwareRsqlSpecArgumentResolver - Class in in.co.akshitbansal.springwebquery.resolver
DTO-based resolver for Specification parameters annotated with RsqlSpec.
DtoAwareRsqlSpecArgumentResolver(Set<RsqlOperator>, Set<? extends RsqlCustomOperator<?>>, AnnotationUtil) - Constructor for class in.co.akshitbansal.springwebquery.resolver.DtoAwareRsqlSpecArgumentResolver
Creates a DTO-aware RSQL specification resolver.
dtoClass() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.WebQuery
Optional DTO class used as the API-facing query contract.
DtoValidationRSQLVisitor - Class in in.co.akshitbansal.springwebquery
RSQL AST visitor that validates filters against a DTO contract and maps DTO property paths to entity property paths.
DtoValidationRSQLVisitor(Class<?>, Class<?>, AnnotationUtil) - Constructor for class in.co.akshitbansal.springwebquery.DtoValidationRSQLVisitor
Creates a DTO-aware validation visitor.

E

EntityAwareRestrictedPageableArgumentResolver - Class in in.co.akshitbansal.springwebquery.resolver
Entity-based resolver for Pageable parameters annotated with RestrictedPageable.
EntityAwareRestrictedPageableArgumentResolver() - Constructor for class in.co.akshitbansal.springwebquery.resolver.EntityAwareRestrictedPageableArgumentResolver
 
EntityAwareRsqlSpecArgumentResolver - Class in in.co.akshitbansal.springwebquery.resolver
Entity-based resolver for Specification parameters annotated with RsqlSpec.
EntityAwareRsqlSpecArgumentResolver(Set<RsqlOperator>, Set<? extends RsqlCustomOperator<?>>, AnnotationUtil) - Constructor for class in.co.akshitbansal.springwebquery.resolver.EntityAwareRsqlSpecArgumentResolver
Creates an entity-aware RSQL specification resolver.
entityClass() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.WebQuery
Entity class against which filter and sort fields are resolved.
EntityValidationRSQLVisitor - Class in in.co.akshitbansal.springwebquery
RSQL AST visitor that validates RSQL queries against a given entity class.
EntityValidationRSQLVisitor(Class<?>, FieldMapping[], AnnotationUtil) - Constructor for class in.co.akshitbansal.springwebquery.EntityValidationRSQLVisitor
Creates a new entity validation visitor with the specified configuration.
EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Strict equality operator (==).

F

field() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.FieldMapping
The actual field name or path on the entity.
field() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.MapsTo
Entity-side field or path segment to use for this DTO field.
FieldMapping - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Defines a mapping between an API-facing field name and an actual entity field name.
fieldMappings() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.WebQuery
Optional field mappings used to expose API-facing aliases for entity fields.

G

getAllowedOperators(RsqlFilterable) - Method in class in.co.akshitbansal.springwebquery.util.AnnotationUtil
Computes the full set of operators allowed for a field by combining built-in operators and registered custom operators referenced by RsqlFilterable.
getComparisonOperator() - Method in interface in.co.akshitbansal.springwebquery.operator.RsqlCustomOperator
Returns the RSQL ComparisonOperator for this custom operator.
getCustomOperators() - Method in interface in.co.akshitbansal.springwebquery.RsqlCustomOperatorsConfigurer
Returns a set of custom RSQL operators to be registered.
getFieldMappings() - Method in class in.co.akshitbansal.springwebquery.DtoValidationRSQLVisitor
Returns immutable selector mappings generated while visiting nodes.
getType() - Method in interface in.co.akshitbansal.springwebquery.operator.RsqlCustomOperator
Returns the Java type of the operand that this operator handles.
GREATER_THAN - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Greater than operator (> or =gt=).
GREATER_THAN_OR_EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Greater than or equal to operator (>= or =ge=).

I

IGNORE_CASE - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Case-insensitive equality operator (=icase= or =ic=).
IGNORE_CASE_LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Case-insensitive like operator (=ilike= or =ik=).
IGNORE_CASE_NOT_LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Case-insensitive not like operator (=inotlike= or =ni=).
IN - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Set membership operator (=in=).
in.co.akshitbansal.springwebquery - package in.co.akshitbansal.springwebquery
 
in.co.akshitbansal.springwebquery.annotation - package in.co.akshitbansal.springwebquery.annotation
 
in.co.akshitbansal.springwebquery.exception - package in.co.akshitbansal.springwebquery.exception
 
in.co.akshitbansal.springwebquery.operator - package in.co.akshitbansal.springwebquery.operator
 
in.co.akshitbansal.springwebquery.resolver - package in.co.akshitbansal.springwebquery.resolver
 
in.co.akshitbansal.springwebquery.util - package in.co.akshitbansal.springwebquery.util
 
IS_NULL - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Null check operator (=null=, =isnull=, or =na=).

L

LESS_THAN - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Less than operator (< or =lt=).
LESS_THAN_OR_EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Less than or equal to operator (<= or =le=).
LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Like operator (=like= or =ke=).

M

MapsTo - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Declares the entity-side property segment that a DTO field maps to for filtering and sorting path translation.

N

name() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.FieldMapping
The alias name to use in API query strings.
NOT_BETWEEN - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Not between operator (=notbetween= or =nb=).
NOT_EQUAL - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Inequality operator (!=).
NOT_IN - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Set non-membership operator (=out=).
NOT_LIKE - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Not like operator (=notlike= or =nk=).
NOT_NULL - Enum constant in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Non-null check operator (=notnull=, =isnotnull=, or =nn=).

O

operators() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.RsqlFilterable
The set of default 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

QueryConfigurationException - Exception Class in in.co.akshitbansal.springwebquery.exception
Exception thrown when the library is misconfigured by the developer.
QueryConfigurationException(String) - Constructor for exception class in.co.akshitbansal.springwebquery.exception.QueryConfigurationException
Constructs a new query configuration exception with the specified detail message.
QueryConfigurationException(String, Throwable) - Constructor for exception class in.co.akshitbansal.springwebquery.exception.QueryConfigurationException
Constructs a new query configuration exception with the specified detail message and cause.
QueryException - Exception Class in in.co.akshitbansal.springwebquery.exception
Base exception thrown for all RSQL query or pagination related errors.
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.
QueryValidationException - Exception Class in in.co.akshitbansal.springwebquery.exception
Exception thrown when an API consumer provides an invalid RSQL query, sorting request, or filter parameters.
QueryValidationException(String) - Constructor for exception class in.co.akshitbansal.springwebquery.exception.QueryValidationException
Constructs a new query validation exception with the specified detail message.
QueryValidationException(String, Throwable) - Constructor for exception class in.co.akshitbansal.springwebquery.exception.QueryValidationException
Constructs a new query validation exception with the specified detail message and cause.

R

ReflectionUtil - Class in in.co.akshitbansal.springwebquery.util
Utility class for performing reflection-based operations on entity classes.
ReflectionUtil() - Constructor for class in.co.akshitbansal.springwebquery.util.ReflectionUtil
 
resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class in.co.akshitbansal.springwebquery.resolver.DtoAwareRsqlSpecArgumentResolver
Resolves a Specification from the configured RSQL request parameter.
resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class in.co.akshitbansal.springwebquery.resolver.EntityAwareRsqlSpecArgumentResolver
Resolves a Specification from the configured RSQL request parameter.
resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class in.co.akshitbansal.springwebquery.resolver.DtoAwareRestrictedPageableArgumentResolver
Resolves and validates a Pageable argument with DTO-based sorting rules.
resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class in.co.akshitbansal.springwebquery.resolver.EntityAwareRestrictedPageableArgumentResolver
Resolves and validates a Pageable argument with restricted sorting.
resolveField(Class<?>, String) - Static method in class in.co.akshitbansal.springwebquery.util.ReflectionUtil
Resolves a Field for the given dot-separated field path, starting from the supplied root type and traversing the type hierarchy and container types as needed.
resolveFieldPath(Class<?>, String) - Static method in class in.co.akshitbansal.springwebquery.util.ReflectionUtil
Resolves all fields in a dot-separated path, preserving traversal order.
resolveWebQueryFromParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.util.AnnotationUtil
Resolves WebQuery from the controller method that declares the provided Spring MVC method parameter.
RestrictedPageable - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Marks a Pageable controller method parameter as subject to field-level sorting restrictions.
RsqlCustomOperator<T> - Interface in in.co.akshitbansal.springwebquery.operator
Interface for defining custom RSQL operators.
RsqlCustomOperatorsConfigurer - Interface in in.co.akshitbansal.springwebquery
Configurer interface for providing custom RSQL operators.
RsqlFilterable - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Marks a field as filterable via RSQL (RESTful Service Query Language) queries.
RsqlOperator - Enum Class in in.co.akshitbansal.springwebquery.operator
Enumeration of supported RSQL comparison operators.
rsqlParser - Variable in class in.co.akshitbansal.springwebquery.resolver.RsqlSpecArgumentResolver
Parser configured with the allowed default and custom comparison operators.
RsqlSpec - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Marks a controller method parameter to be automatically resolved as a Specification from an RSQL query string.
RsqlSpecArgumentResolver - Class in in.co.akshitbansal.springwebquery.resolver
Base HandlerMethodArgumentResolver for resolving RSQL-based Specification parameters.
RsqlSpecArgumentResolver(Set<RsqlOperator>, Set<? extends RsqlCustomOperator<?>>, AnnotationUtil) - Constructor for class in.co.akshitbansal.springwebquery.resolver.RsqlSpecArgumentResolver
Creates the resolver base with parser and predicate configuration.

S

Sortable - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Marks a field as eligible for sorting in API query requests.
supportsParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.resolver.DtoAwareRestrictedPageableArgumentResolver
Determines whether this resolver should handle the given parameter.
supportsParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.resolver.DtoAwareRsqlSpecArgumentResolver
Determines whether this resolver should handle the given parameter.
supportsParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.resolver.EntityAwareRestrictedPageableArgumentResolver
Determines whether this resolver should handle the given parameter.
supportsParameter(MethodParameter) - Method in class in.co.akshitbansal.springwebquery.resolver.EntityAwareRsqlSpecArgumentResolver
Determines whether this resolver should handle the given parameter.

T

toPredicate(RSQLCustomPredicateInput) - Method in interface in.co.akshitbansal.springwebquery.operator.RsqlCustomOperator
Converts the RSQL operator and its input into a JPA Predicate.

V

validateFieldMappings(FieldMapping[]) - Method in class in.co.akshitbansal.springwebquery.util.AnnotationUtil
Validates FieldMapping definitions declared in WebQuery.
valueOf(String) - Static method in enum class in.co.akshitbansal.springwebquery.operator.RsqlOperator
Returns the enum constant of this class with the specified name.
values() - Static method in enum class in.co.akshitbansal.springwebquery.operator.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.DtoValidationRSQLVisitor
Visits a logical AND node and validates each child expression.
visit(AndNode, Void) - Method in class in.co.akshitbansal.springwebquery.EntityValidationRSQLVisitor
Visits an AndNode in the RSQL AST and recursively validates all child nodes.
visit(ComparisonNode, Void) - Method in class in.co.akshitbansal.springwebquery.DtoValidationRSQLVisitor
Visits a comparison node and validates selector/operator compatibility.
visit(ComparisonNode, Void) - Method in class in.co.akshitbansal.springwebquery.EntityValidationRSQLVisitor
Visits a ComparisonNode in the RSQL AST and validates the field and operator against the entity class.
visit(OrNode, Void) - Method in class in.co.akshitbansal.springwebquery.DtoValidationRSQLVisitor
Visits a logical OR node and validates each child expression.
visit(OrNode, Void) - Method in class in.co.akshitbansal.springwebquery.EntityValidationRSQLVisitor
Visits an OrNode in the RSQL AST and recursively validates all child nodes.

W

WebQuery - Annotation Interface in in.co.akshitbansal.springwebquery.annotation
Declares shared web-query metadata for a controller method.
A B C D E F G I L M N O P Q R S T V W 
All Classes and Interfaces|All Packages|Serialized Form