View Javadoc

1   package org.apache.velocity.app.event.implement;
2   
3   
4   /*
5    * Licensed to the Apache Software Foundation (ASF) under one
6    * or more contributor license agreements.  See the NOTICE file
7    * distributed with this work for additional information
8    * regarding copyright ownership.  The ASF licenses this file
9    * to you under the Apache License, Version 2.0 (the
10   * "License"); you may not use this file except in compliance
11   * with the License.  You may obtain a copy of the License at
12   *
13   *   http://www.apache.org/licenses/LICENSE-2.0
14   *
15   * Unless required by applicable law or agreed to in writing,
16   * software distributed under the License is distributed on an
17   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18   * KIND, either express or implied.  See the License for the
19   * specific language governing permissions and limitations
20   * under the License.
21   */
22  
23  /**
24   * Escapes the characters in a String to be suitable to pass to an SQL query.
25   * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
26   * @author wglass
27   * @since 1.5
28   */
29  public class EscapeSqlReference extends EscapeReference
30  {
31  
32      /**
33       * Escapes the characters in a String to be suitable to pass to an SQL query.
34       *
35       * @param text
36       * @return An escaped string.
37       * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
38       */
39      protected String escape(Object text)
40      {
41          return text.toString().replaceAll("'", "''");
42      }
43  
44      /**
45       * @return attribute "eventhandler.escape.sql.match"
46       */
47      protected String getMatchAttribute()
48      {
49          return "eventhandler.escape.sql.match";
50      }
51  
52  }