Top Description Inners Fields Constructors Methods
org.jooq

public final Class ChartFormat

extends Object
Class Inheritance
Imports
java.text.DecimalFormat, org.jetbrains.annotations.NotNull

A CSV formatting type, which can be used to configure chart exports.

The type is immutable, meaning calls to setters like width(int) do not modify the original reference, but return a new one instead.

Author
Lukas Eder

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static enum
ChartFormat.Output

The chart output format.

public static enum

Field Summary

Modifier and TypeField and Description
pack-priv final int
pack-priv final boolean
public static final ChartFormat
pack-priv final ChartFormat.Display
pack-priv final int
pack-priv final String
pack-priv final DecimalFormat
pack-priv final ChartFormat.Output
pack-priv final DecimalFormat
pack-priv final char[]
pack-priv final boolean
pack-priv final boolean
pack-priv final ChartFormat.Type
pack-priv final int[]
pack-priv final int

Constructor Summary

AccessConstructor and Description
public
private
ChartFormat(ChartFormat.Output output, ChartFormat.Type type, ChartFormat.Display display, int width, int height, int category, boolean categoryAsText, int[] values, char[] shades, boolean showHorizontalLegend, boolean showVerticalLegend, String newline, DecimalFormat numericFormat, DecimalFormat percentFormat)

Method Summary

Modifier and TypeMethod and Description
public @NotNull ChartFormat
category(int newCategory)

The new category source column number, defaulting to 0.

public int
category()

The category source column number.

public @NotNull ChartFormat
categoryAsText(boolean newCategoryAsText)

The new category as text value, defaulting to true.

public boolean
categoryAsText()

The category as text value.

public @NotNull ChartFormat
dimensions(int newWidth, int newHeight)

The new chart dimensions, defaulting to 80 x 25.

public @NotNull ChartFormat
display(ChartFormat.Display newDisplay)

The new display format, defaulting to Display#STACKED.

public @NotNull ChartFormat.Display
display()

The display format.

public @NotNull ChartFormat
height(int newHeight)

The new chart height, defaulting to 25.

public int
height()

The chart height.

public @NotNull ChartFormat
newline(String newNewline)

The new newline character, defaulting to \n.

public @NotNull String
newline()

The newline character.

public @NotNull ChartFormat
numericFormat(DecimalFormat newNumericFormat)

The new numeric format, defaulting to ###,###.00.

public @NotNull DecimalFormat
numericFormat()

The numeric format.

public @NotNull ChartFormat
output(ChartFormat.Output newOutput)

The new output format, defaulting to Output#ASCII.

public @NotNull ChartFormat.Output
output()

The output format.

public @NotNull ChartFormat
percentFormat(DecimalFormat newPercentFormat)

The new numeric format for percentages, defaulting to ###.00'%'.

public @NotNull DecimalFormat
percentFormat()

The numeric format for percentages.

public @NotNull ChartFormat
shades(char... newShades)

The new column shades, defaulting to { 'X' }.

public @NotNull char[]
shades()

The value column shades.

public @NotNull ChartFormat
showHorizontalLegend(boolean newShowHorizontalLegend)

Whether to show the horizontal legend, defaulting to true.

public boolean
showHorizontalLegend()

Whether to show the horizontal legend.

public @NotNull ChartFormat
showLegends(boolean newShowHorizontalLegend, boolean newShowVerticalLegend)

Whether to show legends, defaulting to true.

public @NotNull ChartFormat
showVerticalLegend(boolean newShowVerticalLegend)

Whether to show the vertical legend, defaulting to true.

public boolean
showVerticalLegend()

Whether to show the vertical legend.

public @NotNull ChartFormat
type(ChartFormat.Type newType)

The new chart type, defaulting to Type#AREA.

public @NotNull ChartFormat.Type
type()

public @NotNull ChartFormat
values(int... newValues)

The new value source column numbers, defaulting to { 1 }.

public @NotNull int[]
values()

The value source column numbers.

public @NotNull ChartFormat
width(int newWidth)

The new chart width, defaulting to 80.

public int
width()

The chart width.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

categoryback to summary
pack-priv final int category
categoryAsTextback to summary
pack-priv final boolean categoryAsText
DEFAULTback to summary
public static final ChartFormat DEFAULT
displayback to summary
pack-priv final ChartFormat.Display display
heightback to summary
pack-priv final int height
newlineback to summary
pack-priv final String newline
numericFormatback to summary
pack-priv final DecimalFormat numericFormat
outputback to summary
pack-priv final ChartFormat.Output output
percentFormatback to summary
pack-priv final DecimalFormat percentFormat
shadesback to summary
pack-priv final char[] shades
showHorizontalLegendback to summary
pack-priv final boolean showHorizontalLegend
showVerticalLegendback to summary
pack-priv final boolean showVerticalLegend
typeback to summary
pack-priv final ChartFormat.Type type
valuesback to summary
pack-priv final int[] values
widthback to summary
pack-priv final int width

Constructor Detail

ChartFormatback to summary
public ChartFormat()
ChartFormatback to summary
private ChartFormat(ChartFormat.Output output, ChartFormat.Type type, ChartFormat.Display display, int width, int height, int category, boolean categoryAsText, int[] values, char[] shades, boolean showHorizontalLegend, boolean showVerticalLegend, String newline, DecimalFormat numericFormat, DecimalFormat percentFormat)

Method Detail

categoryback to summary
public @NotNull ChartFormat category(int newCategory)

The new category source column number, defaulting to 0.

Annotations
@NotNull
categoryback to summary
public int category()

The category source column number.

categoryAsTextback to summary
public @NotNull ChartFormat categoryAsText(boolean newCategoryAsText)

The new category as text value, defaulting to true.

Annotations
@NotNull
categoryAsTextback to summary
public boolean categoryAsText()

The category as text value.

dimensionsback to summary
public @NotNull ChartFormat dimensions(int newWidth, int newHeight)

The new chart dimensions, defaulting to 80 x 25.

Annotations
@NotNull
displayback to summary
public @NotNull ChartFormat display(ChartFormat.Display newDisplay)

The new display format, defaulting to Display#STACKED.

Annotations
@NotNull
displayback to summary
public @NotNull ChartFormat.Display display()

The display format.

Annotations
@NotNull
heightback to summary
public @NotNull ChartFormat height(int newHeight)

The new chart height, defaulting to 25.

Annotations
@NotNull
heightback to summary
public int height()

The chart height.

newlineback to summary
public @NotNull ChartFormat newline(String newNewline)

The new newline character, defaulting to \n.

Annotations
@NotNull
newlineback to summary
public @NotNull String newline()

The newline character.

Annotations
@NotNull
numericFormatback to summary
public @NotNull ChartFormat numericFormat(DecimalFormat newNumericFormat)

The new numeric format, defaulting to ###,###.00.

Annotations
@NotNull
numericFormatback to summary
public @NotNull DecimalFormat numericFormat()

The numeric format.

Annotations
@NotNull
outputback to summary
public @NotNull ChartFormat output(ChartFormat.Output newOutput)

The new output format, defaulting to Output#ASCII.

Annotations
@NotNull
outputback to summary
public @NotNull ChartFormat.Output output()

The output format.

Annotations
@NotNull
percentFormatback to summary
public @NotNull ChartFormat percentFormat(DecimalFormat newPercentFormat)

The new numeric format for percentages, defaulting to ###.00'%'.

Annotations
@NotNull
percentFormatback to summary
public @NotNull DecimalFormat percentFormat()

The numeric format for percentages.

Annotations
@NotNull
shadesback to summary
public @NotNull ChartFormat shades(char... newShades)

The new column shades, defaulting to { 'X' }.

Annotations
@NotNull
shadesback to summary
public @NotNull char[] shades()

The value column shades.

showHorizontalLegendback to summary
public @NotNull ChartFormat showHorizontalLegend(boolean newShowHorizontalLegend)

Whether to show the horizontal legend, defaulting to true.

Annotations
@NotNull
showHorizontalLegendback to summary
public boolean showHorizontalLegend()

Whether to show the horizontal legend.

showLegendsback to summary
public @NotNull ChartFormat showLegends(boolean newShowHorizontalLegend, boolean newShowVerticalLegend)

Whether to show legends, defaulting to true.

Annotations
@NotNull
showVerticalLegendback to summary
public @NotNull ChartFormat showVerticalLegend(boolean newShowVerticalLegend)

Whether to show the vertical legend, defaulting to true.

Annotations
@NotNull
showVerticalLegendback to summary
public boolean showVerticalLegend()

Whether to show the vertical legend.

typeback to summary
public @NotNull ChartFormat type(ChartFormat.Type newType)

The new chart type, defaulting to Type#AREA.

Annotations
@NotNull
typeback to summary
public @NotNull ChartFormat.Type type()
Annotations
@NotNull
valuesback to summary
public @NotNull ChartFormat values(int... newValues)

The new value source column numbers, defaulting to { 1 }.

Annotations
@NotNull
valuesback to summary
public @NotNull int[] values()

The value source column numbers.

widthback to summary
public @NotNull ChartFormat width(int newWidth)

The new chart width, defaulting to 80.

Annotations
@NotNull
widthback to summary
public int width()

The chart width.

org.jooq back to summary

public final Enum ChartFormat.Display

extends Enum<ChartFormat.Display>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ChartFormat.Display
DEFAULT

The areas are located in front of one another.

public static final ChartFormat.Display
HUNDRED_PERCENT_STACKED

The areas stack up to 100%.

public static final ChartFormat.Display
STACKED

The areas are stacked on top of one another.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ChartFormat.Display
public static ChartFormat.Display[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DEFAULTback to summary
public static final ChartFormat.Display DEFAULT

The areas are located in front of one another.

Annotations
@SuppressWarnings:hiding
HUNDRED_PERCENT_STACKEDback to summary
public static final ChartFormat.Display HUNDRED_PERCENT_STACKED

The areas stack up to 100%.

STACKEDback to summary
public static final ChartFormat.Display STACKED

The areas are stacked on top of one another.

Constructor Detail

Displayback to summary
private Display()

Method Detail

valueOfback to summary
public static ChartFormat.Display valueOf(String name)
valuesback to summary
public static ChartFormat.Display[] values()
org.jooq back to summary

public final Enum ChartFormat.Output

extends Enum<ChartFormat.Output>
Class Inheritance

The chart output format.

Field Summary

Modifier and TypeField and Description
public static final ChartFormat.Output
ASCII

An ASCII chart.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ChartFormat.Output
public static ChartFormat.Output[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ASCIIback to summary
public static final ChartFormat.Output ASCII

An ASCII chart.

Constructor Detail

Outputback to summary
private Output()

Method Detail

valueOfback to summary
public static ChartFormat.Output valueOf(String name)
valuesback to summary
public static ChartFormat.Output[] values()
org.jooq back to summary

public final Enum ChartFormat.Type

extends Enum<ChartFormat.Type>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ChartFormat.Type
AREA

An area chart.

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
public static ChartFormat.Type
public static ChartFormat.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AREAback to summary
public static final ChartFormat.Type AREA

An area chart.

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static ChartFormat.Type valueOf(String name)
valuesback to summary
public static ChartFormat.Type[] values()