Class ConstraintMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.ConstraintMetaData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ForeignKeyMetaData, IndexMetaData, UniqueMetaData

public class ConstraintMetaData
extends MetaData

Representation of an ORM constraint. This will be extended for indexes, unique keys, and foreign keys.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	columnNames	The column names for this constraint.
protected List<String>	memberNames	The member names for this constraint.
protected String	name	the constraint name
private static final long	serialVersionUID
protected String	table	the constraint table name.

Fields inherited from class MetaData

EXTENSION_CLASS_CREATETIMESTAMP, EXTENSION_CLASS_CREATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_CREATEUSER, EXTENSION_CLASS_CREATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_CREATEUSER_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_MULTITENANT, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_SOFTDELETE, EXTENSION_CLASS_SOFTDELETE_COLUMN_NAME, EXTENSION_CLASS_UPDATETIMESTAMP, EXTENSION_CLASS_UPDATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_UPDATEUSER, EXTENSION_CLASS_UPDATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_UPDATEUSER_COLUMN_NAME, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_CLASS_VIEW_DEFINITION, EXTENSION_CLASS_VIEW_IMPORTS, EXTENSION_INDEX_COLUMN_ORDERING, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_ATTACH, EXTENSION_MEMBER_CASCADE_DETACH, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_CREATE_TIMESTAMP, EXTENSION_MEMBER_CREATE_USER, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_KEY_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_RELATION_DISCRIM_COLUMN, EXTENSION_MEMBER_RELATION_DISCRIM_PK, EXTENSION_MEMBER_RELATION_DISCRIM_VALUE, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATE_TIMESTAMP, EXTENSION_MEMBER_UPDATE_USER, EXTENSION_MEMBER_UPDATEABLE, EXTENSION_MEMBER_VALUE_IMPLEMENTATION_CLASSES, EXTENSION_VERSION_NUMBER_INITIAL_VALUE, extensions, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors

Constructor	Description
ConstraintMetaData()	Default constructor.
ConstraintMetaData(ConstraintMetaData acmd)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	addColumn(String columnName)	Add a new column that is part of the constraint.
void	addMember(String memberName)	Add a new member that is part of this constraint.
final String[]	getColumnNames()
final String[]	getMemberNames()
String	getName()
int	getNumberOfColumns()
int	getNumberOfMembers()
String	getTable()
void	setName(String name)
void	setTable(String table)

Methods inherited from class MetaData

addExtension, addExtensions, getExtensions, getMetaDataManager, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, removeExtension, setExtensions, setInitialised, setParent, setPopulated, setUsed

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

name

protected String name

the constraint name

table

protected String table

the constraint table name. Name of the table to which this applies (null implies the enclosing class' table).

memberNames

protected List<String> memberNames

The member names for this constraint.

columnNames

protected List<String> columnNames

The column names for this constraint.

Constructor Details

ConstraintMetaData

public ConstraintMetaData()

Default constructor. Set fields using setters before populate().

ConstraintMetaData

public ConstraintMetaData(ConstraintMetaData acmd)

Copy constructor.

Parameters:

acmd - Metadata to copy

Method Details

getName

public String getName()

setName

public void setName(String name)

getTable

public String getTable()

setTable

public void setTable(String table)

addMember

public void addMember(String memberName)

Add a new member that is part of this constraint.

Parameters:

memberName - member name for the field/property

getMemberNames

public final String[] getMemberNames()

getNumberOfMembers

public int getNumberOfMembers()

addColumn

public void addColumn(String columnName)

Add a new column that is part of the constraint.

Parameters:

columnName - Name for the column

getColumnNames

public final String[] getColumnNames()

getNumberOfColumns

public int getNumberOfColumns()