Module org.jooq

Package org.jooq

Interface Formattable

All Known Subinterfaces:

Cursor<R>, EmbeddableRecord<R>, QualifiedRecord<R>, Record, Record1<T1>, Record10<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, Record11<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, Record12<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, Record13<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, Record14<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, Record15<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, Record16<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>, Record17<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17>, Record18<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18>, Record19<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19>, Record2<T1,T2>, Record20<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20>, Record21<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21>, Record22<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22>, Record3<T1,T2,T3>, Record4<T1,T2,T3,T4>, Record5<T1,T2,T3,T4,T5>, Record6<T1,T2,T3,T4,T5,T6>, Record7<T1,T2,T3,T4,T5,T6,T7>, Record8<T1,T2,T3,T4,T5,T6,T7,T8>, Record9<T1,T2,T3,T4,T5,T6,T7,T8,T9>, Result<R>, TableRecord<R>, UDTRecord<R>, UpdatableRecord<R>

All Known Implementing Classes:

ArrayRecordImpl, CustomRecord, EmbeddableRecordImpl, TableRecordImpl, UDTRecordImpl, UpdatableRecordImpl

public interface Formattable

A type that can format its contents.

This type provides a common interface for Result and Cursor formatting functionality, which includes formatting results to:

• Charts
• CSV
• HTML
• INSERT statements
• JSON
• Text
• XML

Calling formatting methods on a Result is repeatable as the Result has been previously materialised in memory and the database resource is closed. Calling these methods on a Cursor is not repeatable as the Cursor (and the underlying JDBC ResultSet) is consumed entirely, and closed eagerly after consumption.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull String	format()	Get a simple formatted representation of this result.
@NotNull String	format(int maxRecords)	Get a simple formatted representation of this result.
void	format(OutputStream stream)	Like format(), but the data is output onto an OutputStream.
void	format(OutputStream stream, int maxRecords)	Like format(int), but the data is output onto an OutputStream.
void	format(OutputStream stream, TXTFormat format)	Like format(TXTFormat), but the data is output onto an OutputStream.
void	format(Writer writer)	Like format(), but the data is output onto a Writer.
void	format(Writer writer, int maxRecords)	Like format(int), but the data is output onto a Writer.
void	format(Writer writer, TXTFormat format)	Like format(TXTFormat), but the data is output onto a Writer.
@NotNull String	format(TXTFormat format)	Get a simple formatted representation of this result.
String	formatChart()
void	formatChart(OutputStream stream)	Like formatChart(), but the data is output onto an OutputStream.
void	formatChart(OutputStream stream, ChartFormat format)	Like formatChart(ChartFormat), but the data is output onto an OutputStream.
void	formatChart(Writer writer)	Like formatChart(), but the data is output onto a Writer.
void	formatChart(Writer writer, ChartFormat format)	Like formatChart(ChartFormat), but the data is output onto a Writer.
String	formatChart(ChartFormat format)
@NotNull String	formatCSV()	Get a simple formatted representation of this result as CSV.
String	formatCSV(boolean header)	Get a simple formatted representation of this result as CSV.
String	formatCSV(boolean header, char delimiter)	Get a simple formatted representation of this result as CSV.
String	formatCSV(boolean header, char delimiter, String nullString)	Get a simple formatted representation of this result as CSV.
String	formatCSV(char delimiter)	Get a simple formatted representation of this result as CSV.
String	formatCSV(char delimiter, String nullString)	Get a simple formatted representation of this result as CSV.
void	formatCSV(OutputStream stream)	Like formatCSV(), but the data is output onto an OutputStream.
void	formatCSV(OutputStream stream, boolean header)	Like formatCSV(boolean), but the data is output onto an OutputStream.
void	formatCSV(OutputStream stream, boolean header, char delimiter)	Like formatCSV(boolean, char), but the data is output onto an OutputStream.
void	formatCSV(OutputStream stream, boolean header, char delimiter, String nullString)	Like formatCSV(boolean, char, String), but the data is output onto an OutputStream.
void	formatCSV(OutputStream stream, char delimiter)	Like formatCSV(char), but the data is output onto an OutputStream.
void	formatCSV(OutputStream stream, char delimiter, String nullString)	Like formatCSV(char, String), but the data is output onto an OutputStream.
void	formatCSV(OutputStream stream, CSVFormat format)	Like formatCSV(CSVFormat), but the data is output onto an OutputStream.
void	formatCSV(Writer writer)	Like formatCSV(), but the data is output onto a Writer.
void	formatCSV(Writer writer, boolean header)	Like formatCSV(boolean), but the data is output onto a Writer.
void	formatCSV(Writer writer, boolean header, char delimiter)	Like formatCSV(boolean, char), but the data is output onto a Writer.
void	formatCSV(Writer writer, boolean header, char delimiter, String nullString)	Like formatCSV(boolean, char, String), but the data is output onto a Writer.
void	formatCSV(Writer writer, char delimiter)	Like formatCSV(char), but the data is output onto a Writer.
void	formatCSV(Writer writer, char delimiter, String nullString)	Like formatCSV(char, String), but the data is output onto a Writer.
void	formatCSV(Writer writer, CSVFormat format)	Like formatCSV(CSVFormat), but the data is output onto a Writer.
String	formatCSV(CSVFormat format)	Get a simple formatted representation of this result as CSV.
@NotNull String	formatHTML()	Get a simple formatted representation of this result as HTML.
void	formatHTML(OutputStream stream)	Like formatHTML(), but the data is output onto an OutputStream.
void	formatHTML(Writer writer)	Like formatHTML(), but the data is output onto a Writer.
String	formatInsert()	Get this result as a set of INSERT statements.
void	formatInsert(OutputStream stream)	Like formatInsert(), but the data is output onto an OutputStream.
void	formatInsert(OutputStream stream, Table<?> table, Field<?>... fields)	Like formatInsert(Table, Field...), but the data is output onto an OutputStream.
void	formatInsert(Writer writer)	Like formatInsert(), but the data is output onto a Writer.
void	formatInsert(Writer writer, Table<?> table, Field<?>... fields)	Like formatInsert(Table, Field...), but the data is output onto an Writer.
String	formatInsert(Table<?> table, Field<?>... fields)	Get this result as a set of INSERT statements.
String	formatJSON()	Get a simple formatted representation of this result as a JSON array of array.
void	formatJSON(OutputStream stream)	Like formatJSON(), but the data is output onto an OutputStream.
void	formatJSON(OutputStream stream, JSONFormat format)	Like formatJSON(JSONFormat), but the data is output onto an OutputStream.
void	formatJSON(Writer writer)	Like formatJSON(), but the data is output onto a Writer.
void	formatJSON(Writer writer, JSONFormat format)	Like formatJSON(JSONFormat), but the data is output onto a Writer.
String	formatJSON(JSONFormat format)	Get a simple formatted representation of this result as a JSON data structure, according to the format.
String	formatXML()	Get this result formatted as XML.
void	formatXML(OutputStream stream)	Like formatXML(), but the data is output onto an OutputStream.
void	formatXML(OutputStream stream, XMLFormat format)	Like formatXML(XMLFormat), but the data is output onto an OutputStream.
void	formatXML(Writer writer)	Like formatXML(), but the data is output onto a Writer.
void	formatXML(Writer writer, XMLFormat format)	Like formatXML(XMLFormat), but the data is output onto a Writer.
String	formatXML(XMLFormat format)	Get this result formatted as XML.
Document	intoXML()	Get this result as XML.
<H extends ContentHandler> H	intoXML(H handler)	Get this result as XML using a SAX ContentHandler.
<H extends ContentHandler> H	intoXML(H handler, XMLFormat format)	Get this result as XML using a SAX ContentHandler.
Document	intoXML(XMLFormat format)	Get this result as XML.

Method Details

format

@NotNull
@NotNull String format()

Get a simple formatted representation of this result.

This is the same as calling format(int) with maxRows = Integer.MAX_VALUE

Returns:

The formatted result

format

@NotNull
@NotNull String format(int maxRecords)

Get a simple formatted representation of this result.

Parameters:

maxRecords - The maximum number of records to include in the formatted result

Returns:

The formatted result

format

@NotNull
@NotNull String format(TXTFormat format)

Get a simple formatted representation of this result.

Parameters:

format - The formatting information

Returns:

The formatted result

formatHTML

@NotNull
@NotNull String formatHTML()

Get a simple formatted representation of this result as HTML.

The HTML code is formatted as follows:

 <table>
   <thead>
     <tr>
       <th>field-1</th>
       <th>field-2</th>
       ...
       <th>field-n</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <th>value-1-1</th>
       <th>value-1-2</th>
       ...
       <th>value-1-n</th>
     </tr>
     <tr>
       <th>value-2-1</th>
       <th>value-2-2</th>
       ...
       <th>value-2-n</th>
     </tr>
     ...
   </tbody>
 </table>
 

Returns:

The formatted result

formatCSV

@NotNull
@NotNull String formatCSV()

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(true, ',', "")

Returns:

The formatted result

formatCSV

String formatCSV(char delimiter)

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(true, delimiter, "")

Parameters:

delimiter - The delimiter to use between records

Returns:

The formatted result

formatCSV

String formatCSV(char delimiter,
 String nullString)

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(true, delimiter, nullString)

Parameters:

delimiter - The delimiter to use between records

nullString - A special string for encoding NULL values.

Returns:

The formatted result

formatCSV

String formatCSV(boolean header)

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(',', "")

Parameters:

header - Whether to emit a CSV header line

Returns:

The formatted result

formatCSV

String formatCSV(boolean header,
 char delimiter)

Get a simple formatted representation of this result as CSV.

This is the same as calling formatCSV(delimiter, "")

Parameters:

header - Whether to emit a CSV header line

delimiter - The delimiter to use between records

Returns:

The formatted result

formatCSV

String formatCSV(boolean header,
 char delimiter,
 String nullString)

Get a simple formatted representation of this result as CSV.

Parameters:

header - Whether to emit a CSV header line

delimiter - The delimiter to use between records

nullString - A special string for encoding NULL values.

Returns:

The formatted result

formatCSV

String formatCSV(CSVFormat format)

Get a simple formatted representation of this result as CSV.

Returns:

The formatted result

formatJSON

String formatJSON()

Get a simple formatted representation of this result as a JSON array of array.

The format is the following:

 {"fields":[{"name":"field-1","type":"type-1"},
            {"name":"field-2","type":"type-2"},
            ...,
            {"name":"field-n","type":"type-n"}],
  "records":[[value-1-1,value-1-2,...,value-1-n],
             [value-2-1,value-2-2,...,value-2-n]]}
 

Returns:

The formatted result

formatJSON

String formatJSON(JSONFormat format)

Get a simple formatted representation of this result as a JSON data structure, according to the format.

Returns:

The formatted result

See Also:

JSONFormat

formatXML

String formatXML()

Get this result formatted as XML.

See Also:

http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

formatXML

String formatXML(XMLFormat format)

Get this result formatted as XML.

See Also:

http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

formatChart

String formatChart()

formatChart

String formatChart(ChartFormat format)

formatInsert

String formatInsert()

Get this result as a set of INSERT statements.

This uses the the first record's TableRecord.getTable(), if the first record is a TableRecord. Otherwise, this generates INSERT statements into an "UNKNOWN_TABLE". In both cases, the Fields.fields() are used for column names.

formatInsert

String formatInsert(Table<?> table,
 Field<?>... fields)

Get this result as a set of INSERT statements.

This explicitly specifies the table (and optionally the fields) to insert into. If the fields argument is left empty, the Fields.fields() are used, instead.

format

void format(OutputStream stream)
     throws IOException

Like format(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

format

void format(OutputStream stream,
 int maxRecords)
     throws IOException

Like format(int), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

format

void format(OutputStream stream,
 TXTFormat format)
     throws IOException

Like format(TXTFormat), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatHTML

void formatHTML(OutputStream stream)
         throws IOException

Like formatHTML(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream)
        throws IOException

Like formatCSV(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream,
 char delimiter)
        throws IOException

Like formatCSV(char), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream,
 char delimiter,
 String nullString)
        throws IOException

Like formatCSV(char, String), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream,
 boolean header)
        throws IOException

Like formatCSV(boolean), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream,
 boolean header,
 char delimiter)
        throws IOException

Like formatCSV(boolean, char), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream,
 boolean header,
 char delimiter,
 String nullString)
        throws IOException

Like formatCSV(boolean, char, String), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(OutputStream stream,
 CSVFormat format)
        throws IOException

Like formatCSV(CSVFormat), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatJSON

void formatJSON(OutputStream stream)
         throws IOException

Like formatJSON(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatJSON

void formatJSON(OutputStream stream,
 JSONFormat format)
         throws IOException

Like formatJSON(JSONFormat), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatXML

void formatXML(OutputStream stream)
        throws IOException

Like formatXML(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatXML

void formatXML(OutputStream stream,
 XMLFormat format)
        throws IOException

Like formatXML(XMLFormat), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatChart

void formatChart(OutputStream stream)
          throws IOException

Like formatChart(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatChart

void formatChart(OutputStream stream,
 ChartFormat format)
          throws IOException

Like formatChart(ChartFormat), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatInsert

void formatInsert(OutputStream stream)
           throws IOException

Like formatInsert(), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatInsert

void formatInsert(OutputStream stream,
 Table<?> table,
 Field<?>... fields)
           throws IOException

Like formatInsert(Table, Field...), but the data is output onto an OutputStream.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

format

void format(Writer writer)
     throws IOException

Like format(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

format

void format(Writer writer,
 int maxRecords)
     throws IOException

Like format(int), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

format

void format(Writer writer,
 TXTFormat format)
     throws IOException

Like format(TXTFormat), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatHTML

void formatHTML(Writer writer)
         throws IOException

Like formatHTML(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer)
        throws IOException

Like formatCSV(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer,
 char delimiter)
        throws IOException

Like formatCSV(char), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer,
 char delimiter,
 String nullString)
        throws IOException

Like formatCSV(char, String), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer,
 boolean header)
        throws IOException

Like formatCSV(boolean), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer,
 boolean header,
 char delimiter)
        throws IOException

Like formatCSV(boolean, char), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer,
 boolean header,
 char delimiter,
 String nullString)
        throws IOException

Like formatCSV(boolean, char, String), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatCSV

void formatCSV(Writer writer,
 CSVFormat format)
        throws IOException

Like formatCSV(CSVFormat), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatJSON

void formatJSON(Writer writer)
         throws IOException

Like formatJSON(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatJSON

void formatJSON(Writer writer,
 JSONFormat format)
         throws IOException

Like formatJSON(JSONFormat), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatXML

void formatXML(Writer writer)
        throws IOException

Like formatXML(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatXML

void formatXML(Writer writer,
 XMLFormat format)
        throws IOException

Like formatXML(XMLFormat), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatChart

void formatChart(Writer writer)
          throws IOException

Like formatChart(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatChart

void formatChart(Writer writer,
 ChartFormat format)
          throws IOException

Like formatChart(ChartFormat), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatInsert

void formatInsert(Writer writer)
           throws IOException

Like formatInsert(), but the data is output onto a Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

formatInsert

void formatInsert(Writer writer,
 Table<?> table,
 Field<?>... fields)
           throws IOException

Like formatInsert(Table, Field...), but the data is output onto an Writer.

Throws:

IOException - - an unchecked wrapper for IOException, if anything goes wrong.

intoXML

Document intoXML()

Get this result as XML.

See Also:

formatXML(), http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

intoXML

Document intoXML(XMLFormat format)

Get this result as XML.

See Also:

formatXML(), http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

intoXML

<H extends ContentHandler> H intoXML(H handler)
                              throws SAXException

Get this result as XML using a SAX ContentHandler.

Parameters:

handler - The custom content handler.

Returns:

The argument content handler is returned for convenience.

Throws:

SAXException

See Also:

formatXML(), http://www.jooq.org/xsd/jooq-export-3.10.0.xsd

intoXML

<H extends ContentHandler> H intoXML(H handler,
 XMLFormat format)
                              throws SAXException

Get this result as XML using a SAX ContentHandler.

Parameters:

handler - The custom content handler.

Returns:

The argument content handler is returned for convenience.

Throws:

SAXException

See Also:

formatXML(), http://www.jooq.org/xsd/jooq-export-3.10.0.xsd