1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * 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.jetspeed.search;
18
19 import java.util.Set;
20
21 /***
22 * Contract for implementing a specific object handler. Implementation
23 * should convert the object into a document suitable for placement into
24 * search index.
25 *
26 * @author <a href="mailto:morciuch@apache.org">Mark Orciuch</a>
27 * @version $Id: ObjectHandler.java 516448 2007-03-09 16:25:47Z ate $
28 */
29 public interface ObjectHandler
30 {
31 /***
32 * Parses a specific object into a document suitable for index placement
33 *
34 * @param o
35 * @return
36 */
37 public ParsedObject parseObject(Object o);
38
39 /***
40 * Returns the set of fields used to create the parsed object.
41 * @return
42 */
43 public Set getFields();
44
45 /***
46 * Returns the set of keywords used to create the parsed object.
47 * @return
48 */
49 public Set getKeywords();
50 }
51