com.viiyue.plugins.mybatis.metadata.Column 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.metadata;

import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;

import com.viiyue.plugins.mybatis.enums.Setting;
import com.viiyue.plugins.mybatis.utils.Assert;
import com.viiyue.plugins.mybatis.utils.BuilderUtil;
import com.viiyue.plugins.mybatis.utils.ObjectUtil;
import com.viiyue.plugins.mybatis.utils.StringUtil;

/**
 * Database column description object
 *
 * @author tangxbai
 * @since 1.0.0
 */
public final class Column {

	private final Entity parent;

	private String name;
	private String alias;
	private Class javaType;
	private JdbcType jdbcType;
	private Class> typeHandler;
	
	public Column( Entity parent, Property property ) {
		Assert.notNull( parent, "Required parent entity object" );
		Assert.notNull( property, "Required property object" );
		this.parent = parent;
		this.javaType = property.getJavaType();
	}
	
	// Setter

	protected void setName( String name ) {
		this.name = name;
	}

	protected void setAlias( String alias ) {
		this.alias = alias;
	}

	protected void setJdbcType( JdbcType jdbcType ) {
		this.jdbcType = jdbcType;
	}

	protected void setTypeHandler( Class> typeHandler ) {
		this.typeHandler = typeHandler;
	}

	// Getter

	public Entity getParent() {
		return parent;
	}

	public String getName() {
		return name;
	}
	
	public String getAlias() {
		return alias;
	}

	public Class getJavaType() {
		return javaType;
	}

	public JdbcType getJdbcType() {
		return jdbcType;
	}

	public Class> getTypeHandler() {
		return typeHandler;
	}
	
	// Helper
	
	public String getWrappedName() {
		return Setting.ColumnStyle.getStyleValue( name );
	}
	
	public String getWrappedNameWithAlias() {
		if ( ObjectUtil.isDifferent( name, alias ) ) {
			return BuilderUtil.getAlias( getWrappedName(), alias );
		}
		return Setting.ColumnStyle.getStyleValue( alias );
	}
	
	// Override
	
	@Override
	public String toString() {
		return StringUtil.toString( this, "%s, javaType = %s, jdbcType = %s", name, javaType.getSimpleName(), jdbcType.name() );
	}

}