Index (in.co.akshitbansal:spring-web-query-core 0.1.1 API)

A B C E F G I L N O P Q R S T V W
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.
AnnotationUtil - Class in in.co.akshitbansal.springwebquery.util: Utility methods for resolving query-related annotations from controller metadata and validating FieldMapping declarations.
AnnotationUtil() - Constructor for class in.co.akshitbansal.springwebquery.util.AnnotationUtil

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.

E

entityClass() - Element in annotation interface in.co.akshitbansal.springwebquery.annotation.WebQuery: Entity class against which filter and sort fields are resolved.
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.
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

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.
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.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=).

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.RestrictedPageableArgumentResolver: Resolves the given Pageable argument 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 Field for the given dot-separated field path, starting from the supplied root type and traversing the type hierarchy and container types as needed.
resolveWebQueryFromParameter(MethodParameter) - Static 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.
RestrictedPageableArgumentResolver - Class in in.co.akshitbansal.springwebquery: A custom HandlerMethodArgumentResolver that wraps a standard PageableHandlerMethodArgumentResolver to enforce restrictions on pageable sorting fields based on entity metadata.
RestrictedPageableArgumentResolver() - Constructor for class in.co.akshitbansal.springwebquery.RestrictedPageableArgumentResolver
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 an entity 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.
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.
RsqlSpecificationArgumentResolver - Class in in.co.akshitbansal.springwebquery: Spring MVC HandlerMethodArgumentResolver that resolves controller method parameters annotated with RsqlSpec into Spring Data JPA Specifications.
RsqlSpecificationArgumentResolver(Set<RsqlOperator>, Set<? extends RsqlCustomOperator<?>>) - Constructor for class in.co.akshitbansal.springwebquery.RsqlSpecificationArgumentResolver: Creates a new RsqlSpecificationArgumentResolver with the specified operators.

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.

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[]) - Static method in class in.co.akshitbansal.springwebquery.util.AnnotationUtil: Validates FieldMapping definitions declared in WebQuery.
ValidationRSQLVisitor - Class in in.co.akshitbansal.springwebquery: RSQL AST visitor that validates RSQL queries against a given entity class.
ValidationRSQLVisitor(Class<?>, FieldMapping[], Set<? extends RsqlCustomOperator<?>>) - Constructor for class in.co.akshitbansal.springwebquery.ValidationRSQLVisitor: Creates a new ValidationRSQLVisitor with the specified configuration.
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.ValidationRSQLVisitor: Visits an AndNode in the RSQL AST and recursively validates all child nodes.
visit(ComparisonNode, Void) - Method in class in.co.akshitbansal.springwebquery.ValidationRSQLVisitor: 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.ValidationRSQLVisitor: 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 E F G I L N O P Q R S T V W
All Classes and Interfaces|All Packages|Serialized Form