Module org.jooq

Package org.jooq

Interface Formatter

public interface Formatter

A set of Field formatting expressions that allow for formatting a Field when embedding it in SQLDataType.JSON, SQLDataType.JSONB, or SQLDataType.XML.

Implementations should ensure:

• That FormatterContext.multiset() vs non-multiset specific behaviour is distinguished, if necessary
• That NULL behaviour is maintained.

Comparison to other API types

Unlike Formattable, which talks about formatting data to JSON, XML, and other text types in the client using Java, the Formatter takes care of doing this directly in SQL.

Unlike Converter, the formatting affects how the RDBMS embeds the value into a JSON or XML datastructure before sending the data to the client. A Converter is applied only after fetching data from JDBC.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
void	formatJSON(FormatterContext ctx)	Format the FormatterContext.field() expression to embed it in a SQLDataType.JSON context.
void	formatJSONB(FormatterContext ctx)	Format the FormatterContext.field() expression to embed it in a SQLDataType.JSONB context.
void	formatXML(FormatterContext ctx)	Format the FormatterContext.field() expression to embed it in a SQLDataType.XML context.

Method Details

formatJSON

void formatJSON(FormatterContext ctx)

Format the FormatterContext.field() expression to embed it in a SQLDataType.JSON context.

If applicable, a Binding should place the resulting expression in the FormatterContext.field(Field) out parameter. If the out parameter is left untouched, then no JSON specific formatting is applied to the FormatterContext.field() expression.

The FormatterContext.multiset() flag indicates that the JSON context is from a NestedCollectionEmulation.JSON emulation for a DSL.multiset(TableLike) expression.

formatJSONB

void formatJSONB(FormatterContext ctx)

Format the FormatterContext.field() expression to embed it in a SQLDataType.JSONB context.

If applicable, a Binding should place the resulting expression in the FormatterContext.field(Field) out parameter. If the out parameter is left untouched, then no JSONB specific formatting is applied to the FormatterContext.field() expression.

The FormatterContext.multiset() flag indicates that the JSONB context is from a NestedCollectionEmulation.JSONB emulation for a DSL.multiset(TableLike) expression.

formatXML

void formatXML(FormatterContext ctx)

Format the FormatterContext.field() expression to embed it in a SQLDataType.XML context.

If applicable, a Binding should place the resulting expression in the FormatterContext.field(Field) out parameter. If the out parameter is left untouched, then no XML specific formatting is applied to the FormatterContext.field() expression.

The FormatterContext.multiset() flag indicates that the XML context is from a NestedCollectionEmulation.XML emulation for a DSL.multiset(TableLike) expression.