org.apache.flink.table.utils.print

Class TableauStyle

java.lang.Object

org.apache.flink.table.utils.print.TableauStyle

All Implemented Interfaces:

PrintStyle

@Internal
public final class TableauStyle
extends Object
implements PrintStyle

Print the result and content as tableau form.

For example: (printRowKind is true)

 +----+-------------+---------+-------------+
 | op | boolean_col | int_col | varchar_col |
 +----+-------------+---------+-------------+
 | +I |        true |       1 |         abc |
 | -U |       false |       2 |         def |
 | +U |       false |       3 |         def |
 | -D |      <NULL> |  <NULL> |      <NULL> |
 +----+-------------+---------+-------------+
 4 rows in set
 

Field Summary

Fields inherited from interface org.apache.flink.table.utils.print.PrintStyle

DEFAULT_MAX_COLUMN_WIDTH, NULL_VALUE

Method Summary

Modifier and Type	Method and Description
int[]	getColumnWidths() Returns null if the column widths are not precomputed using the row type.
void	inferColumnWidth(List<String[]> rowData)
void	print(Iterator<RowData> it, PrintWriter printWriter) Displays the result.
void	printBorderLine(PrintWriter printWriter)
void	printColumnNamesTableauRow(PrintWriter printWriter)
void	printEmptyResult(Iterator<RowData> it, PrintWriter printWriter)
void	printFooter(PrintWriter printWriter, long numRows)
long	printTable(Iterator<RowData> it, PrintWriter printWriter) Print table with column names and borders.
void	printTableauRow(String[] cols, PrintWriter printWriter)
String[]	rowFieldsToString(RowData row)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.table.utils.print.PrintStyle

rawContent, tableauWithDataInferredColumnWidths, tableauWithDataInferredColumnWidths, tableauWithTypeInferredColumnWidths

Method Detail

getColumnWidths

@Nullable
public int[] getColumnWidths()

Returns null if the column widths are not precomputed using the row type.

print

public void print(Iterator<RowData> it,
                  PrintWriter printWriter)

Description copied from interface: PrintStyle

Displays the result.

Specified by:

print in interface PrintStyle

Parameters:

it - The iterator for the data to print

printWriter - The writer to write to

printEmptyResult

public void printEmptyResult(Iterator<RowData> it,
                             PrintWriter printWriter)

printTable

public long printTable(Iterator<RowData> it,
                       PrintWriter printWriter)

Print table with column names and borders.

Returns:

the row number printed in the table

printFooter

public void printFooter(PrintWriter printWriter,
                        long numRows)

inferColumnWidth

public void inferColumnWidth(List<String[]> rowData)

rowFieldsToString

public String[] rowFieldsToString(RowData row)

printColumnNamesTableauRow

public void printColumnNamesTableauRow(PrintWriter printWriter)

printTableauRow

public void printTableauRow(String[] cols,
                            PrintWriter printWriter)

printBorderLine

public void printBorderLine(PrintWriter printWriter)