javax.jdo.metadata

Interface ElementMetadata

All Superinterfaces:

Metadata

public interface ElementMetadata
extends Metadata

Represents an element in a collection/array.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
String	getColumn() Accessor for the name of the column.
ColumnMetadata[]	getColumns() Accessor for all column(s) defined on the element.
AttributeConverter<?,?>	getConverter() Accessor for the attribute converter for this element (if any).
ForeignKeyAction	getDeleteAction() Accessor for the delete action of the FK
EmbeddedMetadata	getEmbeddedMetadata() Accessor for any embedded metadata on this element.
ForeignKeyMetadata	getForeignKeyMetadata() Accessor for any foreign key metadata on this element.
IndexMetadata	getIndexMetadata() Accessor for any index metadata on this element
int	getNumberOfColumns() Accessor for the number of columns defined for this element.
String	getTable() Accessor for the name of the table.
UniqueMetadata	getUniqueMetadata() Accessor for any unique constraint metadata on this element.
ForeignKeyAction	getUpdateAction() Accessor for the update action of the FK.
Boolean	getUseDefaultConversion() Accessor for whether any AttributeConverter for this element type is explicitly disabled and should use the implementation default.
ColumnMetadata	newColumnMetadata() Add a new column for this element.
EmbeddedMetadata	newEmbeddedMetadata() Method to set new embedded metadata for the element.
ForeignKeyMetadata	newForeignKeyMetadata() Method to set new foreign key metadata for the element.
IndexMetadata	newIndexMetadata() Method to set new index metadata for the element.
UniqueMetadata	newUniqueMetadata() Method to set new unique constraint metadata for the element.
ElementMetadata	setColumn(String column) Method to set the column name.
ElementMetadata	setConverter(AttributeConverter<?,?> conv) Method to set the attribute converter to use for this element.
ElementMetadata	setDeleteAction(ForeignKeyAction action) Method to set the delete action of the FK
ElementMetadata	setTable(String table) Method to set the table name.
ElementMetadata	setUpdateAction(ForeignKeyAction action) Method to set the update action of the FK
ElementMetadata	setUseDefaultConversion(Boolean flag) Method to explicitly set whether to disable use of AttributeConverter for this type (either here, class-level or PMF level).

Methods inherited from interface javax.jdo.metadata.Metadata

getExtensions, getNumberOfExtensions, getParent, newExtensionMetadata

Method Detail

setColumn

ElementMetadata setColumn(String column)

Method to set the column name.

Parameters:

column - Column name

Returns:

This metadata object

getColumn

String getColumn()

Accessor for the name of the column.

Returns:

The name

setTable

ElementMetadata setTable(String table)

Method to set the table name.

Parameters:

table - Table name

Returns:

This metadata object

getTable

String getTable()

Accessor for the name of the table.

Returns:

The name

setDeleteAction

ElementMetadata setDeleteAction(ForeignKeyAction action)

Method to set the delete action of the FK

Parameters:

action - Delete action of the FK

Returns:

This metadata object

getDeleteAction

ForeignKeyAction getDeleteAction()

Accessor for the delete action of the FK

Returns:

The FK delete-action

setUpdateAction

ElementMetadata setUpdateAction(ForeignKeyAction action)

Method to set the update action of the FK

Parameters:

action - Update action of the FK

Returns:

This metadata object

getUpdateAction

ForeignKeyAction getUpdateAction()

Accessor for the update action of the FK.

Returns:

The FK update-action

getColumns

ColumnMetadata[] getColumns()

Accessor for all column(s) defined on the element.

Returns:

The column(s)

newColumnMetadata

ColumnMetadata newColumnMetadata()

Add a new column for this element.

Returns:

The ColumnMetadata

getNumberOfColumns

int getNumberOfColumns()

Accessor for the number of columns defined for this element.

Returns:

The number of columns

newEmbeddedMetadata

EmbeddedMetadata newEmbeddedMetadata()

Method to set new embedded metadata for the element.

Returns:

The EmbeddedMetadata

getEmbeddedMetadata

EmbeddedMetadata getEmbeddedMetadata()

Accessor for any embedded metadata on this element.

Returns:

The EmbeddedMetadata

newIndexMetadata

IndexMetadata newIndexMetadata()

Method to set new index metadata for the element.

Returns:

The IndexMetadata

getIndexMetadata

IndexMetadata getIndexMetadata()

Accessor for any index metadata on this element

Returns:

Index metadata

newUniqueMetadata

UniqueMetadata newUniqueMetadata()

Method to set new unique constraint metadata for the element.

Returns:

The UniqueMetadata

getUniqueMetadata

UniqueMetadata getUniqueMetadata()

Accessor for any unique constraint metadata on this element.

Returns:

The UniqueMetadata

newForeignKeyMetadata

ForeignKeyMetadata newForeignKeyMetadata()

Method to set new foreign key metadata for the element.

Returns:

The ForeignKeyMetadata

getForeignKeyMetadata

ForeignKeyMetadata getForeignKeyMetadata()

Accessor for any foreign key metadata on this element.

Returns:

The ForeignKeyMetadata

getConverter

AttributeConverter<?,?> getConverter()

Accessor for the attribute converter for this element (if any).

Returns:

The converter

setConverter

ElementMetadata setConverter(AttributeConverter<?,?> conv)

Method to set the attribute converter to use for this element.

Parameters:

conv - Converter

Returns:

This metadata

getUseDefaultConversion

Boolean getUseDefaultConversion()

Accessor for whether any AttributeConverter for this element type is explicitly disabled and should use the implementation default.

Returns:

Whether it is disabled

setUseDefaultConversion

ElementMetadata setUseDefaultConversion(Boolean flag)

Method to explicitly set whether to disable use of AttributeConverter for this type (either here, class-level or PMF level).

Parameters:

flag - Whether to disable

Returns:

This metadata