Package cdc.impex.templates

Class ColumnTemplate<T>

java.lang.Object

cdc.impex.templates.ColumnTemplate<T>

Type Parameters:

T - The column data type.

public final class ColumnTemplate<T>
extends Object

Description of a template column.

A column is described by:

• A name
• A Usage.
• A data type.
• An optional default value.
• An optional description.
  It is used when sample files are generated.
• An optional Checker.
  It can be used to add more checks to data type, for example, to check the length of string, the domain of a number, ...
• The severity of a failed check.
• A string to data type converter.
• A data type to string converter.
• An optional Content Validation type.
• An optional Content Validation operator.
• An optional list of Content Validation values.

WARNING: content validation should be compliant with data type and checker.

If data type is a primitive or enum data type, default content validation data are automatically set.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ColumnTemplate.Builder<T>

Method Summary

Modifier and Type	Method	Description
static <T> ColumnTemplate.Builder<T>	builder(ColumnTemplate<T> model)	Creates a new Builder initialized from a Template.
static <T> ColumnTemplate.Builder<T>	builder(Class<T> dataType)	Creates an empty new Builder.
static <T> ColumnTemplate.Builder<T>	builder(String name, ColumnTemplate<T> model)	Deprecated, for removal: This API element is subject to removal in a future version.
static <T> ColumnTemplate.Builder<T>	builder(String name, Class<T> dataType)	Deprecated, for removal: This API element is subject to removal in a future version.
cdc.validation.checkers.Checker<T>	getCheckerOrNull()
cdc.issues.IssueSeverity	getCheckFailureSeverity()
String	getComment()
cdc.office.ss.ContentValidation.Operator	getContentValidationOperator()
cdc.office.ss.ContentValidation.Type	getContentValidationType()
List<String>	getContentValidationValues()
Class<T>	getDataType()
T	getDef()
String	getDescription()
Function<T,String>	getExportConverter()
Function<String,T>	getImportConverter()
String	getName()
Primitive	getPrimitive()
Usage	getUsage()
boolean	hasChecker()
ColumnTemplate.Builder<T>	newBuilder()
ColumnTemplate.Builder<T>	newBuilder(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns:

The column name.

getUsage

public Usage getUsage()

Returns:

The column usage.

getDataType

public Class<T> getDataType()

Returns:

The column data type.

getDef

public T getDef()

Returns:

The column default value.

getPrimitive

public Primitive getPrimitive()

Returns:

The Primitive type of this column, or null.

getDescription

public String getDescription()

Returns:

The column description.

getCheckerOrNull

public cdc.validation.checkers.Checker<T> getCheckerOrNull()

Returns:

The checker or null.

hasChecker

public boolean hasChecker()

getCheckFailureSeverity

public cdc.issues.IssueSeverity getCheckFailureSeverity()

Returns:

The severity of a check failure.

getImportConverter

public Function<String,T> getImportConverter()

Returns:

the converter used to convert a string to data type.

getExportConverter

public Function<T,String> getExportConverter()

Returns:

the converter used to convert a data type to a string.

getComment

public String getComment()

Returns:

The comment that should be used to describe this column.

getContentValidationType

public cdc.office.ss.ContentValidation.Type getContentValidationType()

Returns:

The content validation type.

getContentValidationOperator

public cdc.office.ss.ContentValidation.Operator getContentValidationOperator()

Returns:

The content validation operator.

getContentValidationValues

public List<String> getContentValidationValues()

Returns:

The content validation values.

toString

public String toString()

Overrides:

toString in class Object

newBuilder

public ColumnTemplate.Builder<T> newBuilder()

Returns:

A new Builder initialized with data from this Template.

builder

public static <T> ColumnTemplate.Builder<T> builder(Class<T> dataType)

Creates an empty new Builder.

Type Parameters:

T - The data type.

Parameters:

dataType - The data class.

Returns:

A new Builder typed with dataType.

builder

public static <T> ColumnTemplate.Builder<T> builder(ColumnTemplate<T> model)

Creates a new Builder initialized from a Template.

Type Parameters:

T - The data type.

Parameters:

model - The Template model.

Returns:

A new Builder initialized with model.

builder

@Deprecated(since="2022-11-11",
            forRemoval=true)
public static <T> ColumnTemplate.Builder<T> builder(String name,
                                                    Class<T> dataType)

Deprecated, for removal: This API element is subject to removal in a future version.

builder

@Deprecated(since="2022-11-11",
            forRemoval=true)
public static <T> ColumnTemplate.Builder<T> builder(String name,
                                                    ColumnTemplate<T> model)

Deprecated, for removal: This API element is subject to removal in a future version.

newBuilder

@Deprecated(since="2022-11-11",
            forRemoval=true)
public ColumnTemplate.Builder<T> newBuilder(String name)

Deprecated, for removal: This API element is subject to removal in a future version.