View Javadoc
1 /* 2 * $Header: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/strategy/DefaultPluralStemmer.java,v 1.7 2003/01/06 22:50:45 rdonkin Exp $ 3 * $Revision: 1.7 $ 4 * $Date: 2003/01/06 22:50:45 $ 5 * 6 * ==================================================================== 7 * 8 * The Apache Software License, Version 1.1 9 * 10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights 11 * reserved. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in 22 * the documentation and/or other materials provided with the 23 * distribution. 24 * 25 * 3. The end-user documentation included with the redistribution, if 26 * any, must include the following acknowlegement: 27 * "This product includes software developed by the 28 * Apache Software Foundation (http://www.apache.org/)." 29 * Alternately, this acknowlegement may appear in the software itself, 30 * if and wherever such third-party acknowlegements normally appear. 31 * 32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software 33 * Foundation" must not be used to endorse or promote products derived 34 * from this software without prior written permission. For written 35 * permission, please contact apache@apache.org. 36 * 37 * 5. Products derived from this software may not be called "Apache" 38 * nor may "Apache" appear in their names without prior written 39 * permission of the Apache Group. 40 * 41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * ==================================================================== 54 * 55 * This software consists of voluntary contributions made by many 56 * individuals on behalf of the Apache Software Foundation. For more 57 * information on the Apache Software Foundation, please see 58 * <http://www.apache.org/>;. 59 * 60 * $Id: DefaultPluralStemmer.java,v 1.7 2003/01/06 22:50:45 rdonkin Exp $ 61 */ 62 package org.apache.commons.betwixt.strategy; 63 64 import java.util.Iterator; 65 import java.util.Map; 66 67 import org.apache.commons.betwixt.ElementDescriptor; 68 import org.apache.commons.logging.Log; 69 import org.apache.commons.logging.LogFactory; 70 71 /*** 72 * A default implementation of the plural name stemmer which 73 * tests for some common english plural/singular patterns and 74 * then uses a simple starts-with algorithm 75 * 76 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a> 77 * @author <a href="mailto:martin@mvdb.net">Martin van den Bemt</a> 78 * @version $Revision: 1.7 $ 79 */ 80 public class DefaultPluralStemmer implements PluralStemmer { 81 82 /*** Log used for logging (Doh!) */ 83 protected static Log log = LogFactory.getLog( DefaultPluralStemmer.class ); 84 85 /*** 86 * <p>Algorithm supports common english plural patterns.</p> 87 * 88 * <p>First, common english plural constructions will be tried. 89 * If the property doesn't end with <code>'y'</code> then this method will look for 90 * a property with which has <code>'es'</code> appended. 91 * If the property ends with <code>'y'</code> then a property with the <code>'y'</code> 92 * replaced by <code>'ies'</code> will be searched for.</p> 93 * 94 * <p>If no matches are found then - if one exists - a property starting with the 95 * singular name will be returned.</p> 96 * 97 * @param propertyName the property name string to match 98 * @param map the <code>Map</code> containing the <code>ElementDescriptor</code>'s 99 * to be searched 100 * @return The plural descriptor for the given singular property name. 101 * If more than one descriptor matches, then the best match is returned. 102 */ 103 public ElementDescriptor findPluralDescriptor( String propertyName, Map map ) { 104 int foundKeyCount = 0; 105 String keyFound = null; 106 ElementDescriptor answer = (ElementDescriptor) map.get( propertyName + "s" ); 107 108 if ( answer == null && !propertyName.endsWith( "y" )) { 109 answer = (ElementDescriptor) map.get( propertyName + "es" ); 110 } 111 112 if ( answer == null ) { 113 int length = propertyName.length(); 114 if ( propertyName.endsWith( "y" ) && length > 1 ) { 115 String key = propertyName.substring(0, length - 1) + "ies"; 116 answer = (ElementDescriptor) map.get( key ); 117 } 118 119 if ( answer == null ) { 120 // lets find the first one that starts with the propertyName 121 for ( Iterator iter = map.keySet().iterator(); iter.hasNext(); ) { 122 String key = (String) iter.next(); 123 if ( key.startsWith( propertyName ) ) { 124 if (answer == null) { 125 answer = (ElementDescriptor) map.get(key); 126 if (key.equals(propertyName)) { 127 // we found the best match.. 128 break; 129 } 130 foundKeyCount++; 131 keyFound = key; 132 133 } else { 134 // check if we have a better match,, 135 if (keyFound.length() > key.length()) { 136 answer = (ElementDescriptor) map.get(key); 137 keyFound = key; 138 } 139 foundKeyCount++; 140 141 } 142 } 143 } 144 } 145 } 146 if (foundKeyCount > 1) { 147 log.warn("More than one type matches, using closest match "+answer.getQualifiedName()); 148 } 149 return answer; 150 151 } 152 }

This page was automatically generated by Maven