Package cdc.impex.imports

Interface ImportRow

public interface ImportRow

Definition of an import row.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERASE

Method Summary

Modifier and Type	Method	Description
boolean	canBeProcessed()
ImportAction	getAction()
default <T> T	getData(ColumnTemplate<T> column, T def)	Returns the data associated to a column or a default value.
default <T> T	getData(Class<T> cls, String name, T def)	Returns the data associated to a column or a default value.
default Object	getData(String name, Object def)	Returns the data associated to a column or a default value.
default <T> T	getDataOrDef(ColumnTemplate<T> column)	Returns the data associated to a column or the column default value.
default <T> T	getDataOrNull(ColumnTemplate<T> column)	Returns the data associated to a column or null.
<T> T	getDataOrNull(Class<T> cls, String name)	Returns the data associated to a column or null.
Object	getDataOrNull(String name)	Returns the data associated to a column or null.
List<cdc.issues.Issue>	getIssues()
cdc.issues.locations.WorkbookLocation	getLocation()
int	getNumber()	Returns the number (1-based) of this row.
String	getRawDataOrNull(String name)	Returns the raw data associated to a column or null.
String	getSheetName()
String	getSystemId()
SheetTemplate	getTemplate()
boolean	isEmpty()
default boolean	isErase(ColumnTemplate<?> column)	Returns true if the data associated to column must be erased.
boolean	isErase(String name)	Returns true if the data associated to column must be erased.

Field Detail

ERASE

static final String ERASE

See Also:

Constant Field Values

Method Detail

getSystemId

String getSystemId()

Returns:

The systemId of the imported data.

getSheetName

String getSheetName()

Returns:

The sheet name of the imported row.

getTemplate

SheetTemplate getTemplate()

Returns:

The associated template.

getNumber

int getNumber()

Returns the number (1-based) of this row.

The first data row should start at 2.

Returns:

The row number (1-based).

getAction

ImportAction getAction()

Returns:

The action to be taken for this row.

isErase

boolean isErase(String name)

Returns true if the data associated to column must be erased.

Parameters:

name - The column name.

Returns:

true if the data associated to column named name must be erased.

isErase

default boolean isErase(ColumnTemplate<?> column)

Returns true if the data associated to column must be erased.

Parameters:

column - The column.

Returns:

true if the data associated to column must be erased.

getRawDataOrNull

String getRawDataOrNull(String name)

Returns the raw data associated to a column or null.

Parameters:

name - The column name.

Returns:

The raw data associated to column named name or null.

getDataOrNull

Object getDataOrNull(String name)

Returns the data associated to a column or null.

If data must be erased, null is returned.

Parameters:

name - The column name.

Returns:

The data associated to column named name or null.

getData

default Object getData(String name,
                       Object def)

Returns the data associated to a column or a default value.

If data must be erased, the default value def is returned.

Parameters:

name - The column name.

def - The default value.

Returns:

The data associated to column named name or def.

getDataOrNull

<T> T getDataOrNull(Class<T> cls,
                    String name)

Returns the data associated to a column or null.

WARNING: if data must be erased, null is returned.

Type Parameters:

T - The result type.

Parameters:

cls - The result class.

name - The column name.

Returns:

The data associated to column named name or null.

Throws:

ClassCastException - When the associated data can not be converted to cls

getData

default <T> T getData(Class<T> cls,
                      String name,
                      T def)

Returns the data associated to a column or a default value.

WARNING: if data must be erased, the default value def is returned.

Type Parameters:

T - The result type.

Parameters:

cls - The result class.

name - The column name.

def - The default value.

Returns:

The data associated to column named name or def.

Throws:

ClassCastException - When the associated data can not be converted to cls

getDataOrNull

default <T> T getDataOrNull(ColumnTemplate<T> column)

Returns the data associated to a column or null.

WARNING: if data must be erased, null is returned.

Type Parameters:

T - The result type.

Parameters:

column - The column.

Returns:

The data associated to column or null.

Throws:

ClassCastException - When the associated data can not be converted to column data type.

getData

default <T> T getData(ColumnTemplate<T> column,
                      T def)

Returns the data associated to a column or a default value.

WARNING: if data must be erased, the default value def is returned.

Type Parameters:

T - The result type.

Parameters:

column - The column.

def - The default value.

Returns:

The data associated to column or def.

Throws:

ClassCastException - When the associated data can not be converted to column data type.

getDataOrDef

default <T> T getDataOrDef(ColumnTemplate<T> column)

Returns the data associated to a column or the column default value.

WARNING: if data must be erased, the column default value is returned.

Type Parameters:

T - The result type.

Parameters:

column - The column.

Returns:

The data associated to column or the column default value (ColumnTemplate.getDef()).

getIssues

List<cdc.issues.Issue> getIssues()

Returns:

The issues associated to this row.

canBeProcessed

boolean canBeProcessed()

Returns:

true if this row can be processed.
There are no CRITICAL (or more severe) issues.

isEmpty

boolean isEmpty()

Returns:

true if this row is empty. This may happen when rows are removed from a sheet.

getLocation

cdc.issues.locations.WorkbookLocation getLocation()

Returns:

The location corresponding to this row.