View Javadoc

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 for class names as "org.example.model.Wombat" is much less convenient than "wombat".
19   * For bean properties, property names are used. This is simply for translating the names
20   * of the roots of train wrecks, the "wombat" in "wombat.name: George" for example  
21   */
22  public interface NameMapper
23  {
24      /***
25       * Return the string to be used as the root of the property chain
26       * field names for entity
27       */
28      public String build(final Object entity);
29  }