KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.tigris.scarab.util.word;
2
3 /* ================================================================
4  * Copyright (c) 2001 Collab.Net. 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 // JDK classes
50
51 // Scarab classes
52 import org.tigris.scarab.om.AttributeValue;
53 import org.tigris.scarab.om.Attachment;
54
55 /**
56  * Support for searching/indexing text
57  *
58  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
59  * @version $Id: SearchIndex.java 9381 2005-01-09 15:28:09Z dabbous $
60  */
61 public interface SearchIndex
62 {
63     String JavaDoc PARSE_ERROR =
64         "Search engine could not parse the query: ";
65     String JavaDoc INDEX_PATH = "path";
66     String JavaDoc VALUE_ID = "valid";
67     String JavaDoc ISSUE_ID = "issid";
68     String JavaDoc ATTRIBUTE_ID = "attid";
69     String JavaDoc ATTACHMENT_ID = "atchid";
70     String JavaDoc ATTACHMENT_TYPE_ID = "atchtypeid";
71     String JavaDoc TEXT = "text";
72     Long JavaDoc[] EMPTY_LIST = new Long JavaDoc[0];
73
74     /**
75      * Specify search criteria. This is incremental.
76      */
77     void addQuery(Integer JavaDoc[] attributeIds, String JavaDoc text)
78         throws Exception JavaDoc;
79
80     /**
81      * Specify search criteria for attachments
82      */
83     void addAttachmentQuery(Integer JavaDoc[] ids, String JavaDoc text)
84         throws Exception JavaDoc;
85
86     /**
87      * returns a list of related issue IDs sorted by relevance descending.
88      * Should return an empty/length=0 array if search returns no results.
89      */
90     Long JavaDoc[] getRelatedIssues()
91         throws Exception JavaDoc;
92
93     /**
94      * returns a list of related issue IDs sorted by relevance descending.
95      * Should return an empty/length=0 array if search returns no results.
96      * if(mergeResults==false) performs an implicit AND on internal partial queries.
97      * if(mergeResults==true) performs an implicit OR on internal partial queries.
98      * The method getRelatedIssue() is equivalent to getRelatedIssues(false);
99      */
100     Long JavaDoc[] getRelatedIssues(boolean mergeResults)
101         throws Exception JavaDoc;
102
103     /**
104      * Store index information for an AttributeValue
105      */
106     void index(AttributeValue attributeValue)
107         throws Exception JavaDoc;
108
109     /**
110      * Store index information for an Attachment
111      */
112     void index(Attachment attachment)
113         throws Exception JavaDoc;
114
115     /**
116      * update the index for all entities that currently exist
117      */
118     void updateIndex()
119         throws Exception JavaDoc;
120     
121     /**
122      * Prepares the instance for reuse.
123      *
124      */
125     void clear();
126 }
127
Popular Tags