org.datanucleus.metadata

Class AbstractConstraintMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.AbstractConstraintMetaData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ForeignKeyMetaData, IndexMetaData, UniqueMetaData

public class AbstractConstraintMetaData
extends MetaData

Abstract representation of an ORM constraint.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ColumnMetaData>	columns The columns for this constraint.
protected List<String>	memberNames The member names for this constraint.
protected String	name the constraint name
protected String	table the constraint table name.

Fields inherited from class org.datanucleus.metadata.MetaData

extensions, LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME, VENDOR_NAME_OLD

Constructor Summary

Constructors

Constructor and Description
AbstractConstraintMetaData() Default constructor.
AbstractConstraintMetaData(AbstractConstraintMetaData acmd) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(ColumnMetaData colmd) Add a new ColumnMetaData element
void	addMember(String memberName) Add a new member that is part of this constraint.
ColumnMetaData[]	getColumnMetaData()
String[]	getMemberNames()
int	getNumberOfColumns()
int	getNumberOfMembers()
ColumnMetaData	newColumnMetaData() Method to create a new column, add it, and return it.

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtension, assertIfInitialised, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

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.

columns

protected List<ColumnMetaData> columns

The columns for this constraint. TODO Could we make this columnNames?

Constructor Detail

AbstractConstraintMetaData

public AbstractConstraintMetaData()

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

AbstractConstraintMetaData

public AbstractConstraintMetaData(AbstractConstraintMetaData acmd)

Copy constructor.

Method Detail

addMember

public void addMember(String memberName)

Add a new member that is part of this constraint.

Parameters:

memberName - member name for the field/property

addColumn

public void addColumn(ColumnMetaData colmd)

Add a new ColumnMetaData element

Parameters:

colmd - MetaData for the column

newColumnMetaData

public ColumnMetaData newColumnMetaData()

Method to create a new column, add it, and return it.

Returns:

The column metadata

getMemberNames

public final String[] getMemberNames()

getColumnMetaData

public final ColumnMetaData[] getColumnMetaData()

getNumberOfMembers

public int getNumberOfMembers()

getNumberOfColumns

public int getNumberOfColumns()