You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2009/10/15 20:24:19 UTC
svn commit: r825603 - in /cayenne/main/trunk: docs/doc/src/main/resources/
framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/
framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/access/jdbc/
Author: aadamchik
Date: Thu Oct 15 18:24:19 2009
New Revision: 825603
URL: http://svn.apache.org/viewvc?rev=825603&view=rev
Log:
CAY-1282 Use #result as optional directive for only few columns (not all)
Added:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/access/jdbc/ResultDirectiveTest.java
Modified:
cayenne/main/trunk/docs/doc/src/main/resources/RELEASE-NOTES.txt
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/ColumnDescriptor.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/RowDescriptorBuilder.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java
Modified: cayenne/main/trunk/docs/doc/src/main/resources/RELEASE-NOTES.txt
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/doc/src/main/resources/RELEASE-NOTES.txt?rev=825603&r1=825602&r2=825603&view=diff
==============================================================================
--- cayenne/main/trunk/docs/doc/src/main/resources/RELEASE-NOTES.txt (original)
+++ cayenne/main/trunk/docs/doc/src/main/resources/RELEASE-NOTES.txt Thu Oct 15 18:24:19 2009
@@ -32,6 +32,7 @@
CAY-1273 Replace DefaultType with dedicated types
CAY-1276 CreateIfNoSchemaStrategy create no PK support
CAY-1281 Lifecycle callbacks reorganization
+CAY-1282 Use #result as optional directive for only few columns (not all)
Bug Fixes Since M6:
Modified: cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/ColumnDescriptor.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/ColumnDescriptor.java?rev=825603&r1=825602&r2=825603&view=diff
==============================================================================
--- cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/ColumnDescriptor.java (original)
+++ cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/ColumnDescriptor.java Thu Oct 15 18:24:19 2009
@@ -210,7 +210,7 @@
}
/**
- * Retunrs column name. Name is an unqualified column name in a query.
+ * Returns column name. Name is an unqualified column name in a query.
*/
public String getName() {
return name;
Modified: cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/RowDescriptorBuilder.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/RowDescriptorBuilder.java?rev=825603&r1=825602&r2=825603&view=diff
==============================================================================
--- cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/RowDescriptorBuilder.java (original)
+++ cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/RowDescriptorBuilder.java Thu Oct 15 18:24:19 2009
@@ -63,103 +63,142 @@
public RowDescriptor getDescriptor(ExtendedTypeMap typeMap) throws SQLException,
IllegalStateException {
- // explicitly-set columns take precedence over the columns derived from
- // ResultSetMetadata
+ ColumnDescriptor[] columnsForRD;
- ColumnDescriptor[] columns;
-
- if (this.columns != null) {
- columns = columnsFromPresetColumns();
- }
- else if (this.resultSetMetadata != null) {
- columns = columnsFromResultSet();
+ if (this.resultSetMetadata != null) {
+ // do merge between explicitly-set columns and ResultSetMetadata
+ // explicitly-set columns take precedence
+ columnsForRD = mergeResultSetAndPresetColumns();
+ }
+ else if (this.columns != null) {
+ // use explicitly-set columns
+ columnsForRD = this.columns;
}
else {
throw new IllegalStateException(
"Can't build RowDescriptor, both 'columns' and 'resultSetMetadata' are null");
}
- ExtendedType[] converters = new ExtendedType[columns.length];
- for (int i = 0; i < columns.length; i++) {
- converters[i] = typeMap.getRegisteredType(columns[i].getJavaClass());
+ performTransformAndTypeOverride(columnsForRD);
+ ExtendedType[] converters = new ExtendedType[columnsForRD.length];
+ for (int i = 0; i < columnsForRD.length; i++) {
+ converters[i] = typeMap.getRegisteredType(columnsForRD[i].getJavaClass());
}
- return new RowDescriptor(columns, converters);
+ return new RowDescriptor(columnsForRD, converters);
}
- protected ColumnDescriptor[] columnsFromPresetColumns() {
- int len = columns.length;
-
- if (caseTransformer != null) {
- for (int i = 0; i < len; i++) {
+ /**
+ * @return array of columns for ResultSet with overriding ColumnDescriptors from
+ * 'columns' Note: column will be overlooked, if column name is empty
+ */
+ protected ColumnDescriptor[] mergeResultSetAndPresetColumns() throws SQLException {
- String oldLabel = columns[i].getDataRowKey();
- String oldName = columns[i].getName();
+ int rsLen = resultSetMetadata.getColumnCount();
+ if (rsLen == 0) {
+ throw new CayenneRuntimeException("'ResultSetMetadata' is empty.");
+ }
- String newLabel = (String) caseTransformer.transform(oldLabel);
- columns[i].setDataRowKey(newLabel);
+ int columnLen = (columns != null) ? columns.length : 0;
- // do we even need to check this?
- if (oldName.equals(oldLabel)) {
- columns[i].setName(newLabel);
- }
- }
+ if (rsLen < columnLen) {
+ throw new CayenneRuntimeException(
+ "'ResultSetMetadata' has less elements then 'columns'.");
+ }
+ else if (rsLen == columnLen) {
+ // 'columns' contains ColumnDescriptor for every column
+ // in resultSetMetadata. This return is for optimization.
+ return columns;
}
- if (typeOverrides != null) {
- for (int i = 0; i < len; i++) {
-
- String type = typeOverrides.get(columns[i].getName());
+ ColumnDescriptor[] rsColumns = new ColumnDescriptor[rsLen];
- if (type != null) {
- columns[i].setJavaClass(type);
- }
+ int outputLen = 0;
+ for (int i = 0; i < rsLen; i++) {
+ String rowkey = resolveDataRowKeyFromResultSet(i + 1);
+ if (rowkey.length() == 0) {
+ // escape this ColumnDescriptor, cause column name is empty
+ continue;
}
+ // resolve column descriptor from 'columns' or create new
+ rsColumns[outputLen] = getColumnDescriptor(rowkey, columns, i + 1);
+ outputLen++;
}
-
- return this.columns;
- }
-
- protected ColumnDescriptor[] columnsFromResultSet() throws SQLException {
-
- int len = resultSetMetadata.getColumnCount();
- if (len == 0) {
- throw new CayenneRuntimeException("No columns in ResultSet.");
+ if (outputLen < rsLen) {
+ // cut ColumnDescriptor array
+ ColumnDescriptor[] rsColumnsCut = new ColumnDescriptor[outputLen];
+ System.arraycopy(rsColumns, 0, rsColumnsCut, 0, outputLen);
+ return rsColumnsCut;
}
- ColumnDescriptor[] columns = new ColumnDescriptor[len];
+ return rsColumns;
+ }
+ /**
+ * @return ColumnDescriptor from columnArray, if columnArray contains descriptor for
+ * this column, or new ColumnDescriptor.
+ */
+ private ColumnDescriptor getColumnDescriptor(
+ String rowKey,
+ ColumnDescriptor[] columnArray,
+ int position) throws SQLException {
+ int len = (columnArray != null) ? columnArray.length : 0;
+ // go through columnArray to find ColumnDescriptor for specified column
for (int i = 0; i < len; i++) {
-
- int position = i + 1;
- String name = resultSetMetadata.getColumnLabel(position);
- if (name == null || name.length() == 0) {
- name = resultSetMetadata.getColumnName(position);
-
- if (name == null || name.length() == 0) {
- name = "column_" + position;
+ if (columnArray[i] != null) {
+ String columnRowKey = columnArray[i].getDataRowKey();
+
+ // TODO: andrus, 10/14/2009 - 'equalsIgnoreCase' check can result in
+ // subtle bugs in DBs with case-sensitive column names (or when quotes are
+ // used to force case sensitivity). Alternatively using 'equals' may miss
+ // columns in case-insensitive situations.
+ if (columnRowKey != null && columnRowKey.equalsIgnoreCase(rowKey)) {
+ return columnArray[i];
}
}
+ }
+ // columnArray doesn't contain ColumnDescriptor for specified column
+ return new ColumnDescriptor(
+ rowKey,
+ resultSetMetadata.getColumnType(position),
+ resultSetMetadata.getColumnClassName(position));
+ }
- if (caseTransformer != null) {
- name = (String) caseTransformer.transform(name);
+ /**
+ * Return not empty string with ColumnLabel or ColumnName or "column_" + position for
+ * for specified (by it's position) column in ResultSetMetaData.
+ */
+ private String resolveDataRowKeyFromResultSet(int position) throws SQLException {
+ String name = resultSetMetadata.getColumnLabel(position);
+ if (name == null || name.length() == 0) {
+ name = resultSetMetadata.getColumnName(position);
+ if (name == null) {
+ name = "";
}
+ }
+ return name;
+ }
- int jdbcType = resultSetMetadata.getColumnType(position);
+ private void performTransformAndTypeOverride(ColumnDescriptor[] columnArray) {
+ int len = columnArray.length;
- String javaClass = null;
- if (typeOverrides != null) {
- javaClass = typeOverrides.get(name);
- }
+ if (caseTransformer != null) {
+ for (int i = 0; i < len; i++) {
- if (javaClass == null) {
- javaClass = resultSetMetadata.getColumnClassName(position);
+ columnArray[i].setDataRowKey((String) caseTransformer
+ .transform(columnArray[i].getDataRowKey()));
+ columnArray[i].setName((String) caseTransformer.transform(columnArray[i]
+ .getName()));
+ }
+ }
+ if (typeOverrides != null) {
+ for (int i = 0; i < len; i++) {
+ String type = typeOverrides.get(columnArray[i].getName());
+ if (type != null) {
+ columnArray[i].setJavaClass(type);
+ }
}
-
- columns[i] = new ColumnDescriptor(name, jdbcType, javaClass);
}
-
- return columns;
}
/**
@@ -192,11 +231,11 @@
if (typeOverrides == null) {
typeOverrides = new HashMap<String, String>();
}
-
+
typeOverrides.put(columnName, type);
return this;
}
-
+
public boolean isOverriden(String columnName) {
return typeOverrides != null && typeOverrides.containsKey(columnName);
}
Modified: cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java?rev=825603&r1=825602&r2=825603&view=diff
==============================================================================
--- cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java (original)
+++ cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java Thu Oct 15 18:24:19 2009
@@ -269,41 +269,38 @@
SQLStatement compiled,
ResultSet resultSet) throws SQLException {
RowDescriptorBuilder builder = new RowDescriptorBuilder();
+ builder.setResultSet(resultSet);
// SQLTemplate #result columns take precedence over other ways to determine the
// type
if (compiled.getResultColumns().length > 0) {
builder.setColumns(compiled.getResultColumns());
}
- else {
- builder.setResultSet(resultSet);
- ObjEntity entity = queryMetadata.getObjEntity();
- if (entity != null) {
-
- // TODO: andrus 2008/03/28 support flattened attributes with aliases...
- for (ObjAttribute attribute : entity.getAttributes()) {
- String column = attribute.getDbAttributePath();
- if (column == null || column.indexOf('.') > 0) {
- continue;
- }
- builder.overrideColumnType(column, attribute.getType());
+ ObjEntity entity = queryMetadata.getObjEntity();
+ if (entity != null) {
+ // TODO: andrus 2008/03/28 support flattened attributes with aliases...
+ for (ObjAttribute attribute : entity.getAttributes()) {
+ String column = attribute.getDbAttributePath();
+ if (column == null || column.indexOf('.') > 0) {
+ continue;
}
+ builder.overrideColumnType(column, attribute.getType());
}
+ }
+
+ // override numeric Java types based on JDBC defaults for DbAttributes, as
+ // Oracle
+ // ResultSetMetadata is not very precise about NUMERIC distinctions...
+ // (BigDecimal vs Long vs. Integer)
+ if (dbEntity != null) {
+ for (DbAttribute attribute : dbEntity.getAttributes()) {
+
+ if (!builder.isOverriden(attribute.getName())
+ && TypesMapping.isNumeric(attribute.getType())) {
- // override numeric Java types based on JDBC defaults for DbAttributes, as
- // Oracle
- // ResultSetMetadata is not very precise about NUMERIC distinctions...
- // (BigDecimal vs Long vs. Integer)
- if (dbEntity != null) {
- for (DbAttribute attribute : dbEntity.getAttributes()) {
-
- if (!builder.isOverriden(attribute.getName())
- && TypesMapping.isNumeric(attribute.getType())) {
-
- builder.overrideColumnType(attribute.getName(), TypesMapping
- .getJavaBySqlType(attribute.getType()));
- }
+ builder.overrideColumnType(attribute.getName(), TypesMapping
+ .getJavaBySqlType(attribute.getType()));
}
}
}
Added: cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/access/jdbc/ResultDirectiveTest.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/access/jdbc/ResultDirectiveTest.java?rev=825603&view=auto
==============================================================================
--- cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/access/jdbc/ResultDirectiveTest.java (added)
+++ cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/access/jdbc/ResultDirectiveTest.java Thu Oct 15 18:24:19 2009
@@ -0,0 +1,142 @@
+/*****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ ****************************************************************/
+package org.apache.cayenne.access.jdbc;
+
+import java.sql.Connection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.art.Artist;
+import org.apache.cayenne.access.MockOperationObserver;
+import org.apache.cayenne.query.SQLTemplate;
+import org.apache.cayenne.query.SelectQuery;
+import org.apache.cayenne.unit.CayenneCase;
+
+/**
+ * Test for Result directive to check if we could use ResultDitrective optionally.
+ */
+public class ResultDirectiveTest extends CayenneCase {
+
+ @Override
+ protected void setUp() throws Exception {
+ super.setUp();
+ deleteTestData();
+ }
+
+ public void testWithoutResultDirective() throws Exception {
+ String sql = "SELECT ARTIST_ID, ARTIST_NAME FROM ARTIST";
+ Map<String, Object> artist = insertArtist();
+ Map<String, Object> selectResult = selectForQuery(sql);
+
+ assertEquals(artist.get("ARTIST_ID"), selectResult.get("ARTIST_ID"));
+ assertEquals(artist.get("ARTIST_NAME"), selectResult.get("ARTIST_NAME"));
+ }
+
+ public void testWithOnlyResultDirective() throws Exception {
+ String sql = "SELECT #result('ARTIST_ID' 'java.lang.Integer'),"
+ + " #result('ARTIST_NAME' 'java.lang.String')"
+ + " FROM ARTIST";
+ Map<String, Object> artist = insertArtist();
+ Map<String, Object> selectResult = selectForQuery(sql);
+
+ assertEquals(artist.get("ARTIST_ID"), selectResult.get("ARTIST_ID"));
+ assertEquals(artist.get("ARTIST_NAME"), selectResult.get("ARTIST_NAME"));
+ }
+
+ public void testWithMixedDirectiveUse1() throws Exception {
+ String sql = "SELECT ARTIST_ID,"
+ + " #result('ARTIST_NAME' 'java.lang.String')"
+ + " FROM ARTIST";
+ Map<String, Object> artist = insertArtist();
+ Map<String, Object> selectResult = selectForQuery(sql);
+
+ assertEquals(artist.get("ARTIST_ID"), selectResult.get("ARTIST_ID"));
+ assertEquals(artist.get("ARTIST_NAME"), selectResult.get("ARTIST_NAME"));
+ }
+
+ public void testWithMixedDirectiveUse2() throws Exception {
+ String sql = "SELECT #result('ARTIST_ID' 'java.lang.Integer'),"
+ + " ARTIST_NAME "
+ + " FROM ARTIST";
+ Map<String, Object> artist = insertArtist();
+ Map<String, Object> selectResult = selectForQuery(sql);
+
+ assertEquals(artist.get("ARTIST_ID"), selectResult.get("ARTIST_ID"));
+ assertEquals(artist.get("ARTIST_NAME"), selectResult.get("ARTIST_NAME"));
+ }
+
+ private Map<String, Object> selectForQuery(String sql) {
+ SQLTemplate template = new SQLTemplate(Artist.class, sql);
+ MockOperationObserver observer = new MockOperationObserver();
+ getDomain().performQueries(Collections.singletonList(template), observer);
+
+ List<Map<String, Object>> data = observer.rowsForQuery(template);
+ assertEquals(1, data.size());
+ Map<String, Object> row = data.get(0);
+ return row;
+ }
+
+ /**
+ * Inserts one Artist
+ *
+ * @return Inserted Artist as a DataRow
+ */
+ private Map<String, Object> insertArtist() throws Exception {
+ Map<String, Object> parameters = new HashMap<String, Object>();
+ parameters.put("id", new Integer(1));
+ parameters.put("name", "ArtistToTestResult");
+ String templateString = "INSERT INTO ARTIST (ARTIST_ID, ARTIST_NAME, DATE_OF_BIRTH) "
+ + "VALUES (#bind($id), #bind($name), #bind($dob))";
+
+ SQLTemplate template = new SQLTemplate(Object.class, templateString);
+
+ template.setParameters(parameters);
+
+ SQLTemplateAction action = new SQLTemplateAction(
+ template,
+ getAccessStackAdapter().getAdapter(),
+ getDomain().getEntityResolver());
+ assertSame(getAccessStackAdapter().getAdapter(), action.getAdapter());
+
+ Connection c = getConnection();
+ try {
+ MockOperationObserver observer = new MockOperationObserver();
+ action.performAction(c, observer);
+
+ int[] batches = observer.countsForQuery(template);
+ assertNotNull(batches);
+ assertEquals(1, batches.length);
+ assertEquals(1, batches[0]);
+ }
+ finally {
+ c.close();
+ }
+
+ MockOperationObserver observer = new MockOperationObserver();
+ SelectQuery query = new SelectQuery(Artist.class);
+ getDomain().performQueries(Collections.singletonList(query), observer);
+
+ List data = observer.rowsForQuery(query);
+ assertEquals(1, data.size());
+ Map row = (Map) data.get(0);
+ return row;
+ }
+}