org.dbflute.s2dao.metadata.TnProcedureMetaDataFactory Maven / Gradle / Ivy
/*
* Copyright 2014-2020 the original author or authors.
*
* Licensed 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.dbflute.s2dao.metadata;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;
import org.dbflute.bhv.core.context.ResourceContext;
import org.dbflute.dbway.DBDef;
import org.dbflute.helper.beans.DfBeanDesc;
import org.dbflute.helper.beans.DfPropertyDesc;
import org.dbflute.helper.beans.factory.DfBeanDescFactory;
import org.dbflute.helper.message.ExceptionMessageBuilder;
import org.dbflute.jdbc.ValueType;
import org.dbflute.s2dao.metadata.TnProcedureParameterType.TnProcedureParameterAccessor;
import org.dbflute.util.DfReflectionUtil;
import org.dbflute.util.DfTypeUtil;
import org.dbflute.util.Srl;
/**
* @author modified by jflute (originated in S2Dao)
*/
public class TnProcedureMetaDataFactory {
// ===================================================================================
// Attribute
// =========
protected final TnFieldProcedureAnnotationReader _annotationReader = new TnFieldProcedureAnnotationReader();
protected final TnProcedureValueTypeProvider _valueTypeProvider = new TnProcedureValueTypeProvider();
// ===================================================================================
// Main
// ====
public TnProcedureMetaData createProcedureMetaData(String procedureName, Class pmbType) {
final TnProcedureMetaData procedureMetaData = new TnProcedureMetaData(procedureName);
if (pmbType == null) {
return procedureMetaData;
} else {
if (!isDtoType(pmbType)) {
throw new IllegalStateException("The pmb type was Not DTO type: " + pmbType.getName());
}
}
final DfBeanDesc pmbDesc = DfBeanDescFactory.getBeanDesc(pmbType);
final List proppertyNameList = pmbDesc.getProppertyNameList();
for (String propertyName : proppertyNameList) {
final DfPropertyDesc parameterDesc = pmbDesc.getPropertyDesc(propertyName);
if (parameterDesc.isReadable() && parameterDesc.isWritable()) {
registerParameterType(procedureMetaData, parameterDesc);
}
}
procedureMetaData.fix();
return procedureMetaData;
}
protected void registerParameterType(TnProcedureMetaData procedureMetaData, DfPropertyDesc parameterDesc) {
final TnProcedureParameterType ppt = getProcedureParameterType(parameterDesc);
if (ppt == null) {
return;
}
procedureMetaData.addParameterType(ppt);
}
protected TnProcedureParameterType getProcedureParameterType(DfPropertyDesc parameterDesc) {
final String specificationExp = _annotationReader.getParameterSpecification(parameterDesc);
if (specificationExp == null) {
return null;
}
final TnProcedureParameterSpec spec = parseParameterSpec(specificationExp, parameterDesc);
final String type = spec.getParameterType();
final TnProcedureParameterType ppt = createProcedureParameterType(parameterDesc);
if (type.equalsIgnoreCase("in")) {
ppt.setInType(true);
} else if (type.equalsIgnoreCase("out")) {
ppt.setOutType(true);
} else if (type.equalsIgnoreCase("inout")) {
ppt.setInType(true);
ppt.setOutType(true);
} else if (type.equalsIgnoreCase("return")) {
ppt.setOutType(true);
ppt.setReturnType(true);
} else if (type.equalsIgnoreCase("notParamResult")) {
ppt.setNotParamResultType(true);
} else {
String msg = "The parameter type should be 'in, out, inout, return, notParamResult':";
msg = msg + " type=" + type;
msg = msg + " class=" + DfTypeUtil.toClassTitle(parameterDesc.getBeanDesc().getBeanClass());
msg = msg + " property=" + parameterDesc.getPropertyName();
throw new IllegalStateException(msg);
}
ppt.setParameterOrder(spec.getParameterOrder());
ppt.setValueType(findValueType(parameterDesc));
return ppt;
}
protected TnProcedureParameterType createProcedureParameterType(final DfPropertyDesc parameterDesc) {
final Type genericReturnType = parameterDesc.getReadMethod().getGenericReturnType();
final Class elementType = DfReflectionUtil.getGenericFirstClass(genericReturnType);
return new TnProcedureParameterType(new TnProcedureParameterAccessor() {
public Object getValue(Object target) {
return parameterDesc.getValue(target);
}
public void setValue(Object target, Object value) {
parameterDesc.setValue(target, value);
}
}, parameterDesc.getPropertyName(), parameterDesc.getPropertyType(), elementType);
}
// ===================================================================================
// Parameter Specification
// =======================
protected TnProcedureParameterSpec parseParameterSpec(String specExp, DfPropertyDesc parameterDesc) {
final List list = Srl.splitListTrimmed(specExp, ",");
if (list.size() != 2) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The size of parameter spec elements was illegal.");
br.addItem("ProcedurePmb");
br.addElement(DfTypeUtil.toClassTitle(parameterDesc.getBeanDesc().getBeanClass()));
br.addItem("Parameter");
br.addElement(parameterDesc.getPropertyName());
br.addElement(parameterDesc.getPropertyType());
br.addItem("Parameter Spec");
br.addElement(specExp);
final String msg = br.buildExceptionMessage();
throw new IllegalStateException(msg);
}
final String parameterType = list.get(0);
final String parameterIndex = list.get(1);
final TnProcedureParameterSpec spec = new TnProcedureParameterSpec();
spec.setParameterType(parameterType);
try {
spec.setParameterOrder(DfTypeUtil.toInteger(parameterIndex));
} catch (NumberFormatException e) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Failed to parse the parameter index as Integer.");
br.addItem("ProcedurePmb");
br.addElement(DfTypeUtil.toClassTitle(parameterDesc.getBeanDesc().getBeanClass()));
br.addItem("Parameter");
br.addElement(parameterDesc.getPropertyName());
br.addElement(parameterDesc.getPropertyType());
br.addItem("Parameter Spec");
br.addElement(specExp);
final String msg = br.buildExceptionMessage();
throw new IllegalStateException(msg);
}
return spec;
}
protected static class TnProcedureParameterSpec {
protected String _parameterType;
protected Integer _parameterOrder;
public String getParameterType() {
return _parameterType;
}
public void setParameterType(String parameterType) {
this._parameterType = parameterType;
}
public Integer getParameterOrder() {
return _parameterOrder;
}
public void setParameterOrder(Integer parameterOrder) {
this._parameterOrder = parameterOrder;
}
}
// ===================================================================================
// Value Type
// ==========
protected ValueType findValueType(DfPropertyDesc parameterDesc) {
final Class pmbType = parameterDesc.getBeanDesc().getBeanClass();
final String paramName = parameterDesc.getPropertyName();
final Class paramType = parameterDesc.getPropertyType();
final Object valueTypeDef = _annotationReader.getValueType(parameterDesc);
if (valueTypeDef instanceof ValueType) {
return (ValueType) valueTypeDef;
} else {
final String keyName = (valueTypeDef != null ? valueTypeDef.toString() : null);
final DBDef dbdef = ResourceContext.currentDBDef();
return _valueTypeProvider.provide(pmbType, paramName, paramType, keyName, dbdef);
}
}
// ===================================================================================
// Determination Helper
// ====================
protected boolean isCurrentDBDef(DBDef currentDBDef) {
return ResourceContext.isCurrentDBDef(currentDBDef);
}
protected boolean isInstanceField(Field field) {
final int mod = field.getModifiers();
return !Modifier.isStatic(mod) && !Modifier.isFinal(mod);
}
protected boolean isDtoType(Class clazz) {
return !isSimpleType(clazz) && !isContainerType(clazz);
}
protected boolean isSimpleType(Class clazz) {
if (clazz == null) {
throw new NullPointerException("clazz");
}
return clazz == String.class || clazz.isPrimitive() || clazz == Boolean.class || clazz == Character.class
|| Number.class.isAssignableFrom(clazz) || Date.class.isAssignableFrom(clazz) || Calendar.class.isAssignableFrom(clazz)
|| clazz == byte[].class;
}
protected boolean isContainerType(Class clazz) {
if (clazz == null) {
throw new NullPointerException("clazz");
}
return Collection.class.isAssignableFrom(clazz) || Map.class.isAssignableFrom(clazz) || clazz.isArray();
}
// ===================================================================================
// Annotation Reader
// =================
protected static class TnFieldProcedureAnnotationReader {
protected static final String PARAMETER_SUFFIX = "_PROCEDURE_PARAMETER";
protected static final String VALUE_TYPE_SUFFIX = "_VALUE_TYPE";
/**
* Get the specification of parameter.
* @param propertyDesc The description of property. (NotNull)
* @return The specification of parameter. (NullAllowed)
*/
public String getParameterSpecification(DfPropertyDesc propertyDesc) {
final String propertyName = propertyDesc.getPropertyName();
final String annotationName = propertyName + PARAMETER_SUFFIX;
final DfBeanDesc pmbDesc = propertyDesc.getBeanDesc();
if (pmbDesc.hasField(annotationName)) {
final Field field = pmbDesc.getField(annotationName);
return (String) DfReflectionUtil.getValue(field, null);
} else {
return null;
}
}
/**
* Get the name or instance of value type for parameter.
* @param propertyDesc The description of property. (NotNull)
* @return The string or instance of value type. (NullAllowed)
*/
public Object getValueType(DfPropertyDesc propertyDesc) {
final String propertyName = propertyDesc.getPropertyName();
final String annotationName = propertyName + VALUE_TYPE_SUFFIX;
final DfBeanDesc pmbDesc = propertyDesc.getBeanDesc();
if (pmbDesc.hasField(annotationName)) {
final Field field = pmbDesc.getField(annotationName);
return DfReflectionUtil.getValue(field, null);
} else {
return null;
}
}
protected Object getValue(Field field, Object target) {
try {
return field.get(target);
} catch (IllegalAccessException e) {
String msg = "The getting of the field threw the exception:";
msg = msg + " class=" + DfTypeUtil.toClassTitle(field.getDeclaringClass());
msg = msg + " field=" + field.getName();
throw new IllegalStateException(msg, e);
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy