|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=FIELD) @Retention(value=RUNTIME) public @interface DocumentReferences
Follow references to other documents when loading and updating this
collection based on the result of a view query. The parameter
view
defines the name of a view located in the design document
of the class or in the design document specified by designDoc
.
The parameter fetch
controls when reference loading is
performed. This annotation only has meaning on collection class members.
Optional Element Summary | |
---|---|
String |
backReference
The name of the back referring field in the child must be specified here. |
CascadeType[] |
cascade
Set the type if cascade behaviour this collection should have. |
boolean |
descendingSortOrder
Defines the sort direction of the loaded collection. |
String |
designDoc
Design document of the view specified by view |
FetchType |
fetch
Controls when referenced documents are loaded. |
String |
orderBy
The sort order of the loaded collection can be specified by this parameter. |
String |
view
If view is left unspecified a view will be generated for this document reference (given the persistent type is managed by a repository class based on org.ektorp.support.CouchDbRepositorySupport). |
public abstract FetchType fetch
LAZY
and implies that references should be loaded when
a method on the collection is accessed which needs the documents.
EAGER
means that all references of arbitrary depth will be
followed directly at load time.
public abstract String view
public abstract String designDoc
view
public abstract boolean descendingSortOrder
public abstract String orderBy
public abstract String backReference
public abstract CascadeType[] cascade
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |