Package cdc.impex.templates

Class SheetTemplate

java.lang.Object

cdc.impex.templates.SheetTemplate

public final class SheetTemplate
extends Object

Description of a sheet template.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SheetTemplate.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ACTION_COLUMN_NAME
static Comparator<SheetTemplate>	DOMAIN_NAME_COMPARATOR

Method Summary

Modifier and Type	Method	Description
static SheetTemplate.Builder	builder()
static SheetTemplate.Builder	builder(SheetTemplate model)
boolean	containsColumn(String name)	Returns true if this sheet template contains a column with a particular name.
ColumnTemplate<ImportAction>	getActionColumn()
String	getActionColumnName()
ColumnTemplate<?>	getColumn(String name)	Returns the column that has a given name.
List<String>	getColumnNames()
List<String>	getColumnNames(Usage usage)	Returns a list of column names that match a usage.
List<ColumnTemplate<?>>	getColumns()
List<ColumnTemplate<?>>	getColumns(Usage usage)
String	getDescription()
String	getDomain()
String	getName()
String	getQName()
boolean	isActionColumn(ColumnTemplate<?> column)
SheetTemplate.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACTION_COLUMN_NAME

public static final String DEFAULT_ACTION_COLUMN_NAME

See Also:

Constant Field Values

DOMAIN_NAME_COMPARATOR

public static final Comparator<SheetTemplate> DOMAIN_NAME_COMPARATOR

Method Detail

getDomain

public String getDomain()

Returns:

The template domain.

getName

public String getName()

Returns:

The template name.

getQName

public String getQName()

getDescription

public String getDescription()

getActionColumnName

public String getActionColumnName()

Returns:

The name of the action column.

getActionColumn

public ColumnTemplate<ImportAction> getActionColumn()

isActionColumn

public boolean isActionColumn(ColumnTemplate<?> column)

getColumns

public List<ColumnTemplate<?>> getColumns()

Returns:

The template columns.

getColumns

public List<ColumnTemplate<?>> getColumns(Usage usage)

getColumnNames

public List<String> getColumnNames()

Returns:

The template column names.

getColumnNames

public List<String> getColumnNames(Usage usage)

Returns a list of column names that match a usage.

Parameters:

usage - The usage.

Returns:

A list of column names that match usage.

getColumn

public ColumnTemplate<?> getColumn(String name)

Returns the column that has a given name.

Parameters:

name - The name.

Returns:

The column that is named name.

Throws:

IllegalArgumentException - When no column named name is found.

containsColumn

public boolean containsColumn(String name)

Returns true if this sheet template contains a column with a particular name.

Parameters:

name - The name.

Returns:

true if this sheet template contains a column names name.

newBuilder

public SheetTemplate.Builder newBuilder()

toString

public String toString()

Overrides:

toString in class Object

builder

public static SheetTemplate.Builder builder()

builder

public static SheetTemplate.Builder builder(SheetTemplate model)