Package net.tangly.gleam.model

Record Class TsvEntity<T>

java.lang.Object

java.lang.Record

net.tangly.gleam.model.TsvEntity<T>

Type Parameters:

T - class of the entity

Record Components:

clazz - class of the entity

fields - fields of the entity with the mapping rules

imports - import factory function to create a new instance of the class with values of the CSV record

exports - export factory method to create a CSV record for an instance of the clas

public record TsvEntity<T>(Class<T> clazz, List<TsvProperty<T,?>> fields, Function<org.apache.commons.csv.CSVRecord,T> imports, BiConsumer<T,org.apache.commons.csv.CSVPrinter> exports)
extends Record

Defines an entity mapped to a row of TSV values written to a TSV file.

A special case is if the entity is owned through one to multiple relation. The reference to the owner is stored in the TSV file. The extraction process returns a tuple with the the entity and the identifier of the owner.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OWNER_FOID

Constructor Summary

Constructors

Constructor	Description
TsvEntity(Class<T> clazz, List<TsvProperty<T,?>> fields, Function<org.apache.commons.csv.CSVRecord,T> imports, BiConsumer<T,org.apache.commons.csv.CSVPrinter> exports)	Creates an instance of a TsvEntity record class.

Method Summary

Modifier and Type	Method	Description
Class<T>	clazz()	Returns the value of the clazz record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	exportRelation(@NotNull TsvRelation<T> relation, @NotNull org.apache.commons.csv.CSVPrinter printer)	Export the relation to the TSV file.
BiConsumer<T,org.apache.commons.csv.CSVPrinter>	exports()	Returns the value of the exports record component.
void	exports(T entity, @NotNull org.apache.commons.csv.CSVPrinter printer)	Export an entity as a row in a TSV file.
List<TsvProperty<T,?>>	fields()	Returns the value of the fields record component.
static String	get(@NotNull org.apache.commons.csv.CSVRecord csv, @NotNull String column)
final int	hashCode()	Returns a hash code value for this object.
List<String>	headers()	Return the ordered list of column header names for the TSV record header.
TsvRelation<T>	importRelation(@NotNull org.apache.commons.csv.CSVRecord record)
Function<org.apache.commons.csv.CSVRecord,T>	imports()	Returns the value of the imports record component.
T	imports(@NotNull org.apache.commons.csv.CSVRecord record)	Import an entity from a TSV record.
static <T> TsvEntity<T>	of(Class<T> clazz, List<TsvProperty<T,?>> properties, Function<org.apache.commons.csv.CSVRecord,T> imports)	Defines an entity for a class with a set of property and a function creating an instance of the class with values from the CSV record.
static <T> TsvEntity<T>	of(Class<T> clazz, List<TsvProperty<T,?>> properties, Supplier<T> factory)	Defines an entity with a default constructor and no special mapping rules to CSV record.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

OWNER_FOID

public static final String OWNER_FOID

See Also:

• Constant Field Values

Constructor Details

TsvEntity

public TsvEntity(Class<T> clazz,
 List<TsvProperty<T,?>> fields,
 Function<org.apache.commons.csv.CSVRecord,T> imports,
 BiConsumer<T,org.apache.commons.csv.CSVPrinter> exports)

Creates an instance of a TsvEntity record class.

Parameters:

clazz - the value for the clazz record component

fields - the value for the fields record component

imports - the value for the imports record component

exports - the value for the exports record component

Method Details

of

public static <T> TsvEntity<T> of(Class<T> clazz,
 List<TsvProperty<T,?>> properties,
 Supplier<T> factory)

Defines an entity with a default constructor and no special mapping rules to CSV record. The class is a standard Java POJO.

Type Parameters:

T - type of the class to import from or export to a TSV file.

Parameters:

clazz - class of the entity

properties - properties of the entity

factory - default constructor method of the class

Returns:

a new instance of the class

of

public static <T> TsvEntity<T> of(Class<T> clazz,
 List<TsvProperty<T,?>> properties,
 Function<org.apache.commons.csv.CSVRecord,T> imports)

Defines an entity for a class with a set of property and a function creating an instance of the class with values from the CSV record. This approach is often used for records. Records only provides constructors with all properties as parameters. The second case is when the class constructor takes internal or external identifier as parameters.

Type Parameters:

T - type of the class to import from or export to a TSV file.

Parameters:

clazz - class of the entity

properties - properties of the entity

imports - factory method to create an instance of the class with some of the CSV record values.

Returns:

a new instance of the class

get

public static String get(@NotNull
 @NotNull org.apache.commons.csv.CSVRecord csv,
 @NotNull
 @NotNull String column)

headers

public List<String> headers()

Return the ordered list of column header names for the TSV record header.

Returns:

an ordered list of column header names for the TSV record header

exports

public void exports(T entity,
 @NotNull
 @NotNull org.apache.commons.csv.CSVPrinter printer)

Export an entity as a row in a TSV file. Upon completion of the export, the caller shall call. If defined, the export lambda is executed; otherwise the exports lambdas for all fields are executed. The exclusive operation modes are due to the constraints of the underlying CSV Apache Commons library.

Parameters:

entity - entity to be exported as TSV record. The value can be null

printer - printer to write TSV record

exportRelation

public void exportRelation(@NotNull
 @NotNull TsvRelation<T> relation,
 @NotNull
 @NotNull org.apache.commons.csv.CSVPrinter printer)

Export the relation to the TSV file. First, the owner identifier is written in the first column having the header OWNER_FOID. Second. the referenced entity is written to the TSV record.

Parameters:

relation - relation to export

printer - target TSV file

imports

public T imports(@NotNull
 @NotNull org.apache.commons.csv.CSVRecord record)

Import an entity from a TSV record. First if defined the imports lambda is executed otherwise the factory is used to create a new Java domain object. When all fields with a defined setter will have their imports lambda executed.

Parameters:

record - TSV record containing the TSV representation of the entity

Returns:

entity base on the TSV record

importRelation

public TsvRelation<T> importRelation(@NotNull
 @NotNull org.apache.commons.csv.CSVRecord record)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

clazz

public Class<T> clazz()

Returns the value of the clazz record component.

Returns:

the value of the clazz record component

fields

public List<TsvProperty<T,?>> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

imports

public Function<org.apache.commons.csv.CSVRecord,T> imports()

Returns the value of the imports record component.

Returns:

the value of the imports record component

exports

public BiConsumer<T,org.apache.commons.csv.CSVPrinter> exports()

Returns the value of the exports record component.

Returns:

the value of the exports record component