net.sf.jailer.datamodel

Class Association

java.lang.Object

net.sf.jailer.datamodel.ModelElement

net.sf.jailer.datamodel.Association

public class Association
extends ModelElement

An association between database-tables.

Author:

Ralf Wisser

Field Summary

Fields

Modifier and Type	Field and Description
Table	destination The destination table.
Association	reversalAssociation The counterpart of the association for the reversal direction.
boolean	reversed true for reversed association.
Table	source The source table.

Constructor Summary

Constructors

Constructor and Description
Association(Table source, Table destination, boolean insertSourceBeforeDestination, boolean insertDestinationBeforeSource, String joinCondition, DataModel dataModel, boolean reversed, Cardinality cardinality) Constructor.
Association(Table source, Table destination, boolean insertSourceBeforeDestination, boolean insertDestinationBeforeSource, String joinCondition, DataModel dataModel, boolean reversed, Cardinality cardinality, String author) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendCondition(String condition) Appends condition to join-condition.
Map<Column,Column>	createSourceToDestinationKeyMapping() Maps source-columns to destination-columns, if this represents an equi-join.
AggregationSchema	getAggregationSchema() Gets the XML aggregation schema.
String	getAggregationTagName() Gets name of XML-tag used for aggregation.
Cardinality	getCardinality() Gets the cardinality.
DataModel	getDataModel() Gets data-model to which this association belongs to.
int	getId() Gets unique ID.
String	getJoinCondition() Gets the restricted join-condition for joining source with destination table.
String	getName() Gets the name of the association.
String	getRestrictionCondition() Gets restriction-condition.
String	getUnrestrictedJoinCondition() Gets join-condition without any restrictions.
boolean	isIgnored() Is this association ignored?
boolean	isInsertDestinationBeforeSource() Whether or not to insert destination-rows before source-rows in order to prevent foreign-key-constraint violation.
boolean	isInsertSourceBeforeDestination() Whether or not to insert source-rows before destination rows in order to prevent foreign-key-constraint violation.
boolean	isRestricted() Whether there is any restriction of this association.
String	renderJoinCondition(String restrictionSeparator) Stringifies the join condition.
void	setAggregationSchema(AggregationSchema aggregationSchema) Sets the XML aggregation schema.
void	setAggregationTagName(String aggregationTagName) Sets name of XML-tag used for aggregation.
void	setName(String name) Sets the name of the association.
String	toString() Stringifies the association.
String	toString(int maxGab, boolean useDisplayName) Stringifies the association.

Methods inherited from class net.sf.jailer.datamodel.ModelElement

getAuthor, setAuthor

Methods inherited from class java.lang.Object

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

Field Detail

source

public final Table source

The source table.

destination

public final Table destination

The destination table.

reversed

public final boolean reversed

true for reversed association.

reversalAssociation

public Association reversalAssociation

The counterpart of the association for the reversal direction.

Constructor Detail

Association

public Association(Table source,
           Table destination,
           boolean insertSourceBeforeDestination,
           boolean insertDestinationBeforeSource,
           String joinCondition,
           DataModel dataModel,
           boolean reversed,
           Cardinality cardinality)

Constructor.

Parameters:

source - the source table

destination - the destination table

joinCondition - the join-condition for join with destination table

insertSourceBeforeDestination - whether or not to insert source-rows before destination rows in order to prevent foreign-key-constraint violation

insertDestinationBeforeSource - whether or not to insert destination-rows before source-rows in order to prevent foreign-key-constraint violation

dataModel - data-model containing this association

reversed - true for reversed association

cardinality - the cardinality (optional)

Association

public Association(Table source,
           Table destination,
           boolean insertSourceBeforeDestination,
           boolean insertDestinationBeforeSource,
           String joinCondition,
           DataModel dataModel,
           boolean reversed,
           Cardinality cardinality,
           String author)

Constructor.

Parameters:

source - the source table

destination - the destination table

joinCondition - the join-condition for join with destination table

insertSourceBeforeDestination - whether or not to insert source-rows before destination rows in order to prevent foreign-key-constraint violation

insertDestinationBeforeSource - whether or not to insert destination-rows before source-rows in order to prevent foreign-key-constraint violation

dataModel - data-model containing this association

reversed - true for reversed association

cardinality - the cardinality (optional)

author - the author

Method Detail

getJoinCondition

public String getJoinCondition()

Gets the restricted join-condition for joining source with destination table.

Returns:

the restricted join-condition for joining source with destination table, null if association must be ignored

isIgnored

public boolean isIgnored()

Is this association ignored?

Returns:

true iff this association is ignored

getCardinality

public Cardinality getCardinality()

Gets the cardinality.

Returns:

the cardinality. null if cardinality is not known.

toString

public String toString()

Stringifies the association.

Overrides:

toString in class Object

toString

public String toString(int maxGab,
              boolean useDisplayName)

Stringifies the association.

renderJoinCondition

public String renderJoinCondition(String restrictionSeparator)

Stringifies the join condition.

Parameters:

restrictionSeparator - separates join-condition from restriction condition in the result

getUnrestrictedJoinCondition

public String getUnrestrictedJoinCondition()

Gets join-condition without any restrictions.

Returns:

join-condition as defined in data model

getRestrictionCondition

public String getRestrictionCondition()

Gets restriction-condition.

Returns:

restriction-condition, null if association is not restricted

setName

public void setName(String name)

Sets the name of the association.

Parameters:

name - the name of the association

getName

public String getName()

Gets the name of the association.

Returns:

the name of the association

isInsertSourceBeforeDestination

public boolean isInsertSourceBeforeDestination()

Whether or not to insert source-rows before destination rows in order to prevent foreign-key-constraint violation.

Returns:

the insertSourceBeforeDestination

isInsertDestinationBeforeSource

public boolean isInsertDestinationBeforeSource()

Whether or not to insert destination-rows before source-rows in order to prevent foreign-key-constraint violation.

Returns:

the insertDestinationBeforeSource

isRestricted

public boolean isRestricted()

Whether there is any restriction of this association.

appendCondition

public void appendCondition(String condition)

Appends condition to join-condition.

Parameters:

condition - the condition

getAggregationSchema

public AggregationSchema getAggregationSchema()

Gets the XML aggregation schema.

Returns:

the XML aggregation schema

getAggregationTagName

public String getAggregationTagName()

Gets name of XML-tag used for aggregation.

Returns:

name of XML-tag used for aggregation

setAggregationSchema

public void setAggregationSchema(AggregationSchema aggregationSchema)

Sets the XML aggregation schema.

Parameters:

aggregationSchema - the XML aggregation schema

setAggregationTagName

public void setAggregationTagName(String aggregationTagName)

Sets name of XML-tag used for aggregation.

Parameters:

aggregationTagName - name of XML-tag used for aggregation

getId

public int getId()

Gets unique ID.

Returns:

unique ID

getDataModel

public DataModel getDataModel()

Gets data-model to which this association belongs to.

createSourceToDestinationKeyMapping

public Map<Column,Column> createSourceToDestinationKeyMapping()

Maps source-columns to destination-columns, if this represents an equi-join. Otherwise it returns an empty map.

Returns:

map from source-columns to destination-columns, if this represents an equi-join