1 /* Copyright 2004 Brian McCallister
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15 package org.skife.lucene.graph;
16
17 /***
18 * Used to convert an object into a String. toSting()
19 * is likely not always appropriate or meaningful for
20 * text searching
21 */
22 public interface ValueMapper
23 {
24 /***
25 * Receives instance being indexed, should return String to be analyzed
26 * and storef as value for the field
27 *
28 * @param entity may be null
29 * @return
30 */
31 public String build(Object entity);
32 }