Module org.jooq

Package org.jooq.impl

Class AssociativeArrayRecordImpl<K,V>

java.lang.Object

org.jooq.impl.AssociativeArrayRecordImpl<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>, ArrayOrAssociativeArrayRecord<V>, AssociativeArrayRecord<K,V>, Attachable, Formattable

@Internal
@Pro
public class AssociativeArrayRecordImpl<K,V>
extends Object
implements AssociativeArrayRecord<K,V>

A common base class for Oracle associative array types

This type is for JOOQ INTERNAL USE only. Do not reference directly

Author:

Lukas Eder

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AssociativeArrayRecordImpl(Schema schema, String name, DataType<V> type, DataType<K> indexDataType)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, String name, DataType<X> type, DataType<K> indexDataType, Binding<X,Y> binding)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, String name, DataType<X> type, DataType<K> indexDataType, Converter<X,V> converter)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, String name, DataType<X> type, DataType<K> indexDataType, Converter<Y,V> converter, Binding<X,Y> binding)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, Package pkg, String name, DataType<V> type, DataType<K> indexDataType)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, Package pkg, String name, DataType<X> type, DataType<K> indexDataType, Binding<X,Y> binding)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, Package pkg, String name, DataType<X> type, DataType<K> indexDataType, Converter<X,V> converter)	Create an empty array record
protected	AssociativeArrayRecordImpl(Schema schema, Package pkg, String name, DataType<X> type, DataType<K> indexDataType, Converter<Y,V> converter, Binding<X,Y> binding)	Create an empty array record

Method Summary

Modifier and Type	Method	Description
final void	attach(Configuration c)	Attach this object to a new Configuration.
final void	clear()
final V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
final V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
final V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
final Configuration	configuration()	Get the currently attached Configuration, or null if no Configuration is attached.
final boolean	containsKey(Object key)
final boolean	containsValue(Object value)
protected final DSLContext	create()	Deprecated. - 3.11.0 - [#6720] [#6721] - Use Attachable.configuration() and Configuration.dsl() instead.
final void	detach()	Detach this object from its current Configuration.
final Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object obj)
final void	forEach(BiConsumer<? super K,? super V> action)
final String	format()	Get a simple formatted representation of this result.
final String	format(int maxRecords)	Get a simple formatted representation of this result.
final void	format(OutputStream stream)	Like Formattable.format(), but the data is output onto an OutputStream.
final void	format(OutputStream stream, int maxRecords)	Like Formattable.format(int), but the data is output onto an OutputStream.
final void	format(OutputStream stream, TXTFormat format)	Like Formattable.format(TXTFormat), but the data is output onto an OutputStream.
final void	format(Writer writer)	Like Formattable.format(), but the data is output onto a Writer.
final void	format(Writer writer, int maxRecords)	Like Formattable.format(int), but the data is output onto a Writer.
final void	format(Writer writer, TXTFormat format)	Like Formattable.format(TXTFormat), but the data is output onto a Writer.
final String	format(TXTFormat format)	Get a simple formatted representation of this result.
final String	formatChart()	Get this result as an ASCII chart.
final void	formatChart(OutputStream stream)	Like Formattable.formatChart(), but the data is output onto an OutputStream.
final void	formatChart(OutputStream stream, ChartFormat format)	Like Formattable.formatChart(ChartFormat), but the data is output onto an OutputStream.
final void	formatChart(Writer writer)	Like Formattable.formatChart(), but the data is output onto a Writer.
final void	formatChart(Writer writer, ChartFormat format)	Like Formattable.formatChart(ChartFormat), but the data is output onto a Writer.
final String	formatChart(ChartFormat format)	Get this result as an ASCII chart.
final String	formatCSV()	Get a simple formatted representation of this result as CSV.
final String	formatCSV(boolean header)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(boolean header, char delimiter)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(boolean header, char delimiter, String nullString)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(char delimiter)	Get a simple formatted representation of this result as CSV.
final String	formatCSV(char delimiter, String nullString)	Get a simple formatted representation of this result as CSV.
final void	formatCSV(OutputStream stream)	Like Formattable.formatCSV(), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, boolean header)	Like Formattable.formatCSV(boolean), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, boolean header, char delimiter)	Like Formattable.formatCSV(boolean, char), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, boolean header, char delimiter, String nullString)	Like Formattable.formatCSV(boolean, char, String), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, char delimiter)	Like Formattable.formatCSV(char), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, char delimiter, String nullString)	Like Formattable.formatCSV(char, String), but the data is output onto an OutputStream.
final void	formatCSV(OutputStream stream, CSVFormat format)	Like Formattable.formatCSV(CSVFormat), but the data is output onto an OutputStream.
final void	formatCSV(Writer writer)	Like Formattable.formatCSV(), but the data is output onto a Writer.
final void	formatCSV(Writer writer, boolean header)	Like Formattable.formatCSV(boolean), but the data is output onto a Writer.
final void	formatCSV(Writer writer, boolean header, char delimiter)	Like Formattable.formatCSV(boolean, char), but the data is output onto a Writer.
final void	formatCSV(Writer writer, boolean header, char delimiter, String nullString)	Like Formattable.formatCSV(boolean, char, String), but the data is output onto a Writer.
final void	formatCSV(Writer writer, char delimiter)	Like Formattable.formatCSV(char), but the data is output onto a Writer.
final void	formatCSV(Writer writer, char delimiter, String nullString)	Like Formattable.formatCSV(char, String), but the data is output onto a Writer.
final void	formatCSV(Writer writer, CSVFormat format)	Like Formattable.formatCSV(CSVFormat), but the data is output onto a Writer.
final String	formatCSV(CSVFormat format)	Get a simple formatted representation of this result as CSV.
final String	formatHTML()	Get a simple formatted representation of this result as HTML.
final void	formatHTML(OutputStream stream)	Like Formattable.formatHTML(), but the data is output onto an OutputStream.
final void	formatHTML(Writer writer)	Like Formattable.formatHTML(), but the data is output onto a Writer.
final String	formatInsert()	Get this result as a set of INSERT statements.
final void	formatInsert(OutputStream stream)	Like Formattable.formatInsert(), but the data is output onto an OutputStream.
final void	formatInsert(OutputStream stream, Table<?> table, Field<?>... f)	Like Formattable.formatInsert(Table, Field...), but the data is output onto an OutputStream.
final void	formatInsert(Writer writer)	Like Formattable.formatInsert(), but the data is output onto a Writer.
final void	formatInsert(Writer writer, Table<?> table, Field<?>... fields)	Like Formattable.formatInsert(Table, Field...), but the data is output onto an Writer.
final String	formatInsert(Table<?> table, Field<?>... f)	Get this result as a set of INSERT statements.
final String	formatJSON()	Get a simple formatted representation of this result as a JSON array of array.
final void	formatJSON(OutputStream stream)	Like Formattable.formatJSON(), but the data is output onto an OutputStream.
final void	formatJSON(OutputStream stream, JSONFormat format)	Like Formattable.formatJSON(JSONFormat), but the data is output onto an OutputStream.
final void	formatJSON(Writer writer)	Like Formattable.formatJSON(), but the data is output onto a Writer.
final void	formatJSON(Writer writer, JSONFormat format)	Like Formattable.formatJSON(JSONFormat), but the data is output onto a Writer.
final String	formatJSON(JSONFormat format)	Get a simple formatted representation of this result as a JSON data structure, according to the format.
final String	formatXML()	Get this result formatted as XML.
final void	formatXML(OutputStream stream)	Like Formattable.formatXML(), but the data is output onto an OutputStream.
final void	formatXML(OutputStream stream, XMLFormat format)	Like Formattable.formatXML(XMLFormat), but the data is output onto an OutputStream.
final void	formatXML(Writer writer)	Like Formattable.formatXML(), but the data is output onto a Writer.
final void	formatXML(Writer writer, XMLFormat format)	Like Formattable.formatXML(XMLFormat), but the data is output onto a Writer.
final String	formatXML(XMLFormat format)	Get this result formatted as XML.
final V	get(Object key)
final DataType<?>	getArrayType()	Get the data type of the array.
final Catalog	getCatalog()	Get the record type's catalog.
final DataType<V>	getDataType()	Get the data type of the array's base type.
final DataType<K>	getIndexDataType()	Get the data type of the array's index type.
final String	getName()	Get the unqualified name of the array type.
final V	getOrDefault(Object key, V defaultValue)
final Package	getPackage()	Get the UDT package.
final Schema	getSchema()	Get the record type's schema.
int	hashCode()
final Document	intoXML()	Get this result as XML.
final <H extends ContentHandler> H	intoXML(H handler)	Get this result as XML using a SAX ContentHandler.
final <H extends ContentHandler> H	intoXML(H handler, XMLFormat format)	Get this result as XML using a SAX ContentHandler.
final Document	intoXML(XMLFormat format)	Get this result as XML.
final boolean	isEmpty()
final boolean	isSQLUsable()	Whether this data type can be used from SQL statements.
final Set<K>	keySet()
final V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
final V	put(K key, V value)
final void	putAll(Map<? extends K,? extends V> m)
final V	putIfAbsent(K key, V value)
final V	remove(Object key)
final boolean	remove(Object key, Object value)
final V	replace(K key, V value)
final boolean	replace(K key, V oldValue, V newValue)
final void	replaceAll(BiFunction<? super K,? super V,? extends V> function)
final int	size()
final List<V>	toList()	Get a List representation of this array.
final String	toString()
final Collection<V>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jooq.Attachable

attach, configuration, detach

Methods inherited from interface org.jooq.Formattable

format, format, format, format, format, format, format, format, formatChart, formatChart, formatChart, formatChart, formatChart, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatHTML, formatHTML, formatInsert, formatInsert, formatInsert, formatInsert, formatJSON, formatJSON, formatJSON, formatJSON, formatJSON, formatXML, formatXML, formatXML, formatXML, formatXML, intoXML, intoXML

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 String name,
 DataType<V> type,
 DataType<K> indexDataType)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 Package pkg,
 String name,
 DataType<V> type,
 DataType<K> indexDataType)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 String name,
 DataType<X> type,
 DataType<K> indexDataType,
 Converter<X,V> converter)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 Package pkg,
 String name,
 DataType<X> type,
 DataType<K> indexDataType,
 Converter<X,V> converter)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 String name,
 DataType<X> type,
 DataType<K> indexDataType,
 Binding<X,Y> binding)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 Package pkg,
 String name,
 DataType<X> type,
 DataType<K> indexDataType,
 Binding<X,Y> binding)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 String name,
 DataType<X> type,
 DataType<K> indexDataType,
 Converter<Y,V> converter,
 Binding<X,Y> binding)

Create an empty array record

AssociativeArrayRecordImpl

protected AssociativeArrayRecordImpl(Schema schema,
 Package pkg,
 String name,
 DataType<X> type,
 DataType<K> indexDataType,
 Converter<Y,V> converter,
 Binding<X,Y> binding)

Create an empty array record

Method Details

getCatalog

public final Catalog getCatalog()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get the record type's catalog.

Specified by:

getCatalog in interface ArrayOrAssociativeArrayRecord<K>

getSchema

public final Schema getSchema()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get the record type's schema.

Specified by:

getSchema in interface ArrayOrAssociativeArrayRecord<K>

getPackage

public final Package getPackage()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get the UDT package.

Specified by:

getPackage in interface ArrayOrAssociativeArrayRecord<K>

isSQLUsable

public final boolean isSQLUsable()

Description copied from interface: ArrayOrAssociativeArrayRecord

Whether this data type can be used from SQL statements.

Specified by:

isSQLUsable in interface ArrayOrAssociativeArrayRecord<K>

getName

public final String getName()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get the unqualified name of the array type.

Specified by:

getName in interface ArrayOrAssociativeArrayRecord<K>

getDataType

public final DataType<V> getDataType()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get the data type of the array's base type.

Specified by:

getDataType in interface ArrayOrAssociativeArrayRecord<K>

getIndexDataType

public final DataType<K> getIndexDataType()

Description copied from interface: AssociativeArrayRecord

Get the data type of the array's index type.

Specified by:

getIndexDataType in interface AssociativeArrayRecord<K,V>

getArrayType

public final DataType<?> getArrayType()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get the data type of the array.

Specified by:

getArrayType in interface ArrayOrAssociativeArrayRecord<K>

toString

public final String toString()

Overrides:

toString in class Object

toList

public final List<V> toList()

Description copied from interface: ArrayOrAssociativeArrayRecord

Get a List representation of this array.

• If this is an ArrayRecord, then this returns itself
• If this is an AssociativeArrayRecord, then this returns a List representation of Map.values()

Specified by:

toList in interface ArrayOrAssociativeArrayRecord<K>

size

public final int size()

Specified by:

size in interface Map<K,V>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public final boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public final boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

get

public final V get(Object key)

Specified by:

get in interface Map<K,V>

put

public final V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

remove

public final V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

public final void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

clear

public final void clear()

Specified by:

clear in interface Map<K,V>

keySet

public final Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public final Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public final Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

getOrDefault

public final V getOrDefault(Object key,
 V defaultValue)

Specified by:

getOrDefault in interface Map<K,V>

forEach

public final void forEach(BiConsumer<? super K,? super V> action)

Specified by:

forEach in interface Map<K,V>

replaceAll

public final void replaceAll(BiFunction<? super K,? super V,? extends V> function)

Specified by:

replaceAll in interface Map<K,V>

putIfAbsent

public final V putIfAbsent(K key,
 V value)

Specified by:

putIfAbsent in interface Map<K,V>

remove

public final boolean remove(Object key,
 Object value)

Specified by:

remove in interface Map<K,V>

replace

public final boolean replace(K key,
 V oldValue,
 V newValue)

Specified by:

replace in interface Map<K,V>

replace

public final V replace(K key,
 V value)

Specified by:

replace in interface Map<K,V>

computeIfAbsent

public final V computeIfAbsent(K key,
 Function<? super K,? extends V> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K,V>

computeIfPresent

public final V computeIfPresent(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

computeIfPresent in interface Map<K,V>

compute

public final V compute(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

compute in interface Map<K,V>

merge

public final V merge(K key,
 V value,
 BiFunction<? super V,? super V,? extends V> remappingFunction)

Specified by:

merge in interface Map<K,V>

format

public final void format(Writer writer,
 TXTFormat format)

Description copied from interface: Formattable

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

Specified by:

format in interface Formattable

formatHTML

public final void formatHTML(Writer writer)

Description copied from interface: Formattable

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

Specified by:

formatHTML in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 CSVFormat format)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatJSON

public final void formatJSON(Writer writer,
 JSONFormat format)

Description copied from interface: Formattable

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

Specified by:

formatJSON in interface Formattable

formatXML

public final void formatXML(Writer writer,
 XMLFormat format)

Description copied from interface: Formattable

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

Specified by:

formatXML in interface Formattable

formatChart

public final void formatChart(Writer writer,
 ChartFormat format)

Description copied from interface: Formattable

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

Specified by:

formatChart in interface Formattable

formatInsert

public final void formatInsert(Writer writer)

Description copied from interface: Formattable

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

Specified by:

formatInsert in interface Formattable

formatInsert

public final void formatInsert(Writer writer,
 Table<?> table,
 Field<?>... fields)

Description copied from interface: Formattable

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

Specified by:

formatInsert in interface Formattable

intoXML

public final Document intoXML(XMLFormat format)

Description copied from interface: Formattable

Get this result as XML.

Specified by:

intoXML in interface Formattable

See Also:

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

intoXML

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

Description copied from interface: Formattable

Get this result as XML using a SAX ContentHandler.

Specified by:

intoXML in interface Formattable

Parameters:

handler - The custom content handler.

Returns:

The argument content handler is returned for convenience.

Throws:

SAXException

See Also:

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

create

@Deprecated
protected final DSLContext create()

Deprecated.

- 3.11.0 - [#6720] [#6721] - Use Attachable.configuration() and Configuration.dsl() instead.

This method is used in generated code!

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

attach

public final void attach(Configuration c)

Description copied from interface: Attachable

Attach this object to a new Configuration.

Specified by:

attach in interface Attachable

Parameters:

c - A configuration or null, if you wish to detach this Attachable from its previous configuration.

detach

public final void detach()

Description copied from interface: Attachable

Detach this object from its current Configuration.

This is the same as calling attach(null).

Specified by:

detach in interface Attachable

configuration

public final Configuration configuration()

Description copied from interface: Attachable

Get the currently attached Configuration, or null if no Configuration is attached.

Specified by:

configuration in interface Attachable

format

public final String format()

Description copied from interface: Formattable

Get a simple formatted representation of this result.

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

Specified by:

format in interface Formattable

Returns:

The formatted result

format

public final String format(int maxRecords)

Description copied from interface: Formattable

Get a simple formatted representation of this result.

Specified by:

format in interface Formattable

Parameters:

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

Returns:

The formatted result

format

public final String format(TXTFormat format)

Description copied from interface: Formattable

Get a simple formatted representation of this result.

Specified by:

format in interface Formattable

Parameters:

format - The formatting information

Returns:

The formatted result

format

public final void format(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

format in interface Formattable

format

public final void format(OutputStream stream,
 int maxRecords)

Description copied from interface: Formattable

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

Specified by:

format in interface Formattable

format

public final void format(OutputStream stream,
 TXTFormat format)

Description copied from interface: Formattable

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

Specified by:

format in interface Formattable

format

public final void format(Writer writer)

Description copied from interface: Formattable

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

Specified by:

format in interface Formattable

format

public final void format(Writer writer,
 int maxRecords)

Description copied from interface: Formattable

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

Specified by:

format in interface Formattable

formatCSV

public final String formatCSV()

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

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

Specified by:

formatCSV in interface Formattable

Returns:

The formatted result

formatCSV

public final String formatCSV(boolean header)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

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

Specified by:

formatCSV in interface Formattable

Parameters:

header - Whether to emit a CSV header line

Returns:

The formatted result

formatCSV

public final String formatCSV(char delimiter)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

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

Specified by:

formatCSV in interface Formattable

Parameters:

delimiter - The delimiter to use between records

Returns:

The formatted result

formatCSV

public final String formatCSV(boolean header,
 char delimiter)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

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

Specified by:

formatCSV in interface Formattable

Parameters:

header - Whether to emit a CSV header line

delimiter - The delimiter to use between records

Returns:

The formatted result

formatCSV

public final String formatCSV(char delimiter,
 String nullString)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

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

Specified by:

formatCSV in interface Formattable

Parameters:

delimiter - The delimiter to use between records

nullString - A special string for encoding NULL values.

Returns:

The formatted result

formatCSV

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

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

Specified by:

formatCSV in interface Formattable

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

public final String formatCSV(CSVFormat format)

Description copied from interface: Formattable

Get a simple formatted representation of this result as CSV.

Specified by:

formatCSV in interface Formattable

Returns:

The formatted result

formatCSV

public final void formatCSV(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 boolean header)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 char delimiter)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 boolean header,
 char delimiter)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 boolean header,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(OutputStream stream,
 CSVFormat format)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 boolean header)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 char delimiter)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 boolean header,
 char delimiter)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatCSV

public final void formatCSV(Writer writer,
 boolean header,
 char delimiter,
 String nullString)

Description copied from interface: Formattable

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

Specified by:

formatCSV in interface Formattable

formatJSON

public final String formatJSON()

Description copied from interface: Formattable

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]]}
 

Specified by:

formatJSON in interface Formattable

Returns:

The formatted result

formatJSON

public final String formatJSON(JSONFormat format)

Description copied from interface: Formattable

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

Specified by:

formatJSON in interface Formattable

Returns:

The formatted result

See Also:

• JSONFormat

formatJSON

public final void formatJSON(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

formatJSON in interface Formattable

formatJSON

public final void formatJSON(OutputStream stream,
 JSONFormat format)

Description copied from interface: Formattable

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

Specified by:

formatJSON in interface Formattable

formatJSON

public final void formatJSON(Writer writer)

Description copied from interface: Formattable

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

Specified by:

formatJSON in interface Formattable

formatXML

public final String formatXML()

Description copied from interface: Formattable

Get this result formatted as XML.

Specified by:

formatXML in interface Formattable

See Also:

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

formatXML

public final String formatXML(XMLFormat format)

Description copied from interface: Formattable

Get this result formatted as XML.

Specified by:

formatXML in interface Formattable

See Also:

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

formatXML

public final void formatXML(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

formatXML in interface Formattable

formatXML

public final void formatXML(OutputStream stream,
 XMLFormat format)

Description copied from interface: Formattable

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

Specified by:

formatXML in interface Formattable

formatXML

public final void formatXML(Writer writer)

Description copied from interface: Formattable

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

Specified by:

formatXML in interface Formattable

formatChart

public final String formatChart()

Description copied from interface: Formattable

Get this result as an ASCII chart.

Specified by:

formatChart in interface Formattable

See Also:

• Formattable.formatChart(ChartFormat)

formatChart

public final String formatChart(ChartFormat format)

Description copied from interface: Formattable

Get this result as an ASCII chart.

When running a query like this:

 String chart =
 create.select(
            BOOK_TO_BOOK_STORE.BOOK_STORE_NAME,
            count(BOOK_TO_BOOK_STORE.BOOK_ID).as("books")
        )
        .from(BOOK_TO_BOOK_STORE)
        .groupBy(BOOK_TO_BOOK_STORE.BOOK_STORE_NAME)
        .fetch()
        .formatChart();
 

Where the formatted result would look like this:

 +-------------------------+-----+
 |BOOK_STORE_NAME          |books|
 +-------------------------+-----+
 |Buchhandlung im Volkshaus|    1|
 |Ex Libris                |    2|
 |Orell Füssli             |    3|
 +-------------------------+-----+
 

Then the chart might look something like this:

 3.00|                                                  █████████████████████████
 2.91|                                                  █████████████████████████
 2.82|                                                  █████████████████████████
 2.73|                                                  █████████████████████████
 2.64|                                                  █████████████████████████
 2.55|                                                  █████████████████████████
 2.45|                                                  █████████████████████████
 2.36|                                                  █████████████████████████
 2.27|                                                  █████████████████████████
 2.18|                                                  █████████████████████████
 2.09|                                                  █████████████████████████
 2.00|                         ██████████████████████████████████████████████████
 1.91|                         ██████████████████████████████████████████████████
 1.82|                         ██████████████████████████████████████████████████
 1.73|                         ██████████████████████████████████████████████████
 1.64|                         ██████████████████████████████████████████████████
 1.55|                         ██████████████████████████████████████████████████
 1.45|                         ██████████████████████████████████████████████████
 1.36|                         ██████████████████████████████████████████████████
 1.27|                         ██████████████████████████████████████████████████
 1.18|                         ██████████████████████████████████████████████████
 1.09|                         ██████████████████████████████████████████████████
 1.00|███████████████████████████████████████████████████████████████████████████
 ----+---------------------------------------------------------------------------
     | Buchhandlung im Volkshaus         Ex Libris               Orell Füssli
 

It is possible to specify a variety of ChartFormat formatting specifications, such as the width, height, display type (default, stacked, 100% stacked), the column index of the category and value columns, etc.

Specified by:

formatChart in interface Formattable

See Also:

• Formattable.formatChart(ChartFormat)

formatChart

public final void formatChart(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

formatChart in interface Formattable

formatChart

public final void formatChart(OutputStream stream,
 ChartFormat format)

Description copied from interface: Formattable

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

Specified by:

formatChart in interface Formattable

formatChart

public final void formatChart(Writer writer)

Description copied from interface: Formattable

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

Specified by:

formatChart in interface Formattable

formatInsert

public final String formatInsert()

Description copied from interface: Formattable

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.

Specified by:

formatInsert in interface Formattable

formatInsert

public final void formatInsert(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

formatInsert in interface Formattable

formatInsert

public final String formatInsert(Table<?> table,
 Field<?>... f)

Description copied from interface: Formattable

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.

Specified by:

formatInsert in interface Formattable

formatInsert

public final void formatInsert(OutputStream stream,
 Table<?> table,
 Field<?>... f)

Description copied from interface: Formattable

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

Specified by:

formatInsert in interface Formattable

formatHTML

public final String formatHTML()

Description copied from interface: Formattable

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>
 

Specified by:

formatHTML in interface Formattable

Returns:

The formatted result

formatHTML

public final void formatHTML(OutputStream stream)

Description copied from interface: Formattable

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

Specified by:

formatHTML in interface Formattable

intoXML

public final Document intoXML()

Description copied from interface: Formattable

Get this result as XML.

Specified by:

intoXML in interface Formattable

See Also:

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

intoXML

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

Description copied from interface: Formattable

Get this result as XML using a SAX ContentHandler.

Specified by:

intoXML in interface Formattable

Parameters:

handler - The custom content handler.

Returns:

The argument content handler is returned for convenience.

Throws:

SAXException

See Also:

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