| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0) on Fri Nov 27 12:46:12 EST 2009 --> |
| <TITLE> |
| OrderBy (EclipseLink 2.0.0, build 'v20091127-r5931' API Reference) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-11-27"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OrderBy (EclipseLink 2.0.0, build 'v20091127-r5931' API Reference)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| EclipseLink 2.0.0, build 'v20091127-r5931' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/OptimisticLockException.html" title="class in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/OrderColumn.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/persistence/OrderBy.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OrderBy.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| javax.persistence</FONT> |
| <BR> |
| Annotation Type OrderBy</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1">@Target(value={METHOD,FIELD}) |
| @Retention(value=RUNTIME) |
| </FONT>public @interface <B>OrderBy</B></DL> |
| </PRE> |
| |
| <P> |
| Specifies the ordering of the elements of a collection valued |
| association or element collection at the point when the association |
| or collection is retrieved. |
| |
| <p> The syntax of the <code>value</code> ordering element is an |
| <code>orderby_list</code>, as follows: |
| |
| <pre> |
| orderby_list::= orderby_item [,orderby_item]* |
| orderby_item::= [property_or_field_name] [ASC | DESC] |
| </pre> |
| |
| <p> If <code>ASC</code> or <code>DESC</code> is not specified, |
| <code>ASC</code> (ascending order) is assumed. |
| |
| <p> If the ordering element is not specified for an entity association, |
| ordering by the primary key of the associated entity is assumed. |
| |
| <p> The property or field name must correspond to that of a |
| persistent property or field of the associated class or embedded class |
| within it. The properties or fields used in the ordering must correspond to |
| columns for which comparison operators are supported. |
| |
| <p> The dot (".") notation is used to refer to an attribute within an |
| embedded attribute. The value of each identifier used with the dot |
| notation is the name of the respective embedded field or property. |
| |
| <p> The <code>OrderBy</code> annotation may be applied to an element |
| collection. When <code>OrderBy</code> is applied to an element collection of |
| basic type, the ordering will be by value of the basic objects and |
| the property or field name is not used. When specifying an ordering |
| over an element collection of embeddable type, the dot notation |
| must be used to specify the attribute or attributes that determine |
| the ordering. |
| |
| <p> The <code>OrderBy</code> annotation is not used when an order |
| column is specified. |
| |
| |
| <pre> |
| Example 1: |
| |
| @Entity |
| public class Course { |
| ... |
| @ManyToMany |
| @OrderBy("lastname ASC") |
| public List<Student> getStudents() {...}; |
| ... |
| } |
| |
| Example 2: |
| |
| @Entity |
| public class Student { |
| ... |
| @ManyToMany(mappedBy="students") |
| @OrderBy // ordering by primary key is assumed |
| public List<Course> getCourses() {...}; |
| ... |
| } |
| |
| Example 3: |
| |
| @Entity |
| public class Person { |
| ... |
| @ElementCollection |
| @OrderBy("zipcode.zip, zipcode.plusFour") |
| public Set<Address> getResidences() {...}; |
| ... |
| } |
| |
| @Embeddable |
| public class Address { |
| protected String street; |
| protected String city; |
| protected String state; |
| @Embedded protected Zipcode zipcode; |
| } |
| |
| @Embeddable |
| public class Zipcode { |
| protected String zip; |
| protected String plusFour; |
| } |
| </pre> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../javax/persistence/OrderColumn.html" title="annotation in javax.persistence"><CODE>OrderColumn</CODE></A><DT><B>Since:</B></DT> |
| <DD>Java Persistence 1.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| |
| <A NAME="annotation_type_optional_element_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Optional Element Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/OrderBy.html#value()">value</A></B></CODE> |
| |
| <BR> |
| An <code>orderby_list</code>.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| <A NAME="value()"><!-- --></A><H3> |
| value</H3> |
| <PRE> |
| public abstract java.lang.String <B>value</B></PRE> |
| <DL> |
| <DD>An <code>orderby_list</code>. Specified as follows: |
| |
| <pre> |
| orderby_list::= orderby_item [,orderby_item]* |
| orderby_item::= [property_or_field_name] [ASC | DESC] |
| </pre> |
| |
| <p> If <code>ASC</code> or <code>DESC</code> is not specified, |
| <code>ASC</code> (ascending order) is assumed. |
| |
| <p> If the ordering element is not specified, ordering by |
| the primary key of the associated entity is assumed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| EclipseLink 2.0.0, build 'v20091127-r5931' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/OptimisticLockException.html" title="class in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/OrderColumn.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/persistence/OrderBy.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OrderBy.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
