KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > lenya > lucene > index > Indexer


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  */

17
18 /* $Id: Indexer.java 43151 2004-07-29 05:51:54Z michi $ */
19
20 package org.apache.lenya.lucene.index;
21
22 import java.io.File JavaDoc;
23
24 import org.w3c.dom.Element JavaDoc;
25
26 public interface Indexer {
27     /**
28      * Configures this indexer.
29      */

30     void configure(Element JavaDoc indexer, String JavaDoc configFileName) throws Exception JavaDoc;
31
32     /**
33      * Indexes the contents of a directory.
34      */

35     void createIndex(File JavaDoc dumpDirectory, File JavaDoc index)
36         throws Exception JavaDoc;
37
38     /**
39      * Indexes the contents of a directory.
40      */

41     void updateIndex(File JavaDoc dumpDirectory, File JavaDoc index)
42         throws Exception JavaDoc;
43
44     /**
45      * Indexes the content of one file
46      */

47     void indexDocument(File JavaDoc file)
48         throws Exception JavaDoc;
49 }
50
Popular Tags