KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openharmonise > commons > dsi > dml > functions > Length


1 /*
2  * The contents of this file are subject to the
3  * Mozilla Public License Version 1.1 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
6  *
7  * Software distributed under the License is distributed on an "AS IS"
8  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
9  * See the License for the specific language governing rights and
10  * limitations under the License.
11  *
12  * The Initial Developer of the Original Code is Simulacra Media Ltd.
13  * Portions created by Simulacra Media Ltd are Copyright (C) Simulacra Media Ltd, 2004.
14  *
15  * All Rights Reserved.
16  *
17  * Contributor(s):
18  */
19 package org.openharmonise.commons.dsi.dml.functions;
20
21 import org.openharmonise.commons.dsi.*;
22 import org.openharmonise.commons.dsi.dml.*;
23
24
25 /**
26  * Representation of the length SQL function.
27  *
28  * @author Michael Bell
29  * @version $Revision: 1.1 $
30  *
31  */
32 public class Length implements Function {
33
34     /**
35      * Object to act as argument of length operation.
36      */
37     private Object JavaDoc m_lengthObj = null;
38     
39     /**
40      * Constructs a length function which will operate on a column reference.
41      *
42      * @param colref the column reference
43      */
44     public Length(ColumnRef colref) {
45         m_lengthObj = colref;
46     }
47     
48     /**
49      * Constructs a length function which will operate on a string.
50      *
51      * @param str the string argument
52      */
53     public Length(String JavaDoc str) {
54         m_lengthObj = str;
55     }
56     
57     /**
58      * Returns a string or column ref for the argument of the 'length' function.
59      *
60      * @return a string or column ref for the argument of the 'length' function
61      */
62     public Object JavaDoc getLengthObject() {
63         return m_lengthObj;
64     }
65 }
66
Popular Tags