com.wavemaker.runtime.data.dao.query.providers.ParametersProvider Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (C) 2022-2023 WaveMaker, Inc.
*
* 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 com.wavemaker.runtime.data.dao.query.providers;
import java.util.Collection;
import java.util.Optional;
import org.hibernate.Session;
import org.hibernate.query.Query;
import org.hibernate.type.Type;
/**
* @author Dilip Kumar
* @since 4/8/17
*/
public interface ParametersProvider {
/**
* Returns the value for given parameter name.
*
* @param name parameter name.
*
* @return parameter value, null if no value present.
*/
Object getValue(final Session session, String name);
/**
* Returns the {@link Class#getCanonicalName()} for given parameter name.
*
* @param name parameter name.
*
* @return returns class name, {@link Optional#empty()} if not present.
*/
Optional getType(Session session, String name);
/**
* Utility method to configure parameters to given query.
*
* @param session hibernate session
* @param query query to be configured
* @param query return type.
*
* @return Returns the given query
*/
default Query configure(Session session, Query query) {
query.getParameterMetadata().getNamedParameterNames().forEach(parameterName -> {
final Object value = getValue(session, parameterName);
final Optional typeOptional = getType(session, parameterName);
boolean listType = Collection.class.isInstance(value);
if (typeOptional.isPresent()) {
if (listType) {
query.setParameterList(parameterName, (Collection) value, typeOptional.get());
} else {
query.setParameter(parameterName, value, typeOptional.get());
}
} else {
if (listType) {
query.setParameterList(parameterName, (Collection) value);
} else {
query.setParameter(parameterName, value);
}
}
});
return query;
}
}