javax.jdo.metadata

Interface ValueMetadata

All Superinterfaces:

Metadata

public interface ValueMetadata
extends Metadata

Represents a value in a map.

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 value.
AttributeConverter<?,?>	getConverter() Accessor for the attribute converter for this value (if any).
ForeignKeyAction	getDeleteAction() Accessor for the delete action of the FK.
EmbeddedMetadata	getEmbeddedMetadata() Accessor for any embedded metadata on this value.
ForeignKeyMetadata	getForeignKeyMetadata() Accessor for any foreign key metadata on this value.
IndexMetadata	getIndexMetadata() Accessor for any index metadata on this value.
String	getTable() Accessor for the name of the table.
UniqueMetadata	getUniqueMetadata() Accessor for any unique constraint metadata on this value.
ForeignKeyAction	getUpdateAction() Accessor for the update action of the FK.
Boolean	getUseDefaultConversion() Accessor for whether any AttributeConverter for this value type is explicitly disabled and should use the implementation default.
ColumnMetadata	newColumnMetadata() Add a new column for this value.
EmbeddedMetadata	newEmbeddedMetadata() Method to set new embedded metadata for the value.
ForeignKeyMetadata	newForeignKeyMetadata() Method to set new foreign key metadata for the value.
IndexMetadata	newIndexMetadata() Method to set new index metadata for the value.
UniqueMetadata	newUniqueMetadata() Method to set new unique constraint metadata for the value.
ValueMetadata	setColumn(String column) Method to set the column name.
ValueMetadata	setConverter(AttributeConverter<?,?> conv) Method to set the attribute converter to use for this value.
ValueMetadata	setDeleteAction(ForeignKeyAction action) Method to set the delete action of the FK.
ValueMetadata	setTable(String table) Method to set the table name.
ValueMetadata	setUpdateAction(ForeignKeyAction action) Method to set the update action of the FK.
ValueMetadata	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

ValueMetadata 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

ValueMetadata 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

ValueMetadata 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

ValueMetadata 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 value.

Returns:

The column(s)

newColumnMetadata

ColumnMetadata newColumnMetadata()

Add a new column for this value.

Returns:

The ColumnMetadata

newEmbeddedMetadata

EmbeddedMetadata newEmbeddedMetadata()

Method to set new embedded metadata for the value.

Returns:

The EmbeddedMetadata

getEmbeddedMetadata

EmbeddedMetadata getEmbeddedMetadata()

Accessor for any embedded metadata on this value.

Returns:

The EmbeddedMetadata

newIndexMetadata

IndexMetadata newIndexMetadata()

Method to set new index metadata for the value.

Returns:

The IndexMetadata

getIndexMetadata

IndexMetadata getIndexMetadata()

Accessor for any index metadata on this value.

Returns:

Index metadata

newUniqueMetadata

UniqueMetadata newUniqueMetadata()

Method to set new unique constraint metadata for the value.

Returns:

The UniqueMetadata

getUniqueMetadata

UniqueMetadata getUniqueMetadata()

Accessor for any unique constraint metadata on this value.

Returns:

The UniqueMetadata

newForeignKeyMetadata

ForeignKeyMetadata newForeignKeyMetadata()

Method to set new foreign key metadata for the value.

Returns:

The ForeignKeyMetadata

getForeignKeyMetadata

ForeignKeyMetadata getForeignKeyMetadata()

Accessor for any foreign key metadata on this value.

Returns:

The ForeignKeyMetadata

getConverter

AttributeConverter<?,?> getConverter()

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

Returns:

The converter

setConverter

ValueMetadata setConverter(AttributeConverter<?,?> conv)

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

Parameters:

conv - Converter

Returns:

This value metadata

getUseDefaultConversion

Boolean getUseDefaultConversion()

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

Returns:

Whether it is disabled

setUseDefaultConversion

ValueMetadata 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