KickJava   Java API By Example, From Geeks To Geeks.

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


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.6 xf:contains
30 3.5.6.1 Signature
31 xf:contains(string $operand1, string $operand2) => boolean
32 xf:contains(string $operand1, string $operand2, anyURI $collation) => boolean
33 3.5.6.2 Parameters
34 $operand1 — static type is string
35 $operand2 — static type is string
36 $collation — static type is anyURI
37 3.5.6.3 Semantics
38 Returns a boolean indicating whether or not the value of $operand1 contains (at the beginning, at
39 the end, or anywhere within) a string equal to the value of $operand1 according to the collation
40 that is used.
41 If the value of $operand2 is the zero-length string, then the function returns true. If the value
42 of $operand1 is the zero-length string and the value of $operand2 is not the zero-length string,
43 then the function returns false.
44 If $collation is specified, then the value of $collation must identify a collation that is
45 supported in the environment in which the function is invoked. Either an absolute URI or a relative
46 URI may be specified. The collation identified by $collation, while effectively based on the
47 Unicode Collation Algorithm, has implementation-defined semantics.
48 If no collation is specified, then the default collation is used. The default collation is
49 determined according to the rules in TO BE DETERMINED.
50  */
51 public final class XfContains extends Xfunction_Boolean
52 {
53
54     private static final String JavaDoc RCSRevision = "$Revision: 1.3 $";
55     private static final String JavaDoc RCSName = "$Name: $";
56
57
58     /**
59     @roseuid 3BD1465C00BF
60      */
61     public XfContains()
62     {
63       super("XfContains");
64     }
65     public XfContains( Expression operand1, Expression operand2)
66     {
67         super("XfContains");
68         setArgument(0, operand1);
69         setArgument(1, operand2);
70     }
71
72     public SqlExpression accept(org.xquark.extractor.algebra.GenSqlVisitor visitor)
73     {
74         return visitor.visit(this);
75     }
76
77     public void accept(org.xquark.extractor.algebra.AlgebraVisitor visitor)
78     {
79         visitor.visit(this);
80     }
81 }
82
Popular Tags