com.viiyue.plugins.mybatis.template.builder.UpdateSetBuilder 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.Constants;
import com.viiyue.plugins.mybatis.enums.ExpressionStyle;
import com.viiyue.plugins.mybatis.metadata.Entity;
import com.viiyue.plugins.mybatis.metadata.Property;
import com.viiyue.plugins.mybatis.metadata.info.VersionInfo;
import com.viiyue.plugins.mybatis.template.builder.base.TemplateBuilder;
import com.viiyue.plugins.mybatis.utils.BuilderUtil;
import com.viiyue.plugins.mybatis.utils.PropertyFilter;

/**
 * 
 * Modify the statement update settings builder, the template syntax will be
 * parsed in the sql execution process, and then call this class method by
 * reflection.
 * 
 * 
Dynamic template: %{this.set.xxx}
 * 
 * Note: What is a {@code dynamic} template? 
 * Is the template content that will be compiled when sql is executed.
 *
 * @author tangxbai
 * @since 1.1.0
 */
public final class UpdateSetBuilder extends TemplateBuilder {
	
	private String alias;
	private String prefix;
	private final ColumnBuilder column;
	private final PropertyFilter filter;

	public UpdateSetBuilder( Entity entity, SqlCommandType commandType ) {
		super( entity );
		this.column = new ColumnBuilder( entity );
		this.filter = new PropertyFilter( entity, commandType );
	}
	
	public UpdateSetBuilder alias( String alias ) {
		this.alias = BuilderUtil.getPrefix( alias );
		return this;
	}
	
	public UpdateSetBuilder prefix( String prefix ) {
		this.prefix = BuilderUtil.getWrappedPrefix( prefix );
		return this;
	}
	
	public UpdateSetBuilder dynamic( Object parameterObject ) {
		this.filter.dynamic( parameterObject );
		return this;
	}
	
	public UpdateSetBuilder include( String includes ) {
		this.filter.includes( includes );
		return this;
	}
	
	public UpdateSetBuilder exclude( String excludes ) {
		this.filter.excludes( excludes );
		return this;
	}
	
	@Override
	protected void finalConfirmation( Entity entity ) {
		VersionInfo versionInfo = entity.getVersionInfo();
		ExpressionStyle expressionStyle = entity.getExpressionStyle();
		for ( Property property : entity.getProperties() ) {
			if ( filter.isEffective( property ) ) {
				this.column.apply( property ).prefix( prefix );
				if ( versionInfo != null && versionInfo.isVersionProperty( property ) ) {
					this.column.property( versionInfo.getParameterName() ); // nextVersionValue
				} else {
					this.column.alias( alias );
				}
				this.addDelimiter( Constants.SEPARATOR );
				this.append( expressionStyle.format( column, property ) );
			}
		}
	}

}