/flip-tables

Because pretty-printing text tables in Java should be easy.

Primary LanguageJavaApache License 2.0Apache-2.0

Flip Tables

Because pretty-printing text tables in Java should be easy.

(╯°□°）╯︵ ┻━┻

Usage

A FlipTable requires headers and data in string form:

String[] headers = { "Test", "Header" };
String[][] data = {
    { "Foo", "Bar" },
    { "Kit", "Kat" },
};
System.out.println(FlipTable.of(headers, data));
╔══════╤════════╗
║ Test │ Header ║
╠══════╪════════╣
║ Foo  │ Bar    ║
╟──────┼────────╢
║ Kit  │ Kat    ║
╚══════╧════════╝

They can be empty:

String[] headers = { "Test", "Header" };
String[][] data = {};
System.out.println(FlipTable.of(headers, data));
╔══════╤════════╗
║ Test │ Header ║
╠══════╧════════╣
║ (empty)       ║
╚═══════════════╝

Newlines are supported:

String[] headers = { "One Two\nThree", "Four" };
String[][] data = { { "Five", "Six\nSeven Eight" } };
System.out.println(FlipTable.of(headers, data));
╔═════════╤═════════════╗
║ One Two │ Four        ║
║ Three   │             ║
╠═════════╪═════════════╣
║ Five    │ Six         ║
║         │ Seven Eight ║
╚═════════╧═════════════╝

Which means tables can be nested:

String[] innerHeaders = { "One", "Two" };
String[][] innerData = { { "1", "2" } };
String inner = FlipTable.of(innerHeaders, innerData);
String[] headers = { "Left", "Right" };
String[][] data = { { inner, inner } };
System.out.println(FlipTable.of(headers, data));
╔═══════════════╤═══════════════╗
║ Left          │ Right         ║
╠═══════════════╪═══════════════╣
║ ╔═════╤═════╗ │ ╔═════╤═════╗ ║
║ ║ One │ Two ║ │ ║ One │ Two ║ ║
║ ╠═════╪═════╣ │ ╠═════╪═════╣ ║
║ ║ 1   │ 2   ║ │ ║ 1   │ 2   ║ ║
║ ╚═════╧═════╝ │ ╚═════╧═════╝ ║
╚═══════════════╧═══════════════╝

Helper methods convert from types like lists:

List<Person> people = Arrays.asList(new Person("Foo", "Bar"), new Person("Kit", "Kat"));
System.out.println(FlipTableConverters.fromIterable(people, Person.class));
╔═══════════╤══════════╗
║ FirstName │ LastName ║
╠═══════════╪══════════╣
║ Foo       │ Bar      ║
╟───────────┼──────────╢
║ Kit       │ Kat      ║
╚═══════════╧══════════╝

Or a database result:

ResultSet resultSet = statement.executeQuery("SELECT first_name, last_name FROM users");
System.out.println(FlipTableConverters.fromResultSet(resultSet));
╔════════════╤═══════════╗
║ first_name │ last_name ║
╠════════════╪═══════════╣
║ Jake       │ Wharton   ║
╟────────────┼───────────╢
║ Edward     │ Snowden   ║
╚════════════╧═══════════╝

Arbitrary objects are also supported:

String[] headers = { "First Name", "Last Name", "Age", "Type" };
Object[][] data = {
    { "Big", "Bird", 16, PersonType.COSTUME },
    { "Joe", "Smith", 42, PersonType.HUMAN },
    { "Oscar", "Grouchant", 8, PersonType.PUPPET }
};
System.out.println(FlipTableConverters.fromObjects(headers, data));
╔════════════╤═══════════╤═════╤═════════╗
║ First Name │ Last Name │ Age │ Type    ║
╠════════════╪═══════════╪═════╪═════════╣
║ Big        │ Bird      │ 16  │ COSTUME ║
╟────────────┼───────────┼─────┼─────────╢
║ Joe        │ Smith     │ 42  │ HUMAN   ║
╟────────────┼───────────┼─────┼─────────╢
║ Oscar      │ Grouchant │ 8   │ PUPPET  ║
╚════════════╧═══════════╧═════╧═════════╝

TableFormat

There are two available TableFormats.

DefaultTableFormat

System.out.println(FlipTable.of(headers, data));

OR

System.out.println(FlipTable.of(new DefaultTableFormat(), headers, data));

╔══════╤════════╗
║ Test │ Header ║
╠══════╪════════╣
║ Foo  │ Bar    ║
╟──────┼────────╢
║ Kit  │ Kat    ║
╚══════╧════════╝

AsciiTableFormat

System.out.println(FlipTable.of(new AsciiTableFormat(), headers, data));

+======+========+
| Test | Header |
|======|========|
| Foo  | Bar    |
|------|--------|
| Kit  | Kat    |
+------+--------+

# 中文，网页显示不正常是由于字体问题，请使用控制台并使用等宽字体可以显示正常！
+====================================================================================================================+====================================================================================================================+
| Left中文                                                                                                           | Right                                                                                                              |
|====================================================================================================================|====================================================================================================================|
| +============================================================================================+===================+ | +============================================================================================+===================+ |
| | One                                                                                        | Two               | | | One                                                                                        | Two               | |
| |============================================================================================|===================| | |============================================================================================|===================| |
| | 1                                                                                          | 2中文             | | | 1                                                                                          | 2中文             | |
| |--------------------------------------------------------------------------------------------|-------------------| | |--------------------------------------------------------------------------------------------|-------------------| |
| | 1 这是很长的中文，非常长非常长非常长非常长非常长非常长非常长非常长非常长非常长非常长非常长 | 2 This is english | | | 1 这是很长的中文，非常长非常长非常长非常长非常长非常长非常长非常长非常长非常长非常长非常长 | 2 This is english | |
| +--------------------------------------------------------------------------------------------+-------------------+ | +--------------------------------------------------------------------------------------------+-------------------+ |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+

Download

Download the latest jar or reference on Maven central as com.jakewharton.fliptables:fliptables:1.0.2.

Snapshots of the development version are available in Sonatype's snapshots repository.

Tips

This version is not merged into the master branch. so, you can download this source to include your project~

License

Copyright 2014 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Other tables

等宽支持

  • 这个在Windows是重灾区，请使用AsciiTableFormat解决

中文等宽支持