KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > dbutils > QueryLoader


1 /*
2  * $Header: /home/cvs/jakarta-commons/dbutils/src/java/org/apache/commons/dbutils/QueryLoader.java,v 1.1 2003/11/02 19:15:23 dgraham Exp $
3  * $Revision: 1.1 $
4  * $Date: 2003/11/02 19:15:23 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 2003 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowledgement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowledgement may appear in the software itself,
30  * if and wherever such third-party acknowledgements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Software Foundation.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  *
60  */

61
62 package org.apache.commons.dbutils;
63
64 import java.io.IOException JavaDoc;
65 import java.io.InputStream JavaDoc;
66 import java.util.HashMap JavaDoc;
67 import java.util.Map JavaDoc;
68 import java.util.Properties JavaDoc;
69
70 /**
71  * <code>QueryLoader</code> loads properties files filled with query name to
72  * SQL mappings. It acts as a registry for sets of queries so that multiple
73  * copies of the same queries aren't loaded into memory. This class is thread
74  * safe.
75  *
76  * @author David Graham
77  */

78 public class QueryLoader {
79
80     /**
81      * The Singleton instance of this class.
82      */

83     private static final QueryLoader instance = new QueryLoader();
84
85     /**
86      * Return an instance of this class.
87      * @return The Singleton instance.
88      */

89     public static QueryLoader instance() {
90         return instance;
91     }
92
93     /**
94      * Maps query set names to Maps of their queries.
95      */

96     private Map JavaDoc queries = new HashMap JavaDoc();
97
98     /**
99      * QueryLoader constructor.
100      */

101     protected QueryLoader() {
102         super();
103     }
104
105     /**
106      * Loads a Map of query names to SQL values. The Maps are cached so a
107      * subsequent request to load queries from the same path will return
108      * the cached Map.
109      *
110      * @param path The path that the ClassLoader will use to find the file.
111      * This is <strong>not</strong> a file system path. If you had a jarred
112      * Queries.properties file in the com.yourcorp.app.jdbc package you would
113      * pass "/com/yourcorp/app/jdbc/Queries.properties" to this method.
114      * @throws IOException
115      * @throws IllegalArgumentException if the ClassLoader can't find a file at
116      * the given path.
117      */

118     public synchronized Map JavaDoc load(String JavaDoc path) throws IOException JavaDoc {
119
120         Map JavaDoc queryMap = (Map JavaDoc) this.queries.get(path);
121
122         if (queryMap == null) {
123             queryMap = this.loadQueries(path);
124             this.queries.put(path, queryMap);
125         }
126
127         return queryMap;
128     }
129
130     /**
131      * Loads a properties file into a Map object.
132      * @param path The path that the ClassLoader will use to find the file.
133      * @throws IOException
134      */

135     private Map JavaDoc loadQueries(String JavaDoc path) throws IOException JavaDoc {
136         InputStream JavaDoc in = QueryLoader.class.getResourceAsStream(path);
137
138         if (in == null) {
139             throw new IllegalArgumentException JavaDoc(path + " not found.");
140         }
141
142         Properties JavaDoc props = new Properties JavaDoc();
143         props.load(in);
144
145         // Copy to HashMap for better performance
146
return new HashMap JavaDoc(props);
147     }
148     
149     /**
150      * Removes the queries for the given path from the cache.
151      * @param path The path that the queries were loaded from.
152      */

153     public synchronized void unload(String JavaDoc path){
154         this.queries.remove(path);
155     }
156
157 }
158
Popular Tags