PluralStemmer


1   /*
2    * Copyright 2001-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */ 
16  package org.apache.commons.betwixt.strategy;
17  
18  import java.util.Map  ;
19  
20  import org.apache.commons.betwixt.ElementDescriptor;
21  
22  /** 
23   * A plugin Strategy pattern which will detect the plural property which
24   * maps to a singular property name.
25   * This Strategy is used when composite properties (such as properties
26   * of type Collection, List, Iterator, Enumeration) are used as we need to
27   * match the adder-method, which typically uses a singular name.
28   * This interface allows a variety of different implementations to be used.
29   * 
30   * @author <a HREF="mailto:jstrachan@apache.org">James Strachan</a>
31   * @version $Revision: 1.7 $
32   */
33  public interface PluralStemmer {
34  
35      /**
36       * Find the plural descriptor for a singular property.
37       * 
38       * @return the plural descriptor for the given singular property name
39       *         or <code>null</code> is no matching descriptor can be found 
40       * @param propertyName is the singular property name, from the adder method
41       * @param map is a map with the keys are the property names of the available
42       *  descriptors and the values are the descriptors. This may not be null.
43       */
44      ElementDescriptor findPluralDescriptor( String   propertyName, Map   map );
45  
46  }
47
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags