KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > ftindex > FullTextIndex


1 /*
2  * Copyright 2004 Outerthought bvba and Schaubroeck nv
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.outerj.daisy.ftindex;
17
18 import org.outerj.daisy.repository.query.QueryException;
19
20 public interface FullTextIndex {
21     Hits search(String JavaDoc query, long branchId, long languageId, boolean searchName, boolean searchContent, boolean searchFields) throws QueryException;
22
23     /**
24      * Index the given content for the given document variant.
25      * This will first delete any previous indexed content for that document variant, and then index
26      * the new content.
27      *
28      * <p>The parameters documentName, content and fields are all optional (can all be null),
29      * if they are all null then the index for this document will just be deleted.
30      */

31     void index(long documentId, long branchId, long languageId, String JavaDoc documentName, String JavaDoc content, String JavaDoc fields) throws Exception JavaDoc;
32 }
33
Popular Tags