com.viiyue.plugins.mybatis.provider.DynamicProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mybatis-mapper Show documentation

Mybatis generic mapper plugin for solving most basic operations, simplifying sql syntax and improving dynamic execution efficiency

There is a newer version: 1.3.7

Show newest version

/**
 * Copyright (C) 2017 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 com.viiyue.plugins.mybatis.provider;

import java.util.HashMap;
import java.util.Map;

import com.viiyue.plugins.mybatis.scripting.parser.BridgeMethod;
import com.viiyue.plugins.mybatis.utils.Assert;

/**
 * Dynamic provider base class, if you want to define your own provider, then
 * you are bound to inherit this class.
 *
 * @author tangxbai
 * @since 1.0.0
 */
public abstract class DynamicProvider {

	/**
	 * Provider placeholder method name : {@value}
	 * 
	 * @see #providerSQL()
	 */
	public static final String dynamicSQL = "dynamicProviderSQL";
	
	/**
	 * Method mapping used by the current subclass
	 */
	private final Map subclassMethodMappings = new HashMap();
	
	/**
	 * Useless, Just for myBatis to processing the provider SQL.
	 * 
	 * @return SQL placeholder string
	 */
	public final String dynamicProviderSQL() {
		return "Plugin  is not loaded, please check the plugin configuration";
	}
	
	/**
	 * Remember all the methods that will apply to the current Provider
	 * 
	 * @param method mapper mapping method
	 * @since 1.1.0
	 */
	public final void putMethod( BridgeMethod method ) {
		this.subclassMethodMappings.put( method.getInterfaceMethodName(), method );
	}
	
	/**
	 * Get the cache method by method name
	 * 
	 * @param interfaceMethodName the interface method name
	 * @return the cached method
	 */
	public final BridgeMethod getMethod( String interfaceMethodName ) {
		BridgeMethod method = subclassMethodMappings.get( interfaceMethodName );
		Assert.notNull( method, "The provider method #{0}# was not be found in class #{1}#", interfaceMethodName, getClass().getSimpleName() );
		return method;
	}
	
}