cn.sissors.hummingbird.collect.container

Class CSVTableContainer<R,C,V>

java.lang.Object

cn.sissors.hummingbird.collect.TableContainer<R,C,V>

cn.sissors.hummingbird.collect.container.CSVTableContainer<R,C,V>

All Implemented Interfaces:

Serializable, Cloneable

public class CSVTableContainer<R,C,V>
extends TableContainer<R,C,V>

The table container organized under csv format which can be persisted to a csv table and loaded data from csv file.

Version:

2018-10-12

Author:

zyz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CSVTableContainer()
CSVTableContainer(Class<R> ROW_TYPE, Class<C> COLUMN_TYPE, Class<V> VALUE_TYPE)
CSVTableContainer(String headerName)
CSVTableContainer(String headerName, Class<R> ROW_TYPE, Class<C> COLUMN_TYPE, Class<V> VALUE_TYPE)

Method Summary

Modifier and Type	Method and Description
CSVTableContainer<R,C,V>	load(@NotNull String path) Load data from external storage into container.
String	LOCAL_STORAGE_DIR() Get local directory to store container.
String	NEW_LINE() Get the new line character used in csv format file.
CSVTableContainer<R,C,V>	NEW_LINE(String NEW_LINE) Set new line character.
void	persist(@NotNull String path) Persist container data to external permanent storage.
String	SEPARATOR() Get the separator used in csv format file.
CSVTableContainer<R,C,V>	SEPARATOR(String SEPARATOR) Set separator character.
CSVTableContainer<R,C,V>	setColumnType(Class<C> COLUMN_TYPE)
CSVTableContainer<R,C,V>	setRowType(Class<R> ROW_TYPE)
CSVTableContainer<R,C,V>	setValueType(Class<V> VALUE_TYPE)

Methods inherited from class cn.sissors.hummingbird.collect.TableContainer

clean, clone, columnKeys, columnMap, CONTAINER_COUNT, filter, get, getHeaderName, merge, NULL_CHARACTER_DISPLAY, NULL_CHARACTER_DISPLAY, print, print, push, rowKeys, rowMap, setHeaderName, singleColumn, singleRow, sort

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVTableContainer

public CSVTableContainer()

CSVTableContainer

public CSVTableContainer(String headerName)

CSVTableContainer

public CSVTableContainer(Class<R> ROW_TYPE,
                         Class<C> COLUMN_TYPE,
                         Class<V> VALUE_TYPE)

CSVTableContainer

public CSVTableContainer(String headerName,
                         Class<R> ROW_TYPE,
                         Class<C> COLUMN_TYPE,
                         Class<V> VALUE_TYPE)

Method Detail

SEPARATOR

@Contract(pure=true)
public String SEPARATOR()

Get the separator used in csv format file.

DEFAULT: |

Returns:

separator

NEW_LINE

@Contract(pure=true)
public String NEW_LINE()

Get the new line character used in csv format file.

DEFAULT: \r\n

Returns:

new line character

LOCAL_STORAGE_DIR

@Contract(pure=true)
public String LOCAL_STORAGE_DIR()

Get local directory to store container.

Returns:

local directory

persist

public void persist(@NotNull
                    @NotNull String path)
             throws DataPersistenceException

Persist container data to external permanent storage.

For different separators, set it through SEPARATOR(String).

For different new line character under different systems, set it through NEW_LINE(String).

The pattern for remote path is "user.password@host:port:path-to-file.csv".

e.g.

1. hadoop.123@master:22:~/csv-data/result.csv

2. hadoop@master:~/csv-data/result.csv (with no password and default port 22)

Specified by:

persist in class TableContainer<R,C,V>

Parameters:

path - external storage path

Throws:

DataPersistenceException - error appearance such as IOException and so on

load

public CSVTableContainer<R,C,V> load(@NotNull
                                     @NotNull String path)
                              throws DataLoadingException

Load data from external storage into container.

Notice: set row, column and value types first before calling this method.

The three types of row, column and value, abbreviated as R, C and V, are requested for supporting by PARSERS or implementing the Parsable interface.

The pattern for remote path is "user.password@host:port:path-to-file.csv".

e.g.

1. hadoop.123@master:22:~/csv-data/result.csv

2. hadoop@master:~/csv-data/result.csv (with no password and default port 22)

Specified by:

load in class TableContainer<R,C,V>

Parameters:

path - external storage path

Returns:

the container that has been loaded

Throws:

DataLoadingException - error appearance such as IOException, IllegalValueTypeException and so on

setRowType

public CSVTableContainer<R,C,V> setRowType(Class<R> ROW_TYPE)

setColumnType

public CSVTableContainer<R,C,V> setColumnType(Class<C> COLUMN_TYPE)

setValueType

public CSVTableContainer<R,C,V> setValueType(Class<V> VALUE_TYPE)

SEPARATOR

public CSVTableContainer<R,C,V> SEPARATOR(String SEPARATOR)

Set separator character.

Parameters:

SEPARATOR - separator character

Returns:

current container

NEW_LINE

public CSVTableContainer<R,C,V> NEW_LINE(String NEW_LINE)

Set new line character.

Parameters:

NEW_LINE - new line character

Returns:

current container