KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > slide > search > Indexer


1 /*
2  * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/search/Indexer.java,v 1.2 2004/06/05 12:20:20 unico Exp $
3  * $Revision: 1.2 $
4  * $Date: 2004/06/05 12:20:20 $
5  *
6  * ====================================================================
7  *
8  * Copyright 1999-2004 The Apache Software Foundation
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License");
11  * you may not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS,
18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  */
23
24
25 package org.apache.slide.search;
26
27 import org.apache.slide.common.Uri;
28 import org.apache.slide.content.NodeRevisionContent;
29 import org.apache.slide.content.NodeRevisionDescriptor;
30 import org.apache.slide.content.NodeRevisionNumber;
31
32 /**
33  * An Indexer may create an index on a resource, update it or delete it.
34  *
35  * @version $Revision: 1.2 $
36  */
37 public interface Indexer
38 {
39     
40     /**
41      * Drops the index of the specified resource
42      *
43      * @param uri uri of the resource
44      * @param number nodeRevisionNumber of the resource
45      *
46      * @throws IndexException
47      *
48      */
49     public void dropIndex (Uri uri, NodeRevisionNumber number)
50         throws IndexException;
51     
52     
53     /**
54      * creates an index for a resource
55      *
56      * @param uri uri of the resource
57      * @param number nodeRevisionNumber of the resource
58      * @param revisionContent the content of the resource
59      *
60      * @throws IndexException
61      *
62      */
63     void createIndex (Uri uri, NodeRevisionDescriptor revisionDescriptor,
64                       NodeRevisionContent revisionContent)
65         throws IndexException;
66     
67     /**
68      * updates an index for a resource
69      *
70      * @param uri uri of the resource
71      * @param number nodeRevisionNumber of the resource
72      * @param revisionContent the content of the resource
73      *
74      * @throws IndexException
75      *
76      */
77     void updateIndex (Uri uri, NodeRevisionDescriptor revisionDescriptor,
78                       NodeRevisionContent revisionContent)
79         throws IndexException;
80 }
81
82
Popular Tags