org.apache.juneau.rest.converters

Class Queryable

java.lang.Object

org.apache.juneau.rest.converters.Queryable

All Implemented Interfaces:

RestConverter

public final class Queryable
extends Object
implements RestConverter

Converter for enabling of PojoQuery support on response objects returned by a @RestMethod method.

When enabled, objects in a POJO tree can be filtered using the functionality described in the PojoQuery class.

The following HTTP request parameters are available for tabular data (e.g. Collections of Maps, arrays of beans, etc...):

• &s= Search arguments.
  Comma-delimited list of key/value pairs representing column names and search tokens.
  Example:

  &s=name=Bill*,birthDate>2000

• &v= Visible columns.
  Comma-delimited list of column names to display.
  Example:

  &v=name,birthDate

• &o= Sort commands.
  Comma-delimited list of columns to sort by.
  Column names can be suffixed with '+' or '-' to indicate ascending or descending order.
  The default is ascending order.
  Example:

  &o=name,birthDate-

• &i= Case-insensitive parameter.
  Boolean flag for case-insensitive matching on the search parameters.
• &p= - Position parameter.
  Only return rows starting at the specified index position (zero-indexed).
  Default is 0.
• &l= Limit parameter.
  Only return the specified number of rows.
  Default is 0 (meaning return all rows).

• PojoQuery - Additional information on filtering POJO models.
• RestContext.REST_converters - Registering converters with REST resources.
• Overview > juneau-rest-server > Converters

Field Summary

Fields

Modifier and Type	Field and Description
static String	SWAGGER_PARAMS Swagger parameters for this converter.

Constructor Summary

Constructors

Constructor and Description
Queryable()

Method Summary

Modifier and Type	Method and Description
Object	convert(RestRequest req, Object o) Performs post-call conversion on the specified response object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SWAGGER_PARAMS

public static final String SWAGGER_PARAMS

Swagger parameters for this converter.

See Also:

Constant Field Values

Constructor Detail

Queryable

public Queryable()

Method Detail

convert

public Object convert(RestRequest req,
                      Object o)

Description copied from interface: RestConverter

Performs post-call conversion on the specified response object.

Specified by:

convert in interface RestConverter

Parameters:

req - The servlet request.

o - The response object set by the REST method through the RestResponse.setOutput(Object) method.

Returns:

The converted object.