Attatched is a new ComboKey implementation and a test case There is one test in the test case commented out
testReflexiveWithNullKeyValue Which tests the equals() function of a key on itself, when the key has at least one null value. This should pass, but it doesnt due to my previous quesiton. IMHO this test should pass and should be reinstated (commented out to allow maven to build torque! Changes made to ComboKey 1 - toString encodes the key types into the resulting key. 2 - ComboKey(String) ctor modified to understand these encodings so that it can recreate the original accurately 3 - the setValue methods have been changed to not reuse an existing key array, but rather recreate it. If you are setting the value, you should be allowed to set the value! There should also be no exceptions thrown by these operations (and they dont now!) 4 - ArrayList tmpKeys and StringBuffer sbuf private member vars removed, these items are now only created in the one method they are used - less object creation if not used! No, they cannot be reused now, but that should be less gain than reducing the cost of creating new keys! 5 - JUnit Test written.
package org.apache.torque.om; /* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2001-2002 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache Turbine" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact [EMAIL PROTECTED] * * 5. Products derived from this software may not be called "Apache", * "Apache Turbine", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ import java.util.ArrayList; import org.apache.commons.lang.ObjectUtils; /** * This class can be used as an ObjectKey to uniquely identify an * object within an application where the key consists of multiple * entities (such a String[] representing a multi-column primary key). * * @author <a href="mailto:[EMAIL PROTECTED]";>John McNally</a> * @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a> * @version $Id: ComboKey.java,v 1.7 2002/07/16 14:57:28 mpoeschl Exp $ */ public class ComboKey extends ObjectKey { // might want to shift these to TR.props /** * The single character used to separate key values in a string. */ public static final char SEPARATOR = ':'; /** * The single character used to separate key values in a string. */ public static final String SEPARATOR_STRING = ":"; private SimpleKey[] key; /** * Creates an ComboKey whose internal representation will be * set later, through a set method */ public ComboKey() { } /** * Creates a ComboKey whose internal representation is an * array of SimpleKeys. */ public ComboKey(SimpleKey[] keys) { setValue(keys); } /** * Creates a compound ComboKey whose internal representation is a * String array. */ public ComboKey(String[] keys) { setValue(keys); } /** * Sets the internal representation to a String array. */ public ComboKey(String keys) { setValue(keys); } /** * Sets the internal representation using a SimpleKey array. */ public void setValue(SimpleKey[] keys) { this.key = keys; } /** * Sets the internal representation using a String array. */ public void setValue(String[] keys) { this.key = new SimpleKey[keys.length]; for ( int i = 0; i < keys.length; i++ ) { this.key[i] = new StringKey(keys[i]); } } /** * Sets the internal representation using a String of the * form produced by the toString method. */ public void setValue(String keys) { int startPtr = 0; int indexOfSep = keys.indexOf(SEPARATOR); ArrayList tmpKeys = new ArrayList(); while (indexOfSep != -1) { if (indexOfSep == startPtr) { tmpKeys.add(null); } else { char keyType = keys.charAt(startPtr); String keyString = keys.substring(startPtr + 1, indexOfSep); SimpleKey newKey = null; switch(keyType){ case 'N': newKey = new NumberKey(keyString); break; case 'S': newKey = new StringKey(keyString); break; case 'D': try{ newKey = new DateKey(keyString); }catch(NumberFormatException nfe){ newKey = new DateKey(); } break; default: // unextepcted key type } tmpKeys.add(newKey); } startPtr = indexOfSep + 1; indexOfSep = keys.indexOf(SEPARATOR,startPtr); } this.key = new SimpleKey[tmpKeys.size()]; for ( int i = 0; i < this.key.length; i++ ) { this.key[i] = (SimpleKey)tmpKeys.get(i); } } public void setValue(ComboKey keys) { setValue((SimpleKey[]) keys.getValue()); } /** * Get the underlying object. */ public Object getValue() { return key; } /** * This method will return true if the conditions for a looseEquals * are met and in addition no parts of the keys are null. */ public boolean equals(Object keyObj) { boolean isEqual = false; if (key != null) { // check that all keys are not null isEqual = true; SimpleKey[] keys = (SimpleKey []) key; for (int i = 0; i < keys.length && isEqual; i++) { isEqual &= keys[i] != null && keys[i].getValue() != null; } isEqual &= looseEquals(keyObj); } return isEqual; } /** * keyObj is equal to this ComboKey if keyObj is a ComboKey, String, * ObjectKey[], or String[] that contains the same information this key * contains. * For example A String[] might be equal to this key, if this key was * instantiated with a String[] and the arrays contain equal Strings. * Another example, would be if keyObj is an ComboKey that was * instantiated with a ObjectKey[] and this ComboKey was instantiated with * a String[], but the ObjectKeys in the ObjectKey[] were instantiated * with Strings that equal the Strings in this KeyObject's String[] * This method is not as strict as the equals method which does not * allow any null keys parts, while the internal key may not be null * portions may be, and the two object will be considered equal if * their null portions match. */ public boolean looseEquals(Object keyObj) { boolean isEqual = false; if (key != null) { // Checks a compound key (ObjectKey[] or String[] // based) with the delimited String created by the // toString() method. Slightly expensive, but should be less // than parsing the String into its constituents. if (keyObj instanceof String) { isEqual = toString().equals(keyObj); } // check against a ObjectKey. Two keys are equal, if their // internal keys equivalent. else if (keyObj instanceof ComboKey) { SimpleKey[] obj = (SimpleKey[]) ((ComboKey) keyObj).getValue(); SimpleKey[] keys1 = (SimpleKey[]) key; SimpleKey[] keys2 = (SimpleKey[]) obj; isEqual = keys1.length == keys2.length; for (int i = 0; i < keys1.length && isEqual; i++) { isEqual &= ObjectUtils.equals(keys1[i], keys2[i]); } } else if (keyObj instanceof SimpleKey[] && key instanceof SimpleKey[]) { SimpleKey[] keys1 = (SimpleKey[]) key; SimpleKey[] keys2 = (SimpleKey[]) keyObj; isEqual = keys1.length == keys2.length; for (int i = 0; i < keys1.length && isEqual; i++) { isEqual &= ObjectUtils.equals(keys1[i], keys2[i]); } } } return isEqual; } public void appendTo(StringBuffer sb) { if (key != null) { SimpleKey[] keys = (SimpleKey[]) key; for (int i = 0; i < keys.length; i++) { if (keys[i] != null) { if(keys[i] instanceof StringKey){ sb.append("S"); }else if(keys[i] instanceof NumberKey){ sb.append("N"); }else if(keys[i] instanceof DateKey){ sb.append("D"); }else{ // unknown type sb.append("U"); } keys[i].appendTo(sb); } // MUST BE ADDED AFTER EACH KEY, IN CASE OF NULL KEY! sb.append(SEPARATOR); } } } /** * if the underlying key array is not null and the first element is * not null this method returns the hashcode of the first element * in the key. Otherwise calls ObjectKey.hashCode() * * @return an <code>int</code> value */ public int hashCode() { if (key == null) { return super.hashCode(); } SimpleKey sk = ((SimpleKey[]) key)[0]; if (sk == null) { return super.hashCode(); } return sk.hashCode(); } /** * A String that may consist of one section or multiple sections * separated by a colon. */ public String toString() { StringBuffer sbuf = new StringBuffer(); appendTo(sbuf); return sbuf.toString(); } }
package org.apache.torque.om; import java.util.ArrayList; import junit.framework.*; /* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2001 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache Turbine" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact [EMAIL PROTECTED] * * 5. Products derived from this software may not be called "Apache", * "Apache Turbine", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ import junit.framework.Assert; import junit.framework.TestCase; import org.apache.torque.TorqueException; import org.apache.commons.lang.ObjectUtils; /** * TestCase for ComboKey * * @author <a href="mailto:[EMAIL PROTECTED]";>J. Russell Smyth</a> * @version $Revision:$ */ public class ComboKeyTest extends TestCase { private ComboKey c1a = new ComboKey(new SimpleKey[]{new StringKey("key1"),new StringKey("key2")}); private ComboKey c1b = new ComboKey(new SimpleKey[]{new StringKey("key1"),new StringKey("key2")}); private ComboKey c1c = new ComboKey(new String[]{"key1","key2"}); private ComboKey c2a = new ComboKey(new SimpleKey[]{new StringKey("key3"),new StringKey("key4")}); // complex keys for test private java.util.Date now = new java.util.Date(); private ComboKey c3a = new ComboKey(new SimpleKey[]{new StringKey("key1"),null,new DateKey(now)}); private ComboKey c3b = new ComboKey(new SimpleKey[]{new StringKey("key1"),null,new DateKey(now)}); private ComboKey c4a = new ComboKey(new SimpleKey[]{new StringKey("key1"),null,new NumberKey(123456)}); /** * Simple constructor. * * @param name the name of the test to execute */ public ComboKeyTest(String name) { super(name); } public static void main(java.lang.String[] args) { junit.textui.TestRunner.run(suite()); } public static Test suite() { TestSuite suite = new TestSuite(ComboKeyTest.class); return suite; } public void testReflexive() { Assert.assertTrue(c1a.equals(c1a)); // Complex key using null and date // This currently has to use looseEquals as ComboKey.equals(Obj) does not accept // null key values (WHY!) Assert.assertTrue(c3a.looseEquals(c3a)); } // public void testReflexiveWithNullKeyValue() // { // Assert.assertTrue(c3a.equals(c3a)); // } public void testSymmetric() { Assert.assertTrue(c1a.equals(c1b)); Assert.assertTrue(c1b.equals(c1a)); } public void testNull() { Assert.assertTrue(!c1a.equals(null)); } public void testNotEqual() { Assert.assertTrue(!c1a.equals(c2a)); } public void testRoundTripWithStringKeys(){ // two strings ComboKey oldKey = new ComboKey(new SimpleKey[]{new StringKey("key1"),new StringKey("key2")}); ComboKey newKey = null; String stringValue = oldKey.toString(); System.out.println("OldKey as String="+stringValue); try{ newKey = new ComboKey(stringValue); }catch(Exception e){ fail("Exception "+e.getClass().getName()+" thrown on new ComboKey("+stringValue+"):"+e.getMessage()); } Assert.assertEquals(oldKey,newKey); } public void testRoundTripWithComplexKey(){ // complex key ComboKey oldKey = new ComboKey(new SimpleKey[]{new StringKey("key1"), new NumberKey(12345), new DateKey(new java.util.Date())}); ComboKey newKey = null; String stringValue = oldKey.toString(); System.out.println("OldKey as String="+stringValue); try{ newKey = new ComboKey(stringValue); }catch(Exception e){ fail("Exception "+e.getClass().getName()+" thrown on new ComboKey("+stringValue+"):"+e.getMessage()); } Assert.assertEquals(oldKey,newKey); } public void testRoundTripWithNullKey(){ // with null key ComboKey oldKey = new ComboKey(new SimpleKey[]{new StringKey("key1"),null}); ComboKey newKey = null; String stringValue = oldKey.toString(); System.out.println("OldKey as String="+stringValue); try{ newKey = new ComboKey(stringValue); }catch(Exception e){ fail("Exception "+e.getClass().getName()+" thrown on new ComboKey("+stringValue+"):"+e.getMessage()); } // This currently has to use looseEquals as ComboKey.equals(Obj) does not accept // null key values (WHY!) Assert.assertTrue(oldKey.looseEquals(newKey)); } /** Test of appendTo method, of class org.apache.torque.om.ComboKey. */ public void testAppendTo() { StringBuffer sb = new StringBuffer(); c1a.appendTo(sb); Assert.assertEquals("Skey1:Skey2:",sb.toString()); } /** Test of toString method, of class org.apache.torque.om.ComboKey. */ public void testToString() { Assert.assertEquals("Skey1::N123456:",c4a.toString()); } }
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
