com.viiyue.plugins.mybatis.provider.base.BaseDeleteProvider 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.base;

import org.apache.ibatis.mapping.MappedStatement;

import com.viiyue.plugins.mybatis.mapper.base.BaseDeleteMapper;
import com.viiyue.plugins.mybatis.provider.DynamicProvider;

/**
 * {@link BaseDeleteMapper} interface sql provider implementation class
 *
 * @author tangxbai
 * @since 1.0.0
 */
public final class BaseDeleteProvider extends DynamicProvider {

	/**
	 * Refer to the {@link BaseDeleteMapper#deleteAll() deleteAll()} method of
	 * {@link BaseDeleteMapper}
	 * 
	 * @param ms the MappedStatement object
	 * @return the sql template text
	 */
	public String deleteAll( MappedStatement ms ) {
		return "[delete from] @{this.table}";
	}

	/**
	 * Refer to the {@link BaseDeleteMapper#delete(Object) delete(Object)}
	 * method of {@link BaseDeleteMapper}
	 * 
	 * @param ms the MappedStatement object
	 * @return the sql template text
	 */
	public String delete( MappedStatement ms ) {
		return "[delete from] @{this.table} %{this.where($)}";
	}

	/**
	 * Refer to the
	 * {@link BaseDeleteMapper#deleteByPrimaryKey(java.io.Serializable)
	 * deleteByPrimaryKey(java.io.Serializable)} method of
	 * {@link BaseDeleteMapper}
	 * 
	 * @param ms the MappedStatement object
	 * @return the sql template text
	 */
	public String deleteByPrimaryKey( MappedStatement ms ) {
		return "[delete from] @{this.table} [where] @{this.pk} = #{pk}";
	}

	/**
	 * Refer to the
	 * {@link BaseDeleteMapper#deleteByPrimaryKeyGroup(java.io.Serializable...)
	 * deleteByPrimaryKeyGroup(PK...)} method of
	 * {@link BaseDeleteMapper}
	 * 
	 * @param ms the MappedStatement object
	 * @return the sql template text
	 */
	public String deleteByPrimaryKeyGroup( MappedStatement ms ) {
		return "[delete from] @{this.table} [where] @{this.pk} [in] ( {{$.inArguments}} )";
	}

	/**
	 * Refer to the
	 * {@link BaseDeleteMapper#deleteByPrimaryKeyIndex(Integer, java.io.Serializable)
	 * deleteByPrimaryKeyIndex(Integer, PK)} method of {@link BaseDeleteMapper}
	 * 
	 * @param ms the MappedStatement object
	 * @return the sql template text
	 */
	public String deleteByPrimaryKeyIndex( MappedStatement ms ) {
		return "[delete from] @{this.table} [where] %{this.pk($.index)} = #{pk}";
	}

	/**
	 * Refer to the
	 * {@link BaseDeleteMapper#deleteByPrimaryKeyIndexGroup(Integer, java.io.Serializable...)
	 * deleteByPrimaryKeyIndexGroup(Integer, PK...)} method of
	 * {@link BaseDeleteMapper}
	 * 
	 * @param ms the MappedStatement object
	 * @return the sql template text
	 */
	public String deleteByPrimaryKeyIndexGroup( MappedStatement ms ) {
		return "[delete from] @{this.table} [where] %{this.pk($.index)} [in] ( {{$.inArguments}} )";
	}
	
}