KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > query > model > functions > SubstringFunction


1 /*
2  * Copyright 2004 Outerthought bvba and Schaubroeck nv
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */

16 package org.outerj.daisy.query.model.functions;
17
18 import org.outerj.daisy.query.model.AbstractFunction;
19 import org.outerj.daisy.query.model.ValueExpr;
20 import org.outerj.daisy.query.model.QValueType;
21 import org.outerj.daisy.query.model.SqlGenerationContext;
22 import org.outerj.daisy.query.QueryContext;
23 import org.outerj.daisy.repository.query.QueryException;
24 import org.outerj.daisy.repository.query.EvaluationContext;
25 import org.outerj.daisy.repository.Document;
26 import org.outerj.daisy.repository.Version;
27
28 import java.util.Locale JavaDoc;
29
30 public class SubstringFunction extends AbstractFunction {
31     public static final String JavaDoc NAME = "Substring";
32
33     public String JavaDoc getFunctionName() {
34         return NAME;
35     }
36
37     public void prepare(QueryContext context) throws QueryException {
38         super.prepare(context);
39
40         if (params.size() < 2 || params.size() > 3)
41             throw new QueryException("Function " + NAME + " expects two or three parameters.");
42
43         ValueExpr stringParam = getParam(0);
44         QValueType paramValueType = stringParam.getValueType();
45         if ((paramValueType != QValueType.UNDEFINED && paramValueType != QValueType.STRING) || stringParam.isSymbolicIdentifier() || stringParam.isMultiValue())
46             throw new QueryException("Function " + NAME + " needs a string as first parameter.");
47
48         ValueExpr lengthParam = getParam(1);
49         paramValueType = lengthParam.getValueType();
50         if ((paramValueType != QValueType.UNDEFINED && paramValueType != QValueType.LONG) || lengthParam.isSymbolicIdentifier() || lengthParam.isMultiValue())
51             throw new QueryException("Function " + NAME + " needs an integer number as second parameter.");
52
53         if (params.size() == 3) {
54             lengthParam = getParam(2);
55             paramValueType = lengthParam.getValueType();
56             if ((paramValueType != QValueType.UNDEFINED && paramValueType != QValueType.LONG) || lengthParam.isSymbolicIdentifier() || lengthParam.isMultiValue())
57                 throw new QueryException("Function " + NAME + " needs an integer number as third parameter.");
58         }
59     }
60
61     public void generateSqlValueExpr(StringBuffer JavaDoc sql, SqlGenerationContext context) throws QueryException {
62         String JavaDoc sqlFunction = context.getJdbcHelper().getSubstringFunction();
63         sql.append(' ').append(sqlFunction).append('(');
64         super.generateSqlValueExpr(sql, context);
65         sql.append(") ");
66     }
67
68     public Object JavaDoc evaluate(QValueType valueType, EvaluationContext evaluationContext) throws QueryException {
69         String JavaDoc value = (String JavaDoc)((ValueExpr)params.get(0)).evaluate(QValueType.STRING, evaluationContext);
70         int pos = ((Long JavaDoc)((ValueExpr)params.get(1)).evaluate(QValueType.LONG, evaluationContext)).intValue();
71         int length = value.length() - pos;
72         if (params.size() == 3)
73             length = ((Long JavaDoc)((ValueExpr)params.get(2)).evaluate(QValueType.LONG, evaluationContext)).intValue();
74         return evaluate(value, pos, length);
75     }
76
77     public Object JavaDoc evaluate(QValueType valueType, Document document, Version version, EvaluationContext evaluationContext) throws QueryException {
78         String JavaDoc value = (String JavaDoc)((ValueExpr)params.get(0)).evaluate(QValueType.STRING, document, version, evaluationContext);
79         int pos = ((Long JavaDoc)((ValueExpr)params.get(1)).evaluate(QValueType.LONG, document, version, evaluationContext)).intValue();
80         int length = value.length() - pos;
81         if (params.size() == 3)
82             length = ((Long JavaDoc)((ValueExpr)params.get(2)).evaluate(QValueType.LONG, evaluationContext)).intValue();
83         return evaluate(value, pos, length);
84     }
85
86     protected Object JavaDoc evaluate(String JavaDoc value, int pos, int length) throws QueryException {
87         if (value == null)
88             return null;
89         else if (pos < 1)
90             throw new QueryException("Position parameter of " + NAME + " function cannot be less than one.");
91         else if (length < 0)
92             throw new QueryException("Length parameter of " + NAME + " function cannot be negative.");
93         else if (pos > value.length())
94             return "";
95         else {
96             int endIndex = pos + length;
97             if (endIndex > value.length() + 1)
98                 endIndex = value.length() + 1;
99             // in SQL, indexes shift one
100
return value.substring(pos - 1, endIndex - 1);
101         }
102     }
103
104     public QValueType getValueType() {
105         return QValueType.STRING;
106     }
107
108     public String JavaDoc getTitle(Locale JavaDoc locale) {
109         return getExpression();
110     }
111
112     public QValueType getOutputValueType() {
113         return QValueType.STRING;
114     }
115
116     public Object JavaDoc getOutputValue(Document document, Version version, EvaluationContext evaluationContext) throws QueryException {
117         return evaluate(null, document, version, evaluationContext);
118     }
119 }
120
121
Popular Tags