KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > util > word > SearchFactory


1 package org.tigris.scarab.util.word;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 import org.apache.fulcrum.TurbineServices;
50 import org.apache.turbine.services.yaaficomponent.YaafiComponentService;
51 import org.tigris.scarab.util.Log;
52
53 /**
54  * Returns an instance of the SearchIndex specified in Scarab.properties
55  *
56  * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally </a>
57  * @version $Id: SearchFactory.java 9378 2005-01-06 21:03:55Z dabbous $
58  */
59 public class SearchFactory {
60     private static SearchIndex searchIndex;
61
62     public static SearchIndex getInstance() throws InstantiationException JavaDoc
63     {
64         SearchIndex result = searchIndex;
65
66         if (result == null)
67         {
68             try {
69                 YaafiComponentService yaafi = (YaafiComponentService) TurbineServices.getInstance().getService(
70                         YaafiComponentService.SERVICE_NAME);
71                 result = (SearchIndex) yaafi.lookup(SearchIndex.class.getName());
72             } catch (Exception JavaDoc e) {
73                 String JavaDoc str = "Could not create new instance of SearchIndex. "
74                         + "Could be a result of insufficient permission "
75                         + "to write the Index to the disk. The default is to "
76                         + "write the Index into the WEB-INF/index directory.";
77                 Log.get().error(str, e);
78                 throw new InstantiationException JavaDoc(str); //EXCEPTION
79 }
80         }
81         return result;
82     }
83
84     /**
85      * Release a searchIndex after it as been looked up from @getInstance()
86      * @param searchIndex
87      */
88     public static void releaseInstance(SearchIndex searchIndex)
89     {
90         YaafiComponentService yaafi = (YaafiComponentService) TurbineServices.getInstance().getService(
91                                                               YaafiComponentService.SERVICE_NAME);
92         searchIndex.clear();
93         yaafi.release(searchIndex);
94     }
95
96
97     /**
98      * Needed for unit testing only
99      * @param searchIndex
100      */
101     public static void setSearchIndex(SearchIndex searchIndex)
102     {
103         SearchFactory.searchIndex = searchIndex;
104     }
105     
106 }
107
108
Popular Tags