Package cdc.impex.templates

Class Usage

java.lang.Object

cdc.impex.templates.Usage

public final class Usage
extends Object

Definition for each ImportAction of the expected presence of data or column.

When a column is missing, actual data is necessarily undefined.
When a column is present, actual data can be defined, undefined, or declared as ERASE.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Usage.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Usage	ACTION	Usage dedicated to the action column.
static final Usage	DERIVED_RO_ATT	The column is a read-only derived (computed) entity attribute.
static final Usage	MANDATORY_RO_ATT	The column is a mandatory read-only entity attribute.
static final Usage	MANDATORY_RO_ID	The column is a mandatory read-only part of the entity id.
static final Usage	MANDATORY_RW_ATT	The column is a mandatory read-write entity attribute.
static final Usage	OPTIONAL_RO_ATT	The column is a optional read-only entity attribute.
static final Usage	OPTIONAL_RO_ID	The column is an optional read-only part of the entity id.
static final Usage	OPTIONAL_RW_ATT	The column is a optional read-write entity attribute.

Method Summary

Modifier and Type	Method	Description
static Usage.Builder	builder()
int	getCount(Presence presence)
ImportAction[]	getImportActions(Presence presence)
String	getName()
Presence	getPresence(ImportAction action)
boolean	isErasable()
boolean	isIgnoredFor(ImportAction action)
boolean	isMandatoryFor(ImportAction action)
boolean	isMandatoryForFutureImport()
boolean	isOptionalFor(ImportAction action)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ACTION

public static final Usage ACTION

Usage dedicated to the action column.

• CREATE: Presence.OPTIONAL
• UPDATE: Presence.OPTIONAL, CAN NOT be erased
• DELETE: Presence.OPTIONAL

MANDATORY_RO_ID

public static final Usage MANDATORY_RO_ID

The column is a mandatory read-only part of the entity id.

• CREATE: Presence.MANDATORY
• UPDATE: Presence.MANDATORY, CAN NOT be erased
• DELETE: Presence.MANDATORY

It is used to designate an entity. It can not be changed.

OPTIONAL_RO_ID

public static final Usage OPTIONAL_RO_ID

The column is an optional read-only part of the entity id.

• CREATE: Presence.OPTIONAL
• UPDATE: Presence.OPTIONAL, CAN NOT be erased
• DELETE: Presence.OPTIONAL

It is used to designate an entity. It can not be changed.

MANDATORY_RO_ATT

public static final Usage MANDATORY_RO_ATT

The column is a mandatory read-only entity attribute.

• CREATE: Presence.MANDATORY
• UPDATE: Presence.IGNORED, CAN NOT be erased
• DELETE: Presence.IGNORED

It must be set at creation time.
It can not be changed.

OPTIONAL_RO_ATT

public static final Usage OPTIONAL_RO_ATT

The column is a optional read-only entity attribute.

• CREATE: Presence.OPTIONAL
• UPDATE: Presence.IGNORED, CAN NOT be erased
• DELETE: Presence.IGNORED

It can be set at creation time.
It can not be changed.

MANDATORY_RW_ATT

public static final Usage MANDATORY_RW_ATT

The column is a mandatory read-write entity attribute.

• CREATE: Presence.MANDATORY
• UPDATE: Presence.OPTIONAL, CAN NOT be erased
• DELETE: Presence.IGNORED

It can not be null.
It must be set at creation time.
It can be changed.

OPTIONAL_RW_ATT

public static final Usage OPTIONAL_RW_ATT

The column is a optional read-write entity attribute.

• CREATE: Presence.OPTIONAL
• UPDATE: Presence.OPTIONAL, CAN be erased
• DELETE: Presence.IGNORED

It can be null.
It can be set at creation time.
It can be changed.

DERIVED_RO_ATT

public static final Usage DERIVED_RO_ATT

The column is a read-only derived (computed) entity attribute.

• CREATE: Presence.IGNORED
• UPDATE: Presence.IGNORED, can not be erased
• DELETE: Presence.IGNORED

It is useless for imports but can be useful in exports.

Method Details

getName

public String getName()

getPresence

public Presence getPresence(ImportAction action)

isErasable

public boolean isErasable()

Returns:

true if the column can be erased during update.

getCount

public int getCount(Presence presence)

getImportActions

public ImportAction[] getImportActions(Presence presence)

isMandatoryFor

public boolean isMandatoryFor(ImportAction action)

Parameters:

action - The action.

Returns:

true if this usage is mandatory for action.

isOptionalFor

public boolean isOptionalFor(ImportAction action)

Parameters:

action - The action.

Returns:

true if this usage is optional for action.

isIgnoredFor

public boolean isIgnoredFor(ImportAction action)

Parameters:

action - The action.

Returns:

true if this usage is ignored for action.

isMandatoryForFutureImport

public boolean isMandatoryForFutureImport()

Returns:

true if this usage is mandatory for a future import.

toString

public String toString()

Overrides:

toString in class Object

builder

public static Usage.Builder builder()