KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > extractor > xfunctions > XfStartsWith


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.extractor.xfunctions;
24
25 import org.xquark.extractor.algebra.Expression;
26 import org.xquark.extractor.sql.SqlExpression;
27
28 /**
29 3.5.3 xf:starts-with
30 3.5.3.1 Signature
31 xf:starts-with(string $operand1, string $operand2) => boolean
32
33 xf:starts-with(string $operand1, string $operand2, anyURI $collation) => boolean
34
35 3.5.3.2 Parameters
36 $operand1 — static type is string
37 $operand2 — static type is string
38 $collation — static type is anyURI
39
40 3.5.3.3 Semantics
41 Returns a boolean indicating whether or not the value of $operand1 starts with a string that is
42 equal to the value of $operand2 according to the collation that is used.
43
44 If the value of $operand2 is the zero-length string, then the function returns true. If the value
45 of $operand1 is the zero-length string and the value of $operand2 is not the zero-length string,
46 then the function returns false.
47
48 If $collation is specified, then the value of $collation must identify a collation that is
49 supported in the environment in which the function is invoked. Either an absolute URI or a relative
50 URI may be specified. The collation identified by $collation, while effectively based on the
51 Unicode Collation Algorithm, has implementation-defined semantics.
52
53 If no collation is specified, then the default collation is used. The default collation is
54 determined according to the rules in TO BE DETERMINED.
55
56 3.5.3.4 Examples
57 xf:starts-with("goldenrod", "gold") returns true.
58
59 xf:starts-with("goldenrod", "") returns true.
60  */
61 public final class XfStartsWith extends Xfunction_Boolean
62 {
63
64     private static final String JavaDoc RCSRevision = "$Revision: 1.3 $";
65     private static final String JavaDoc RCSName = "$Name: $";
66
67     public XfStartsWith()
68     {
69       super("XfStartsWith");
70     }
71     public XfStartsWith( Expression arg0, Expression arg1)
72     {
73         super("XfStartsWith");
74         setArgument(0, arg0);
75         setArgument(1, arg1);
76     }
77
78     public SqlExpression accept(org.xquark.extractor.algebra.GenSqlVisitor visitor)
79     {
80         return visitor.visit(this);
81     }
82
83     public void accept(org.xquark.extractor.algebra.AlgebraVisitor visitor)
84     {
85         visitor.visit(this);
86     }
87 }
88
Popular Tags