org.eclipse.persistence.annotations
Annotation Type BasicMap

@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface BasicMap

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.

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., Convert, Converter, ObjectTypeConverter, A BasicMap can be specified within an Entity, MappedSuperclass and Embeddable class.

Author:

Guy Pelletier

Since:

Oracle TopLink 11.1.1.0.0

Required Element Summary

javax.persistence.Column

keyColumn (Optional) The name of the data column that holds the direct map key.

Optional Element Summary

javax.persistence.FetchType	fetch (Optional) Defines whether the value of the field or property should be lazily loaded or must be eagerly fetched.
Convert	keyConverter (Optional) Specify the key converter.
javax.persistence.Column	valueColumn (Optional) The name of the data column that holds the direct collection data.
Convert	valueConverter (Optional) Specify the value converter.

Element Detail

keyColumn

public abstract javax.persistence.Column keyColumn

(Optional) The name of the data column that holds the direct map key.

fetch

public abstract javax.persistence.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.

Default:

LAZY

keyConverter

public abstract Convert keyConverter

(Optional) Specify the key converter. Default is equivalent to specifying

Default:

@org.eclipse.persistence.annotations.Convert

valueColumn

public abstract javax.persistence.Column valueColumn

(Optional) The name of the data column that holds the direct collection data. Defaults to the property or field name.

Default:

@javax.persistence.Column

valueConverter

public abstract Convert valueConverter

(Optional) Specify the value converter. Default is equivalent to specifying

Default:

@org.eclipse.persistence.annotations.Convert