01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/search/tags/sakai_2-4-1/search-api/api/src/java/org/sakaiproject/search/dao/SearchIndexBuilderWorkerDao.java $
03: * $Id: SearchIndexBuilderWorkerDao.java 29635 2007-04-26 14:44:09Z ajpoland@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.search.dao;
21:
22: import java.io.IOException;
23:
24: import org.sakaiproject.search.api.SearchIndexBuilderWorker;
25:
26: public interface SearchIndexBuilderWorkerDao {
27:
28: /**
29: * This method processes the list of document modifications in the list
30: * @param worker
31: *
32: * @param runtimeToDo
33: * @param indexBatchSize
34: * @throws IOException
35: * @throws HibernateException
36: */
37: void processToDoListTransaction(SearchIndexBuilderWorker worker,
38: int indexBatchSize);
39:
40: /**
41: * If the implementation of the SearchIndexBuilder requires that the call aquires a lock
42: * before processing.
43: * @return true is a lock should be taken prior to processToDoTransaction
44: */
45: boolean isLockRequired();
46:
47: /**
48: * check if the index exists
49: * @return
50: */
51: boolean indexExists();
52:
53: /**
54: * create the index with a minimal profile
55: * @param impl
56: */
57: void createIndexTransaction(SearchIndexBuilderWorker worker);
58:
59: }
|