Coverage Report

Coverage Report - net.wotonomy.access.EOAdaptor

Classes in this File

2.258

 /*
  Wotonomy: OpenStep design patterns for pure Java applications.
  Copyright (C) 2001 Michael Powers
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, see http://www.gnu.org
  */
 package net.wotonomy.access;
 
 import net.wotonomy.foundation.NSArray;
 import net.wotonomy.foundation.NSData;
 import net.wotonomy.foundation.NSDictionary;
 import net.wotonomy.foundation.NSKeyValueCoding;
 import net.wotonomy.foundation.NSMutableArray;
 import net.wotonomy.foundation.NSMutableDictionary;
 import net.wotonomy.foundation.NSTimestamp;
 
 /**
 *
 * @author ezamudio@nasoft.com
 * @author $Author: cgruber $
 * @version $Revision: 894 $
 */
 
 public abstract class EOAdaptor {
 
         protected String _name;
         protected NSDictionary _connectionDictionary = NSDictionary.EmptyDictionary;
         protected NSMutableArray _contexts = new NSMutableArray();
         protected Class _expressionClass;
         private static NSMutableDictionary _expressionClassesByName = new NSMutableDictionary();
 
         public EOAdaptor(String name) {
                 super();
                 _name = name;
         }
 
         /**
          * Creates an adaptor with model's adaptorName and sets its connection
          * dictionary to the model's connection dictionary.
          * @param model The model to take adaptorName and connectionDictionary from.
          * @return The adaptor specified in model.
          */
         public static EOAdaptor adaptorWithModel(EOModel model) {
                 if (model == null)
                         throw new IllegalArgumentException("Model must not be null.");
                 if (model.adaptorName() == null || model.adaptorName().length() == 0)
                         throw new IllegalArgumentException("Cannot create an adaptor with an empty name.");
                 EOAdaptor adaptor = adaptorWithName(model.adaptorName());
                 if (adaptor == null)
                         throw new IllegalArgumentException("Cannot create adaptor with name " + model.adaptorName());
                 adaptor.setConnectionDictionary(model.connectionDictionary());
                 return adaptor;
         }
 
         /**
          * Instantiates an adaptor of a concrete EOAdaptor subclass, based on name.
          * If name is a fully qualified class name, then it returns an instance of that class
          * by invoking the constructor with a string argument. Otherwise, it
          * tries to find a class called (name)Adaptor in a package called
          * net.wotonomy.(lowercase name)adaptor; if it can't find one, an exception is raised.
          * @param name The name of the adaptor, or a fully qualified class name.
          * @return
          */
         public static EOAdaptor adaptorWithName(String name) {
                 Class adaptorClass = null;
                 String cname = null;
                 if (name.endsWith("Adaptor") && name.indexOf('.') > 0) {
                         cname = name;
                         int lastdot = name.lastIndexOf('.');
                         //take off the package and the 'Adaptor' suffix
                         name = cname.substring(lastdot, cname.length() - 7);
                 } else {
                         //construct the fully qualified class name
                         cname = "net.wotonomy." + name.toLowerCase() + "adaptor." + name + "Adaptor";
                 }
                 try {
                         adaptorClass = Class.forName(cname);
                 } catch (ClassNotFoundException ex) {
                         throw new IllegalArgumentException("Cannot find class named " + name);
                 }
                 EOAdaptor adaptor = null;
                 java.lang.reflect.Constructor callme = null;
                 try {
                         callme = adaptorClass.getConstructor(new Class[]{ String.class });
                         adaptor = (EOAdaptor)callme.newInstance((Object[])new String[]{ name });
                 } catch (ClassCastException ex) {
                         throw new IllegalArgumentException("Class " + adaptorClass.getName() + " must inherit from net.wotonomy.access.EOAdaptor");
                 }catch (Exception ex) {
                         throw new IllegalArgumentException("Cannot find or invoke constructor with name argument in class " + adaptorClass.getName());
                 }
                 return adaptor;
         }
 
         public static void setExpressionClassName(String expClassName, String adaptorClassName) {
                 _expressionClassesByName.setObjectForKey(expClassName, adaptorClassName);
         }
         public static String expressionClassName(String adaptorClassName) {
                 return (String)_expressionClassesByName.objectForKey(adaptorClassName);
         }
 
         public void assignExternalInfoForAttribute(EOAttribute attribute) {
                 if (!attribute.isDerived()) {
                         attribute.setColumnName(attribute.name().toUpperCase());
                 }
                 assignExternalTypeForAttribute(attribute);
         }
 
         public void assignExternalTypeForAttribute(EOAttribute attribute) {
         }
 
         public void assignExternalInfoForEntity(EOEntity entity) {
                 entity.setExternalName(entity.name().toUpperCase());
         }
 
         public void assignExternalInfoForEntireModel(EOModel model) {
                 NSArray ents = model.entities();
                 for (int i = 0; i < ents.count(); i++) {
                         EOEntity e = (EOEntity)ents.objectAtIndex(i);
                         //TODO: check that entity is not a prototypes entity
                         NSArray atts = e.attributes();
                         for (int j = 0; j < atts.count(); j++) {
                                 EOAttribute a = (EOAttribute)atts.objectAtIndex(i);
                                 assignExternalInfoForAttribute(a);
                         }
                         assignExternalInfoForEntity(e);
                 }
         }
 
         public boolean canServiceModel(EOModel model) {
                 NSDictionary mcd = model.connectionDictionary();
                 if (mcd == null && _connectionDictionary == null)
                         return true;
                 if (mcd == null || _connectionDictionary == null)
                         return false;
                 return mcd.equals(_connectionDictionary);
         }
 
         public void setConnectionDictionary(NSDictionary connection) {
                 _connectionDictionary = connection;
         }
         public NSDictionary connectionDictionary() {
                 return _connectionDictionary;
         }
 
         public NSArray contexts() {
                 return new NSArray(_contexts);
         }
 
         public abstract void assertConnectionDictionaryIsValid();
 
         public abstract EOAdaptorContext createAdaptorContext();
 
         public abstract Class defaultExpressionClass();
 
         public abstract EOSQLExpressionFactory expressionFactory();
 
         public abstract boolean isValidQualifierType(String typeName, EOModel model);
 
         public Class expressionClass() {
                 if (_expressionClass != null)
                         return _expressionClass;
                 String cname = expressionClassName(name());
                 if (cname != null) {
                         try {
                                 _expressionClass = Class.forName(cname);
                         } catch (ClassNotFoundException ex) {
                                 throw new IllegalStateException("Cannot find expression class named " + cname);
                         }
                 }
                 return defaultExpressionClass();
         }
 
         public NSArray externalTypesWithModel(EOModel model) {
                 return NSArray.EmptyArray;
         }
 
         public NSData fetchedValueForDataValue(NSData value, EOAttribute attr) {
                 return value;
         }
 
         public NSTimestamp fetchedValueForDateValue(NSTimestamp value, EOAttribute attr) {
                 return value;
         }
 
         public Number fetchedValueForNumberValue(Number value, EOAttribute attr) {
                 return value;
         }
 
         public String fetchedValueForStringValue(String value, EOAttribute attr) {
                 return value;
         }
 
         public Object fetchedValueForValue(Object value, EOAttribute attr) {
                 if (value == NSKeyValueCoding.NullValue)
                         return value;
                 if (value instanceof String)
                         return fetchedValueForStringValue((String)value, attr);
                 if (value instanceof NSData)
                         return fetchedValueForDataValue((NSData)value, attr);
                 if (value instanceof Number)
                         return fetchedValueForNumberValue((Number)value, attr);
                 if (value instanceof NSTimestamp)
                         return fetchedValueForDateValue((NSTimestamp)value, attr);
                 return value;
         }
 
         public void handleDroppedConnection() {
                 for (int i = 0; i < _contexts.count(); i++) {
                         EOAdaptorContext c = (EOAdaptorContext)_contexts.objectAtIndex(i);
                         c.transactionDidRollback();
                         c.handleDroppedConnection();
                 }
                 _contexts.removeAllObjects();
         }
 
         public boolean hasOpenChannels() {
                 for (int i = 0; i < _contexts.count(); i++) {
                         EOAdaptorContext c = (EOAdaptorContext)_contexts.objectAtIndex(i);
                         if (c.hasOpenChannels())
                                 return true;
                 }
                 return false;
         }
 
         public String internalTypeForExternalType(String extType, EOModel model) {
                 return null;
         }
 
         public boolean isDroppedConnectionException(Exception ex) {
                 return false;
         }
 
         public String name() {
                 return _name;
         }
 
         public NSArray prototypeAttributes() {
                 return NSArray.EmptyArray;
         }
 
 }
 /*
  * $Log$
  * Revision 1.2  2006/02/16 16:47:14  cgruber
  * Move some classes in to "internal" packages and re-work imports, etc.
  *
  * Also use UnsupportedOperationExceptions where appropriate, instead of WotonomyExceptions.
  *
  * Revision 1.1  2006/02/16 13:19:57  cgruber
  * Check in all sources in eclipse-friendly maven-enabled packages.
  *
  * Revision 1.2  2005/12/08 06:52:32  cgruber
  * Move tests, improve build.xml, and make certain casts explicit so that Java 1.5 doesn't complain about varargs.
  *
  * Revision 1.1  2003/08/13 00:37:45  chochos
  * an almost complete implementation of the abstract adaptor-layer classes
  *
  */

1		/*
2		Wotonomy: OpenStep design patterns for pure Java applications.
3		Copyright (C) 2001 Michael Powers
4
5		This library is free software; you can redistribute it and/or
6		modify it under the terms of the GNU Lesser General Public
7		License as published by the Free Software Foundation; either
8		version 2.1 of the License, or (at your option) any later version.
9
10		This library is distributed in the hope that it will be useful,
11		but WITHOUT ANY WARRANTY; without even the implied warranty of
12		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		Lesser General Public License for more details.
14
15		You should have received a copy of the GNU Lesser General Public
16		License along with this library; if not, see http://www.gnu.org
17		*/
18		package net.wotonomy.access;
19
20		import net.wotonomy.foundation.NSArray;
21		import net.wotonomy.foundation.NSData;
22		import net.wotonomy.foundation.NSDictionary;
23		import net.wotonomy.foundation.NSKeyValueCoding;
24		import net.wotonomy.foundation.NSMutableArray;
25		import net.wotonomy.foundation.NSMutableDictionary;
26		import net.wotonomy.foundation.NSTimestamp;
27
28		/**
29		*
30		* @author ezamudio@nasoft.com
31		* @author $Author: cgruber $
32		* @version $Revision: 894 $
33		*/
34
35	0	public abstract class EOAdaptor {
36
37		protected String _name;
38	0	protected NSDictionary _connectionDictionary = NSDictionary.EmptyDictionary;
39	0	protected NSMutableArray _contexts = new NSMutableArray();
40		protected Class _expressionClass;
41	0	private static NSMutableDictionary _expressionClassesByName = new NSMutableDictionary();
42
43		public EOAdaptor(String name) {
44	0	super();
45	0	_name = name;
46	0	}
47
48		/**
49		* Creates an adaptor with model's adaptorName and sets its connection
50		* dictionary to the model's connection dictionary.
51		* @param model The model to take adaptorName and connectionDictionary from.
52		* @return The adaptor specified in model.
53		*/
54		public static EOAdaptor adaptorWithModel(EOModel model) {
55	0	if (model == null)
56	0	throw new IllegalArgumentException("Model must not be null.");
57	0	if (model.adaptorName() == null \|\| model.adaptorName().length() == 0)
58	0	throw new IllegalArgumentException("Cannot create an adaptor with an empty name.");
59	0	EOAdaptor adaptor = adaptorWithName(model.adaptorName());
60	0	if (adaptor == null)
61	0	throw new IllegalArgumentException("Cannot create adaptor with name " + model.adaptorName());
62	0	adaptor.setConnectionDictionary(model.connectionDictionary());
63	0	return adaptor;
64		}
65
66		/**
67		* Instantiates an adaptor of a concrete EOAdaptor subclass, based on name.
68		* If name is a fully qualified class name, then it returns an instance of that class
69		* by invoking the constructor with a string argument. Otherwise, it
70		* tries to find a class called (name)Adaptor in a package called
71		* net.wotonomy.(lowercase name)adaptor; if it can't find one, an exception is raised.
72		* @param name The name of the adaptor, or a fully qualified class name.
73		* @return
74		*/
75		public static EOAdaptor adaptorWithName(String name) {
76	0	Class adaptorClass = null;
77	0	String cname = null;
78	0	if (name.endsWith("Adaptor") && name.indexOf('.') > 0) {
79	0	cname = name;
80	0	int lastdot = name.lastIndexOf('.');
81		//take off the package and the 'Adaptor' suffix
82	0	name = cname.substring(lastdot, cname.length() - 7);
83	0	} else {
84		//construct the fully qualified class name
85	0	cname = "net.wotonomy." + name.toLowerCase() + "adaptor." + name + "Adaptor";
86		}
87		try {
88	0	adaptorClass = Class.forName(cname);
89	0	} catch (ClassNotFoundException ex) {
90	0	throw new IllegalArgumentException("Cannot find class named " + name);
91	0	}
92	0	EOAdaptor adaptor = null;
93	0	java.lang.reflect.Constructor callme = null;
94		try {
95	0	callme = adaptorClass.getConstructor(new Class[]{ String.class });
96	0	adaptor = (EOAdaptor)callme.newInstance((Object[])new String[]{ name });
97	0	} catch (ClassCastException ex) {
98	0	throw new IllegalArgumentException("Class " + adaptorClass.getName() + " must inherit from net.wotonomy.access.EOAdaptor");
99	0	}catch (Exception ex) {
100	0	throw new IllegalArgumentException("Cannot find or invoke constructor with name argument in class " + adaptorClass.getName());
101	0	}
102	0	return adaptor;
103		}
104
105		public static void setExpressionClassName(String expClassName, String adaptorClassName) {
106	0	_expressionClassesByName.setObjectForKey(expClassName, adaptorClassName);
107	0	}
108		public static String expressionClassName(String adaptorClassName) {
109	0	return (String)_expressionClassesByName.objectForKey(adaptorClassName);
110		}
111
112		public void assignExternalInfoForAttribute(EOAttribute attribute) {
113	0	if (!attribute.isDerived()) {
114	0	attribute.setColumnName(attribute.name().toUpperCase());
115		}
116	0	assignExternalTypeForAttribute(attribute);
117	0	}
118
119		public void assignExternalTypeForAttribute(EOAttribute attribute) {
120	0	}
121
122		public void assignExternalInfoForEntity(EOEntity entity) {
123	0	entity.setExternalName(entity.name().toUpperCase());
124	0	}
125
126		public void assignExternalInfoForEntireModel(EOModel model) {
127	0	NSArray ents = model.entities();
128	0	for (int i = 0; i < ents.count(); i++) {
129	0	EOEntity e = (EOEntity)ents.objectAtIndex(i);
130		//TODO: check that entity is not a prototypes entity
131	0	NSArray atts = e.attributes();
132	0	for (int j = 0; j < atts.count(); j++) {
133	0	EOAttribute a = (EOAttribute)atts.objectAtIndex(i);
134	0	assignExternalInfoForAttribute(a);
135		}
136	0	assignExternalInfoForEntity(e);
137		}
138	0	}
139
140		public boolean canServiceModel(EOModel model) {
141	0	NSDictionary mcd = model.connectionDictionary();
142	0	if (mcd == null && _connectionDictionary == null)
143	0	return true;
144	0	if (mcd == null \|\| _connectionDictionary == null)
145	0	return false;
146	0	return mcd.equals(_connectionDictionary);
147		}
148
149		public void setConnectionDictionary(NSDictionary connection) {
150	0	_connectionDictionary = connection;
151	0	}
152		public NSDictionary connectionDictionary() {
153	0	return _connectionDictionary;
154		}
155
156		public NSArray contexts() {
157	0	return new NSArray(_contexts);
158		}
159
160		public abstract void assertConnectionDictionaryIsValid();
161
162		public abstract EOAdaptorContext createAdaptorContext();
163
164		public abstract Class defaultExpressionClass();
165
166		public abstract EOSQLExpressionFactory expressionFactory();
167
168		public abstract boolean isValidQualifierType(String typeName, EOModel model);
169
170		public Class expressionClass() {
171	0	if (_expressionClass != null)
172	0	return _expressionClass;
173	0	String cname = expressionClassName(name());
174	0	if (cname != null) {
175		try {
176	0	_expressionClass = Class.forName(cname);
177	0	} catch (ClassNotFoundException ex) {
178	0	throw new IllegalStateException("Cannot find expression class named " + cname);
179	0	}
180		}
181	0	return defaultExpressionClass();
182		}
183
184		public NSArray externalTypesWithModel(EOModel model) {
185	0	return NSArray.EmptyArray;
186		}
187
188		public NSData fetchedValueForDataValue(NSData value, EOAttribute attr) {
189	0	return value;
190		}
191
192		public NSTimestamp fetchedValueForDateValue(NSTimestamp value, EOAttribute attr) {
193	0	return value;
194		}
195
196		public Number fetchedValueForNumberValue(Number value, EOAttribute attr) {
197	0	return value;
198		}
199
200		public String fetchedValueForStringValue(String value, EOAttribute attr) {
201	0	return value;
202		}
203
204		public Object fetchedValueForValue(Object value, EOAttribute attr) {
205	0	if (value == NSKeyValueCoding.NullValue)
206	0	return value;
207	0	if (value instanceof String)
208	0	return fetchedValueForStringValue((String)value, attr);
209	0	if (value instanceof NSData)
210	0	return fetchedValueForDataValue((NSData)value, attr);
211	0	if (value instanceof Number)
212	0	return fetchedValueForNumberValue((Number)value, attr);
213	0	if (value instanceof NSTimestamp)
214	0	return fetchedValueForDateValue((NSTimestamp)value, attr);
215	0	return value;
216		}
217
218		public void handleDroppedConnection() {
219	0	for (int i = 0; i < _contexts.count(); i++) {
220	0	EOAdaptorContext c = (EOAdaptorContext)_contexts.objectAtIndex(i);
221	0	c.transactionDidRollback();
222	0	c.handleDroppedConnection();
223		}
224	0	_contexts.removeAllObjects();
225	0	}
226
227		public boolean hasOpenChannels() {
228	0	for (int i = 0; i < _contexts.count(); i++) {
229	0	EOAdaptorContext c = (EOAdaptorContext)_contexts.objectAtIndex(i);
230	0	if (c.hasOpenChannels())
231	0	return true;
232		}
233	0	return false;
234		}
235
236		public String internalTypeForExternalType(String extType, EOModel model) {
237	0	return null;
238		}
239
240		public boolean isDroppedConnectionException(Exception ex) {
241	0	return false;
242		}
243
244		public String name() {
245	0	return _name;
246		}
247
248		public NSArray prototypeAttributes() {
249	0	return NSArray.EmptyArray;
250		}
251
252		}
253		/*
254		* $Log$
255		* Revision 1.2 2006/02/16 16:47:14 cgruber
256		* Move some classes in to "internal" packages and re-work imports, etc.
257		*
258		* Also use UnsupportedOperationExceptions where appropriate, instead of WotonomyExceptions.
259		*
260		* Revision 1.1 2006/02/16 13:19:57 cgruber
261		* Check in all sources in eclipse-friendly maven-enabled packages.
262		*
263		* Revision 1.2 2005/12/08 06:52:32 cgruber
264		* Move tests, improve build.xml, and make certain casts explicit so that Java 1.5 doesn't complain about varargs.
265		*
266		* Revision 1.1 2003/08/13 00:37:45 chochos
267		* an almost complete implementation of the abstract adaptor-layer classes
268		*
269		*/