com.viiyue.plugins.mybatis.template.builder.WhereBuilder 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.template.builder;

import org.apache.ibatis.mapping.SqlCommandType;

import com.viiyue.plugins.mybatis.enums.ValueStyle;
import com.viiyue.plugins.mybatis.metadata.Entity;
import com.viiyue.plugins.mybatis.metadata.Property;
import com.viiyue.plugins.mybatis.metadata.info.ConditionalInfo;
import com.viiyue.plugins.mybatis.metadata.info.LogicallyDeleteInfo;
import com.viiyue.plugins.mybatis.template.builder.base.TemplateBuilder;
import com.viiyue.plugins.mybatis.utils.BuilderUtil;
import com.viiyue.plugins.mybatis.utils.PropertyFilter;

/**
 * 
 * Where condition builder, the template syntax will be
 * parsed in the sql execution process, and then call this class method by
 * reflection.
 * 
 * 
Dynamic template: %{this.where($).xxx}
 * 
 * Note: What is a {@code dynamic} template? 
 * Is the template content that will be compiled when sql is executed.
 *
 * @author tangxbai
 * @since 1.0.0
 */
public final class WhereBuilder extends TemplateBuilder {

	private final ColumnBuilder column;
	private final PropertyFilter filter;
	
	private String prefix;
	private Object parameter;
	private boolean isDeletedValue;
	private boolean isLogicallyDelete;

	public WhereBuilder( Entity entity, SqlCommandType commandType, Object parameter ) {
		super( entity );
		this.column = new ColumnBuilder( entity );
		this.filter = new PropertyFilter( entity, commandType );
		this.parameter = parameter;
	}
	
	public WhereBuilder logicallyDelete( boolean isLogicallyDelete ) {
		this.isLogicallyDelete = isLogicallyDelete;
		return useQueryValue();
	}
	
	public WhereBuilder tryLogicallyDeleteQuery() {
		this.isLogicallyDelete = true;
		return useQueryValue();
	}
	
	public WhereBuilder useQueryValue() {
		this.isDeletedValue = false;
		return this;
	}
	
	public WhereBuilder useDeletedValue() {
		this.isDeletedValue = true;
		return this;
	}

	public WhereBuilder prefix( String prefix ) {
		this.prefix = prefix;
		return this;
	}
	
	public WhereBuilder include( String includes ) {
		this.filter.includes( includes );
		return this;
	}

	public WhereBuilder exclude( String excludes ) {
		this.filter.excludes( excludes );
		return this;
	}
	
	@Override
	protected void finalConfirmation( Entity entity ) {
		ValueStyle valueStyle = entity.getValueStyle();
		LogicallyDeleteInfo logicallyDeleteInfo = entity.getLogicallyDeleteInfo();
		if ( isLogicallyDelete && logicallyDeleteInfo != null ) {
			this.append( BuilderUtil.getWrappedPrefix( prefix ) );
			this.append( logicallyDeleteInfo.getColumn().getWrappedName() );
			this.append( " = " );
			this.append( logicallyDeleteInfo.getValueBy( isDeletedValue ) );
		}
		for ( Property property : entity.getProperties() ) {
			if ( logicallyDeleteInfo == null || !logicallyDeleteInfo.isLogicallDeleteProperty( property ) ) {
				if ( filter.isEffective( property ) ) {
					ConditionalInfo info = property.getConditionalInfo();
					if ( info.getTestValue( parameter ) ) {
						this.column.apply( property ).prefix( prefix );
						this.addDelimiter( " [and] " );
						this.append( info.getHolder().format( column, valueStyle ) );
					}
				}
			}
		}
		this.prepend( "[where] " );
	}

}