Top Description Methods
org.eclipse.persistence.annotations

public @Interface BatchFetch

extends Annotation
Annotations
@Target:METHOD, FIELD
@Retention:RUNTIME
Imports
java.lang.annotation.Retention, .Target
A BatchFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, ElementCollection, BasicCollection, BasicMap). It allows the related objects to be batch read in a single query. Batch fetching can also be set at the query level, and it is normally recommended to do so as all queries may not require batching.
Author
James Sutherland
Since
EclipseLink 2.1

Method Summary

Modifier and TypeMethod and Description
public int
size()

Define the default batch fetch size.

public BatchFetchType
value()

(Optional) The type of batch-fetch to use.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

sizeback to summary
public int size()

Define the default batch fetch size. This is only used for IN type batch reading and defines the number of keys used in each IN clause. The default size is 256, or the query's pageSize for cursor queries.

valueback to summary
public BatchFetchType value()

(Optional) The type of batch-fetch to use. Either JOIN, EXISTS or IN. JOIN is the default.