org.virtualrepository.csv

Class CsvAsset

java.lang.Object

org.virtualrepository.impl.PropertyHolder

org.virtualrepository.impl.AbstractAsset

org.virtualrepository.csv.CsvAsset

All Implemented Interfaces:

Asset, Described, MutableAsset

Direct Known Subclasses:

CsvCodelist

public class CsvAsset
extends AbstractAsset

Partial implementation of an Asset available in the CSV format.

Author:

Fabio Simeoni

Field Summary

Fields

Modifier and Type	Field and Description
static char	defaultDelimiter
static String	defaultEncoding
static boolean	defaultHeader
static char	defaultQuote
static long	defaultRows
static Type<CsvAsset>	type The generic type of CsvAssets.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CsvAsset(String name, RepositoryService service, Property... properties) Creates an instance with a given name, target service, and properties.
	CsvAsset(String id, String name, Property... properties) Creates an instance with a given identifier, name, and properties.
	CsvAsset(String name, String id, RepositoryService service, Property... properties) Creates an instance with a given identifier, name, target service, and properties.
protected	CsvAsset(Type<T> type, String name, RepositoryService service, Property... properties) Creates an instance with a given type, name, target service, and properties.
protected	CsvAsset(Type<T> type, String id, String name, Property... properties) Creates an instance with a given type, identifier, name, and properties.
protected	CsvAsset(Type<T> type, String id, String name, RepositoryService service, Property... properties) Creates an instance with a given type, identifier, name, target service, and properties.

Method Summary

Methods

Modifier and Type	Method and Description
List<Column>	columns() Returns the columns of this asset.
char	delimiter() Returns the delimiter character used in the content of this asset (by default a comma, ,).
Charset	encoding() Returns the encoding of the content of this asset (by default UTF-8).
boolean	equals(Object obj)
int	hashCode()
boolean	hasHeader() Indicates whether the content of this asset has a header row (by default false).
void	hasHeader(boolean header) Indicates whether the content of this asset has a header row, overriding the default (false).
char	quote() Returns the quote character used in the content of this asset (by default a quotation mark, ").
Long	rows() Returns the number of rows in the content of this asset.
void	setColumns(Column... columns) Sets the columns of this asset.
void	setDelimiter(char delimiter) Sets the delimiter character used in the content of this asset, overwriting the default (a comma, ,).
void	setEncoding(Charset encoding) Sets the encoding of the content of this asset, overriding the default (UTF-8).
void	setQuote(char quote) Sets the quote character used in the content of this asset, overriding the default (a quotation mark, ").
void	setRows(long rows) Sets the number of rows in the content of this asset.
String	toString()

Methods inherited from class org.virtualrepository.impl.AbstractAsset

id, name, service, setService, type

Methods inherited from class org.virtualrepository.impl.PropertyHolder

properties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.virtualrepository.impl.Described

properties

Field Detail

defaultDelimiter

public static final char defaultDelimiter

See Also:

Constant Field Values

defaultQuote

public static final char defaultQuote

See Also:

Constant Field Values

defaultEncoding

public static final String defaultEncoding

See Also:

Constant Field Values

defaultHeader

public static final boolean defaultHeader

See Also:

Constant Field Values

defaultRows

public static final long defaultRows

See Also:

Constant Field Values

type

public static final Type<CsvAsset> type

The generic type of CsvAssets.

Constructor Detail

CsvAsset

protected CsvAsset(Type<T> type,
        String id,
        String name,
        Property... properties)

Creates an instance with a given type, identifier, name, and properties.

Inherit as a plugin-facing constructor for asset discovery and retrieval purposes.

Parameters:

type - the type

id - the identifier

name - the name

properties - the properties

CsvAsset

public CsvAsset(String id,
        String name,
        Property... properties)

Creates an instance with a given identifier, name, and properties.

A plugin-facing constructor for asset discovery and retrieval.

Parameters:

id - the identifier

name - the name

properties - the properties

CsvAsset

protected CsvAsset(Type<T> type,
        String id,
        String name,
        RepositoryService service,
        Property... properties)

Creates an instance with a given type, identifier, name, target service, and properties.

Inherit as a client-facing constructor for asset publication with services that allow client-defined identifiers.

Parameters:

type - the type

id - the identifier

name - the name

service - the target service

properties - the properties

CsvAsset

protected CsvAsset(Type<T> type,
        String name,
        RepositoryService service,
        Property... properties)

Creates an instance with a given type, name, target service, and properties.

Inherit as a client-facing constructor for asset publication with services that do now allow client-defined identifiers, or else that force services to generate identifiers.

Parameters:

type - the type

name - the name

service - the target service

properties - the properties

CsvAsset

public CsvAsset(String name,
        RepositoryService service,
        Property... properties)

Creates an instance with a given name, target service, and properties.

Use for asset publication with services that do now allow client-defined identifiers, or else that force services to generate identifiers.

Parameters:

name - the name

service - the target service

properties - the properties

CsvAsset

public CsvAsset(String name,
        String id,
        RepositoryService service,
        Property... properties)

Creates an instance with a given identifier, name, target service, and properties.

Use for asset publication with services that allow client-defined identifiers.

Parameters:

id - the identifier

name - the name

service - the target service

properties - the properties

Method Detail

delimiter

public char delimiter()

Returns the delimiter character used in the content of this asset (by default a comma, ,).

Returns:

the delimiter character

setDelimiter

public void setDelimiter(char delimiter)

Sets the delimiter character used in the content of this asset, overwriting the default (a comma, ,).

Parameters:

delimiter - the delimiter character

quote

public char quote()

Returns the quote character used in the content of this asset (by default a quotation mark, ").

Returns:

the quote character

setQuote

public void setQuote(char quote)

Sets the quote character used in the content of this asset, overriding the default (a quotation mark, ").

Parameters:

quote - the quote character

hasHeader

public boolean hasHeader()

Indicates whether the content of this asset has a header row (by default false).

Returns:

true if the content of this asset has a header row

hasHeader

public void hasHeader(boolean header)

Indicates whether the content of this asset has a header row, overriding the default (false).

Parameters:

header - true if the content of this asset has a header row

encoding

public Charset encoding()

Returns the encoding of the content of this asset (by default UTF-8).

Returns:

the encoding of the content of this asset

setEncoding

public void setEncoding(Charset encoding)

Sets the encoding of the content of this asset, overriding the default (UTF-8).

Parameters:

encoding - the encoding

columns

public List<Column> columns()

Returns the columns of this asset.

Returns:

the columns, in an immutable collection

setRows

public void setRows(long rows)

Sets the number of rows in the content of this asset.

Parameters:

rows - the number of rows

rows

public Long rows()

Returns the number of rows in the content of this asset.

Returns:

the number of rows

setColumns

public void setColumns(Column... columns)

Sets the columns of this asset.

Parameters:

cols - the columns

toString

public String toString()

Overrides:

toString in class AbstractAsset

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAsset

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAsset