1 /*
2 * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/function/ext/UpperFunction.java,v 1.11 2006/02/05 21:47:42 elharo Exp $
3 * $Revision: 1.11 $
4 * $Date: 2006/02/05 21:47:42 $
5 *
6 * ====================================================================
7 *
8 * Copyright 2000-2002 bob mcwhirter & James Strachan.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions are
13 * met:
14 *
15 * * Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 *
18 * * Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * * Neither the name of the Jaxen Project nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
27 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
29 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
30 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 *
38 * ====================================================================
39 * This software consists of voluntary contributions made by many
40 * individuals on behalf of the Jaxen Project and was originally
41 * created by bob mcwhirter <bob@werken.com> and
42 * James Strachan <jstrachan@apache.org>. For more information on the
43 * Jaxen Project, please see <http://www.jaxen.org/>.
44 *
45 * $Id: UpperFunction.java,v 1.11 2006/02/05 21:47:42 elharo Exp $
46 */
47
48 package org.jaxen.function.ext;
49
50 import java.util.List;
51 import java.util.Locale;
52
53 import org.jaxen.Context;
54 import org.jaxen.FunctionCallException;
55 import org.jaxen.Navigator;
56 import org.jaxen.function.StringFunction;
57
58 /***
59 * <p><code><i>string</i> upper-case(<i>string</i>)</code>
60 *
61 * This function can take a second parameter of the
62 * <code>Locale</code> to use for the String conversion.
63 * </p>
64 *
65 * <p>
66 * For example
67 *
68 * <code>upper-case( /foo/bar )</code>
69 * <code>upper-case( /foo/@name, $myLocale )</code>
70 * </p>
71 *
72 * @author mark wilson (markw@wilsoncom.de)
73 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
74 */
75 public class UpperFunction extends LocaleFunctionSupport
76 {
77 public Object call(Context context,
78 List args) throws FunctionCallException
79 {
80 Navigator navigator = context.getNavigator();
81 int size = args.size();
82 if (size > 0)
83 {
84 Object text = args.get(0);
85 Locale locale = null;
86 if (size > 1)
87 {
88 locale = getLocale( args.get(1), navigator );
89 }
90 return evaluate( text, locale, navigator );
91 }
92 throw new FunctionCallException( "upper-case() requires at least one argument." );
93 }
94
95 /***
96 * Converts the given string value to upper case using an optional Locale
97 *
98 * @param strArg the value which gets converted to a String
99 * @param locale the Locale to use for the conversion or null if
100 * English should be used
101 * @param nav the Navigator to use
102 */
103 public static String evaluate(Object strArg,
104 Locale locale,
105 Navigator nav)
106 {
107
108 String str = StringFunction.evaluate( strArg,
109 nav );
110 // it might be possible to use the xml:lang attribute to
111 // pick a default locale
112 if (locale == null) locale = Locale.ENGLISH;
113 return str.toUpperCase(locale);
114 }
115 }