KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > search > LuceneCocoonIndexer


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.components.search;
17
18 import org.apache.avalon.framework.component.Component;
19 import org.apache.cocoon.ProcessingException;
20 import org.apache.lucene.analysis.Analyzer;
21 import org.apache.lucene.store.Directory;
22
23 import java.net.URL JavaDoc;
24
25 /**
26  * The avalon behavioural component interface of an indexer.
27  *
28  * @author <a HREF="mailto:berni_huber@a1.net">Bernhard Huber</a>
29  * @version CVS $Id: LuceneCocoonIndexer.java 30932 2004-07-29 17:35:38Z vgritsenko $
30  */
31 public interface LuceneCocoonIndexer extends Component
32 {
33     /**
34      *Description of the Field
35      *
36      * @since
37      */
38     String JavaDoc ROLE = "org.apache.cocoon.components.search.LuceneCocoonIndexer";
39
40
41     /**
42      *Sets the analyzer attribute of the LuceneCocoonIndexer object
43      *
44      * @param analyzer The new analyzer value
45      * @since
46      */
47     void setAnalyzer(Analyzer analyzer);
48
49
50     /**
51      *Description of the Method
52      *
53      * @param index Description of Parameter
54      * @param create Description of Parameter
55      * @param base_url Description of Parameter
56      * @exception ProcessingException Description of Exception
57      * @since
58      */
59     void index(Directory index, boolean create, URL JavaDoc base_url)
60              throws ProcessingException;
61 }
62
Popular Tags