Top Description Methods

org.eclipse.persistence.annotations

public @Interface BasicMap

Annotations

extends Annotation

@Target:METHOD, FIELD
@Retention:RUNTIME
@Deprecated

Imports

java.lang.annotation.Retention, .Target, jakarta.persistence.Column, .FetchType

Deprecated

A BasicMap is used to map an org.eclipse.persistence.mappings.DirectMapMapping, which stores a collection of key-value pairs of simple types (String, Number, Date, etc.). It is used in conjunction with a CollectionTable which stores the key, the value and a foreign key to the source object.

Author: Guy Pelletier
Since: Oracle TopLink 11.1.1.0.0
See Also: A converter may be used if the desired object type and the data type do not match. This applied to both the key and value of the map., org.eclipse.persistence.annotations.Convert, org.eclipse.persistence.annotations.Converter, org.eclipse.persistence.annotations.ObjectTypeConverter, A BasicMap can be specified within an Entity, MappedSuperclass and Embeddable class., jakarta.persistence.ElementCollection

Method Summary

Modifier and Type	Method and Description
public FetchType	fetch() (Optional) Defines whether the value of the field or property should be lazily loaded or must be eagerly fetched.
public Column	keyColumn() (Optional) The name of the data column that holds the direct map key.
public Convert	keyConverter() (Optional) Specify the key converter.
public Column	valueColumn() (Optional) The name of the data column that holds the direct collection data.
public Convert	valueConverter() (Optional) Specify the value converter.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

fetch	back to summary
public FetchType fetch() (Optional) Defines whether the value of the field or property should be lazily loaded or must be eagerly fetched. The EAGER strategy is a requirement on the persistence provider runtime that the value must be eagerly fetched. The LAZY strategy is a hint to the persistence provider runtime. If not specified, defaults to LAZY.

keyColumn	back to summary
public Column keyColumn() (Optional) The name of the data column that holds the direct map key. If the name on the key column is "", the name will default to: the name of the property or field; "_KEY".

keyConverter	back to summary
public Convert keyConverter() (Optional) Specify the key converter. Default is equivalent to specifying @Convert("none"), meaning no converter will be added to the direct map key.

valueColumn	back to summary
public Column valueColumn() (Optional) The name of the data column that holds the direct collection data. Defaults to the property or field name.

valueConverter	back to summary
public Convert valueConverter() (Optional) Specify the value converter. Default is equivalent to specifying @Convert("none"), meaning no converter will be added to the value column mapping.