KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ojb > jdo > jdoql > Ordering


1 package org.apache.ojb.jdo.jdoql;
2
3 /* Copyright 2003-2005 The Apache Software Foundation
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 /**
19  * Encapsulates an ordering.
20  *
21  * @author <a HREF="mailto:tomdz@apache.org">Thomas Dudziak</a>
22  */
23 public class Ordering extends QueryTreeNode
24 {
25     /** The ordering expression */
26     private Expression _expr;
27     /** Whether this is an ascending ordering specification */
28     private boolean _isAscending = true;
29
30     /**
31      * Creates a new ordering object.
32      *
33      * @param expr The ordering expression
34      * @param isAscending Whether this is an ascending ordering specification
35      */
36     public Ordering(Expression expr, boolean isAscending)
37     {
38         _expr = expr;
39         _isAscending = isAscending;
40     }
41     
42     /**
43      * Returns the ordering expression.
44      *
45      * @return The expression
46      */
47     public Expression getExpression()
48     {
49         return _expr;
50     }
51
52     /**
53      * Returns whether this ordering is ascending or descending.
54      *
55      * @return <code>true</code> if the ordering is ascending
56      */
57     public boolean isAscending()
58     {
59         return _isAscending;
60     }
61
62     /* (non-Javadoc)
63      * @see org.apache.ojb.jdo.jdoql.Acceptor#accept(org.apache.ojb.jdo.jdoql.Visitor)
64      */
65     public void accept(Visitor visitor)
66     {
67         visitor.visit(this);
68     }
69
70     /* (non-Javadoc)
71      * @see java.lang.Object#toString()
72      */
73     public String JavaDoc toString()
74     {
75         return _expr.toString() + " " + (_isAscending ? "ascending" : "descending");
76     }
77 }
78
Popular Tags