javax.rad.persist
Class MetaData

java.lang.Object
  javax.rad.persist.MetaData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MetaData
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

The MetaData is a description of all columns as ColumnMetaData, the Primary Key columns, Representation columns and auto increment columns.

See Also:

ColumnMetaData, Serialized Form

Nested Class Summary

static class

MetaData.Feature Supported features.

Constructor Summary

MetaData()

Method Summary

void	addColumnMetaData(ColumnMetaData pColumnMetaData) Adds an new ColumnMetaData column.
void	addFeature(MetaData.Feature pFeature) Adds support for a feature.
boolean	equals(java.lang.Object pObject)
java.lang.String[]	getAutoIncrementColumnNames() Returns the auto increment column names.
ColumnMetaData[]	getColumnMetaData() returns all ColumnMetaData columns.
ColumnMetaData	getColumnMetaData(int pIndex) Returns the specific ColumnMetaData column.
ColumnMetaData	getColumnMetaData(java.lang.String pColumnName) Returns the specific ColumnMetaData column.
int	getColumnMetaDataCount() Returns the ColumnMetaData count.
int	getColumnMetaDataIndex(java.lang.String pColumnName) Returns the specific ColumnMetaData column index. -1 if the Column name doesn't exist.
java.lang.String[]	getColumnNames() Returns all column names of the ColumnMetaData list.
MetaData.Feature[]	getFeatures() Gets supported features.
java.lang.String[]	getPrimaryKeyColumnNames() Returns the Primary Key column names.
java.lang.String[]	getRepresentationColumnNames() Returns the Representation column names.
int	hashCode()
boolean	isSupported(MetaData.Feature pFeature) Gets whether a specific feature is supported.
void	removeFeature(MetaData.Feature pFeature) Removes support for a feature.
void	setAutoIncrementColumnNames(java.lang.String[] pAutoIncrementColumnNames) Sets the auto increment column names.
void	setColumnMetaData(ColumnMetaData[] pColumnMetaData) Sets the column meta data.
void	setFeatures(MetaData.Feature... pFeatures) Sets supported features.
void	setPrimaryKeyColumnNames(java.lang.String[] pPrimaryKeyColumnNames) Sets the Primary Key column names.
void	setRepresentationColumnNames(java.lang.String[] pRepresentationColumnNames) Sets the Representation column names.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetaData

public MetaData()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

addColumnMetaData

public void addColumnMetaData(ColumnMetaData pColumnMetaData)

Adds an new ColumnMetaData column.

Parameters:

pColumnMetaData - the column meta data to add

getColumnMetaData

public ColumnMetaData[] getColumnMetaData()

returns all ColumnMetaData columns.

Returns:

all ColumnMetaData columns.

setColumnMetaData

public void setColumnMetaData(ColumnMetaData[] pColumnMetaData)

Sets the column meta data. It is ensured, that no existing column meta data is cleared, or the index is changed.

Parameters:

pColumnMetaData - all ColumnMetaData columns to add.

getColumnMetaData

public ColumnMetaData getColumnMetaData(java.lang.String pColumnName)
                                 throws ModelException

Returns the specific ColumnMetaData column.

Parameters:

pColumnName - the column name to use.

Returns:

the specific ColumnMetaData column.

Throws:

ModelException - if the column name doesn't exists

getColumnMetaData

public ColumnMetaData getColumnMetaData(int pIndex)

Returns the specific ColumnMetaData column.

Parameters:

pIndex - the column index to use.

Returns:

the specific ColumnMetaData column.

getColumnMetaDataCount

public int getColumnMetaDataCount()

Returns the ColumnMetaData count.

Returns:

the ColumnMetaData count.

getColumnMetaDataIndex

public int getColumnMetaDataIndex(java.lang.String pColumnName)

Returns the specific ColumnMetaData column index. -1 if the Column name doesn't exist.

Parameters:

pColumnName - the column name to use.

Returns:

the specific ColumnMetaData column index.

getPrimaryKeyColumnNames

public java.lang.String[] getPrimaryKeyColumnNames()

Returns the Primary Key column names.

Returns:

the Primary Key column names.

setPrimaryKeyColumnNames

public void setPrimaryKeyColumnNames(java.lang.String[] pPrimaryKeyColumnNames)

Sets the Primary Key column names.

Parameters:

pPrimaryKeyColumnNames - the Primary Key column names to set

getRepresentationColumnNames

public java.lang.String[] getRepresentationColumnNames()

Returns the Representation column names. Thats all Unique Key columns as default behavior.

Returns:

the Representation column names.

setRepresentationColumnNames

public void setRepresentationColumnNames(java.lang.String[] pRepresentationColumnNames)

Sets the Representation column names.

Parameters:

pRepresentationColumnNames - the Representation column names to set

getAutoIncrementColumnNames

public java.lang.String[] getAutoIncrementColumnNames()

Returns the auto increment column names.

Returns:

the auto increment column names.

setAutoIncrementColumnNames

public void setAutoIncrementColumnNames(java.lang.String[] pAutoIncrementColumnNames)

Sets the auto increment column names.

Parameters:

pAutoIncrementColumnNames - the auto increment column names. to set

setFeatures

public void setFeatures(MetaData.Feature... pFeatures)

Sets supported features.

Parameters:

pFeatures - the supported features

addFeature

public void addFeature(MetaData.Feature pFeature)

Adds support for a feature.

Parameters:

pFeature - the feature

removeFeature

public void removeFeature(MetaData.Feature pFeature)

Removes support for a feature.

Parameters:

pFeature - the feature

getFeatures

public MetaData.Feature[] getFeatures()

Gets supported features.

Returns:

the supported features

isSupported

public boolean isSupported(MetaData.Feature pFeature)

Gets whether a specific feature is supported.

Parameters:

pFeature - the feature

Returns:

true if the feature is supported, false otherwise

getColumnNames

public java.lang.String[] getColumnNames()

Returns all column names of the ColumnMetaData list.

Please note that the returned array is a cached instance, there for changing it will result in changing the cached version, which will result in undefined behavior. If you want to modify the array, copy or clone it before modifying it.

Returns:

all column names of the ColumnMetaData list.