| <!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.5.0_06) on Wed Jul 19 14:45:44 EDT 2006 --> |
| <TITLE> |
| OrderingTranslator (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.access.trans.OrderingTranslator class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="OrderingTranslator (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/cayenne/access/trans/LOBUpdateBatchQueryBuilder.html" title="class in org.apache.cayenne.access.trans"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/cayenne/access/trans/ProcedureTranslator.html" title="class in org.apache.cayenne.access.trans"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/cayenne/access/trans/OrderingTranslator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OrderingTranslator.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.cayenne.access.trans</FONT> |
| <BR> |
| Class OrderingTranslator</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans">org.apache.cayenne.access.trans.QueryAssemblerHelper</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.access.trans.OrderingTranslator</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>OrderingTranslator</B><DT>extends <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans">QueryAssemblerHelper</A></DL> |
| </PRE> |
| |
| <P> |
| Translates query ordering to SQL. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik, Craig Miskell</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/access/trans/OrderingTranslator.html#orderByColumnList">orderByColumnList</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.access.trans.QueryAssemblerHelper"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.access.trans.<A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans">QueryAssemblerHelper</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#queryAssembler">queryAssembler</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/access/trans/OrderingTranslator.html#OrderingTranslator(org.apache.cayenne.access.trans.QueryAssembler)">OrderingTranslator</A></B>(<A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</A> queryAssembler)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_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>Method 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="../../../../../org/apache/cayenne/access/trans/OrderingTranslator.html#doTranslation()">doTranslation</A></B>()</CODE> |
| |
| <BR> |
| Translates query Ordering list to SQL ORDER BY clause.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/access/trans/OrderingTranslator.html#getOrderByColumnList()">getOrderByColumnList</A></B>()</CODE> |
| |
| <BR> |
| Returns the column expressions (not Expressions) used in |
| the order by clause.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.access.trans.QueryAssemblerHelper"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.access.trans.<A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans">QueryAssemblerHelper</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#appendDbPath(java.lang.StringBuffer, org.apache.cayenne.exp.Expression)">appendDbPath</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#appendLiteral(java.lang.StringBuffer, java.lang.Object, org.apache.cayenne.map.DbAttribute, org.apache.cayenne.exp.Expression)">appendLiteral</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#appendLiteralDirect(java.lang.StringBuffer, java.lang.Object, org.apache.cayenne.map.DbAttribute, org.apache.cayenne.exp.Expression)">appendLiteralDirect</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#appendObjPath(java.lang.StringBuffer, org.apache.cayenne.exp.Expression)">appendObjPath</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#getDbEntity()">getDbEntity</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#getObjEntity()">getObjEntity</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#getQueryAssembler()">getQueryAssembler</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#paramsDbType(org.apache.cayenne.exp.Expression)">paramsDbType</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#processColumn(java.lang.StringBuffer, org.apache.cayenne.map.DbAttribute)">processColumn</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#processColumn(java.lang.StringBuffer, org.apache.cayenne.map.DbAttribute, org.apache.cayenne.map.DbRelationship)">processColumn</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#processColumn(java.lang.StringBuffer, org.apache.cayenne.exp.Expression)">processColumn</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#processRelTermination(java.lang.StringBuffer, org.apache.cayenne.map.DbRelationship)">processRelTermination</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#processRelTermination(java.lang.StringBuffer, org.apache.cayenne.map.ObjRelationship)">processRelTermination</A>, <A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#setQueryAssembler(org.apache.cayenne.access.trans.QueryAssembler)">setQueryAssembler</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="orderByColumnList"><!-- --></A><H3> |
| orderByColumnList</H3> |
| <PRE> |
| protected java.util.List <B>orderByColumnList</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="OrderingTranslator(org.apache.cayenne.access.trans.QueryAssembler)"><!-- --></A><H3> |
| OrderingTranslator</H3> |
| <PRE> |
| public <B>OrderingTranslator</B>(<A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</A> queryAssembler)</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="doTranslation()"><!-- --></A><H3> |
| doTranslation</H3> |
| <PRE> |
| public java.lang.String <B>doTranslation</B>()</PRE> |
| <DL> |
| <DD>Translates query Ordering list to SQL ORDER BY clause. |
| Ordering list is obtained from <code>queryAssembler</code>'s query object. |
| In a process of building of ORDER BY clause, <code>queryAssembler</code> |
| is notified when a join needs to be added. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html#doTranslation()">doTranslation</A></CODE> in class <CODE><A HREF="../../../../../org/apache/cayenne/access/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans">QueryAssemblerHelper</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrderByColumnList()"><!-- --></A><H3> |
| getOrderByColumnList</H3> |
| <PRE> |
| public java.util.List <B>getOrderByColumnList</B>()</PRE> |
| <DL> |
| <DD>Returns the column expressions (not Expressions) used in |
| the order by clause. E.g., in the case of an case-insensitive |
| order by, an element of the list would be |
| <code>UPPER(<column reference>)</code> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </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="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/cayenne/access/trans/LOBUpdateBatchQueryBuilder.html" title="class in org.apache.cayenne.access.trans"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/cayenne/access/trans/ProcedureTranslator.html" title="class in org.apache.cayenne.access.trans"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/cayenne/access/trans/OrderingTranslator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OrderingTranslator.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
