01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components.search;
18:
19: import org.apache.avalon.framework.component.Component;
20: import org.apache.cocoon.ProcessingException;
21: import org.apache.lucene.analysis.Analyzer;
22: import org.apache.lucene.store.Directory;
23:
24: import java.net.URL;
25:
26: /**
27: * The avalon behavioural component interface of an indexer.
28: *
29: * @author <a href="mailto:berni_huber@a1.net">Bernhard Huber</a>
30: * @version CVS $Id: LuceneCocoonIndexer.java 433543 2006-08-22 06:22:54Z crossley $
31: */
32: public interface LuceneCocoonIndexer extends Component {
33: /**
34: *Description of the Field
35: *
36: * @since
37: */
38: String ROLE = "org.apache.cocoon.components.search.LuceneCocoonIndexer";
39:
40: /**
41: *Sets the analyzer attribute of the LuceneCocoonIndexer object
42: *
43: * @param analyzer The new analyzer value
44: * @since
45: */
46: void setAnalyzer(Analyzer analyzer);
47:
48: /**
49: *Description of the Method
50: *
51: * @param index Description of Parameter
52: * @param create Description of Parameter
53: * @param base_url Description of Parameter
54: * @exception ProcessingException Description of Exception
55: * @since
56: */
57: void index(Directory index, boolean create, URL base_url)
58: throws ProcessingException;
59: }
|