|
| 1 | +/***************************************************************** |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + * or more contributor license agreements. See the NOTICE file |
| 4 | + * distributed with this work for additional information |
| 5 | + * regarding copyright ownership. The ASF licenses this file |
| 6 | + * to you under the Apache License, Version 2.0 (the |
| 7 | + * "License"); you may not use this file except in compliance |
| 8 | + * with the License. You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + ****************************************************************/ |
| 19 | + |
| 20 | +package org.apache.cayenne.access.translator.procedure; |
| 21 | + |
| 22 | +import java.util.Map; |
| 23 | + |
| 24 | +import org.apache.cayenne.access.translator.ParameterBinding; |
| 25 | +import org.apache.cayenne.access.types.ExtendedType; |
| 26 | +import org.apache.cayenne.dba.DbAdapter; |
| 27 | +import org.apache.cayenne.map.EntityResolver; |
| 28 | +import org.apache.cayenne.map.Procedure; |
| 29 | +import org.apache.cayenne.map.ProcedureParameter; |
| 30 | +import org.apache.cayenne.query.ProcedureQuery; |
| 31 | + |
| 32 | +/** |
| 33 | + * A {@link ProcedureTranslator} returned by the base {@link org.apache.cayenne.dba.JdbcAdapter}. Adapters may subclass |
| 34 | + * it to customize the generated call string. |
| 35 | + * |
| 36 | + * @since 5.0 |
| 37 | + */ |
| 38 | +public class DefaultProcedureTranslator implements ProcedureTranslator { |
| 39 | + |
| 40 | + /** |
| 41 | + * Helper class to make OUT and VOID parameters logger-friendly. |
| 42 | + */ |
| 43 | + static class NotInParam { |
| 44 | + |
| 45 | + protected String type; |
| 46 | + |
| 47 | + public NotInParam(String type) { |
| 48 | + this.type = type; |
| 49 | + } |
| 50 | + |
| 51 | + @Override |
| 52 | + public String toString() { |
| 53 | + return type; |
| 54 | + } |
| 55 | + } |
| 56 | + |
| 57 | + private static final NotInParam OUT_PARAM = new NotInParam("[OUT]"); |
| 58 | + |
| 59 | + @Override |
| 60 | + public TranslatedProcedure translate(ProcedureQuery query, DbAdapter adapter, EntityResolver resolver) { |
| 61 | + |
| 62 | + Procedure procedure = query.getMetaData(resolver).getProcedure(); |
| 63 | + ProcedureParameter[] callParams = procedure.getCallParameters().toArray(new ProcedureParameter[0]); |
| 64 | + Map<String, ?> queryValues = query.getParameters(); |
| 65 | + |
| 66 | + ParameterBinding[] bindings = new ParameterBinding[callParams.length]; |
| 67 | + for (int i = 0; i < callParams.length; i++) { |
| 68 | + bindings[i] = createBinding(adapter, callParams[i], queryValues, i + 1); |
| 69 | + } |
| 70 | + |
| 71 | + String sql = createSqlString(procedure, callParams.length); |
| 72 | + return new TranslatedProcedure(sql, callParams, bindings); |
| 73 | + } |
| 74 | + |
| 75 | + /** |
| 76 | + * Builds a {@link ParameterBinding} for a single call parameter. IN (and INOUT) parameters carry the actual value |
| 77 | + * and its {@link ExtendedType}; pure OUT parameters carry an "[OUT]" marker value so that logging renders nicely. |
| 78 | + */ |
| 79 | + protected ParameterBinding createBinding(DbAdapter adapter, ProcedureParameter param, |
| 80 | + Map<String, ?> queryValues, int position) { |
| 81 | + |
| 82 | + // match values with parameters in the correct order, assuming a missing value is NULL |
| 83 | + if (param.getDirection() == ProcedureParameter.OUT_PARAMETER) { |
| 84 | + return new ParameterBinding(param.getType(), param.getPrecision()).reset(position, OUT_PARAM, null); |
| 85 | + } |
| 86 | + |
| 87 | + Object value = queryValues.get(param.getName()); |
| 88 | + ExtendedType extendedType = value != null |
| 89 | + ? adapter.getExtendedTypes().getRegisteredType(value.getClass()) |
| 90 | + : adapter.getExtendedTypes().getDefaultType(); |
| 91 | + |
| 92 | + return new ParameterBinding(adapter.preferredBindingType(param.getType()), param.getPrecision()) |
| 93 | + .reset(position, value, extendedType); |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * Creates an SQL String for the stored procedure call. |
| 98 | + */ |
| 99 | + protected String createSqlString(Procedure procedure, int callParamsSize) { |
| 100 | + |
| 101 | + StringBuilder buf = new StringBuilder(); |
| 102 | + |
| 103 | + int totalParams = callParamsSize; |
| 104 | + |
| 105 | + // check if procedure returns values |
| 106 | + if (procedure.isReturningValue()) { |
| 107 | + totalParams--; |
| 108 | + buf.append("{? = call "); |
| 109 | + } else { |
| 110 | + buf.append("{call "); |
| 111 | + } |
| 112 | + |
| 113 | + buf.append(procedure.getFullyQualifiedName()); |
| 114 | + |
| 115 | + if (totalParams > 0) { |
| 116 | + // unroll the loop |
| 117 | + buf.append("(?"); |
| 118 | + |
| 119 | + for (int i = 1; i < totalParams; i++) { |
| 120 | + buf.append(", ?"); |
| 121 | + } |
| 122 | + |
| 123 | + buf.append(")"); |
| 124 | + } |
| 125 | + |
| 126 | + buf.append("}"); |
| 127 | + return buf.toString(); |
| 128 | + } |
| 129 | +} |
0 commit comments