Package org.ametys.odf.ose.db.column

Class ForeignKeyColumn

java.lang.Object

org.ametys.odf.ose.db.column.DefaultColumn

org.ametys.odf.ose.db.column.ForeignKeyColumn

All Implemented Interfaces:

Column

public class ForeignKeyColumn
extends DefaultColumn

The definition of a column with a foreign key. It extends DefaultColumn and add the notion of foreign key. For integrity reasons, the AMETYS_* tables haven't the foreign, it's only used to retrieve values from the SRC_* views.

Field Summary

Fields

Modifier and Type	Field	Description
protected Pair<String,String>	_foreignKey	The foreign key: left is table name and right is column name of the referenced column
protected boolean	_needYear	If the foreign key needs to match the year

Fields inherited from class org.ametys.odf.ose.db.column.DefaultColumn

_isNullable, _name, _type, _viewName

Constructor Summary

Constructors

Constructor	Description
ForeignKeyColumn(String name, String type, boolean isNullable, Pair<String,String> foreignKey, boolean needYear)	Constructor
ForeignKeyColumn(String name, String type, boolean isNullable, Pair<String,String> foreignKey, boolean needYear, String viewName)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getViewDescription()	Get the view description for the view mapping.

Methods inherited from class org.ametys.odf.ose.db.column.DefaultColumn

getColumnDescription, getViewParameters

Methods inherited from class java.lang.Object

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

Field Details

_foreignKey

protected Pair<String,String> _foreignKey

The foreign key: left is table name and right is column name of the referenced column

_needYear

protected boolean _needYear

If the foreign key needs to match the year

Constructor Details

ForeignKeyColumn

public ForeignKeyColumn(String name,
 String type,
 boolean isNullable,
 Pair<String,String> foreignKey,
 boolean needYear,
 String viewName)

Constructor.

Parameters:

name - The name of the column

type - The SQL type of the column

isNullable - true if it's nullable

foreignKey - The foreign key

needYear - If the foreign key needs to match the year

viewName - The name of the column in the associated SRC_* view

ForeignKeyColumn

public ForeignKeyColumn(String name,
 String type,
 boolean isNullable,
 Pair<String,String> foreignKey,
 boolean needYear)

Constructor

Parameters:

name - The name of the column (it will also be used for the associated SRC_* view)

type - The SQL type of the column

isNullable - true if it's nullable

foreignKey - The foreign key

needYear - If the foreign key needs to match the year

Method Details

getViewDescription

public String getViewDescription()

Description copied from interface: Column

Get the view description for the view mapping.

Specified by:

getViewDescription in interface Column

Overrides:

getViewDescription in class DefaultColumn

Returns:

The column description for a view