Package org.apache.juneau.console.datatables

package org.apache.juneau.console.datatables

The DataTables server-side-processing JSON beans implementing the DataTables server-side processing wire contract.

This package holds only the DataTables JSON input (DataTablesRequest) and output (DataTablesResults) beans, plus the client-helper mixin. It carries no query-engine types: the beans know nothing about BeanQuery.

The bridge between the two worlds lives in the sibling package org.apache.juneau.console.datatables.adapter: DataTablesQuery maps a DataTablesRequest onto a BeanQuery, runs it against a BeanQuerySession, and populates a DataTablesResults envelope (mapping total→recordsTotal and matched→recordsFiltered).

See Also:

• DataTablesQuery
• BeanQuerySession
• DataTables Server-Side Processing

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.console	Engine-agnostic themeable admin-console chrome: Theme, the stock theme stylesheets, the bundled chrome.css asset, and ConsoleChromeMixin.
org.apache.juneau.console.datatables.adapter	The DataTables ↔ BeanQuery adapter.

Classes

Class	Description
DataTablesColumns	Generates a DataTables columns array from the bean properties of a row type, so the browser-side column list doesn't have to be hand-duplicated.
DataTablesMixin	Mixin that serves Juneau's first-party DataTables glue script at /juneau-datatables.js.
DataTablesRequest	The DataTables server-side-processing request envelope — the JSON input bean paired with the DataTablesResults JSON output bean.
DataTablesRequest.Column	A DataTables column descriptor (columns[i]).
DataTablesRequest.Fixed	A DataTables 2.x fixed search term (search.fixed[i]): a named search applied through the DataTables API (search.fixed(name, term)) rather than typed by the user.
DataTablesRequest.Order	A DataTables ordering descriptor (order[i]): the index of the ordered column plus its direction.
DataTablesRequest.Search	A DataTables search descriptor ({value, regex, fixed}), used for both the global search and a column search.
DataTablesResults<T>	The DataTables server-side-processing response envelope.
DataTablesTable	Builds a DataTables-ready HTML Table DOM bean from a collection of rows — a server-rendered "plain table" that the browser upgrades in place with $('#id').DataTable().