com.openthinks.libs.sql.entity.jpa.IReflectHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openlibs.sql Show documentation
The lib of java database ORM simple implementation.
The newest version!
/**
 * Licensed to the Apache Software Foundation (ASF) under one 
 * or more contributor license agreements. See the NOTICE file 
 * distributed with this work for additional information 
 * regarding copyright ownership. The ASF licenses this file 
 * to you 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. 
 * 
 * @Title: IReflectHandler.java 
 * @Package openthinks.libs.sql.lang.reflect 
 * @Description: TODO
 * @author dailey 
 * @date 2012-11-5
 * @version V1.0 
 */
package com.openthinks.libs.sql.entity.jpa;

import com.openthinks.libs.sql.entity.ColumnAttributeMapping;
import com.openthinks.libs.sql.entity.Entity;

/**
 * The interface to handle different entity object
 * @author dailey
 *
 */
public interface IReflectHandler {

	/**
	 * parse entity class to {@link ColumnAttributeMapping}
	 * @param  entity class type
	 * @param entityClass Class

	 * 		1. JPA annotation

	 * 		2. Subclass of {@link Entity}
	 * @return {@link ColumnAttributeMapping}
	 */
	public  ColumnAttributeMapping parseEntityClass(Class entityClass);

	/**
	 * set column value to corresponding entity object
	 * @param  entity class type
	 * @param entity entity instance
	 * 		1. JPA annotation

	 * 		2. Subclass of {@link Entity}
	 * @param columnName 	column name in database table
	 * @param columnValue	column name value in database table row
	 * @return boolean handle success or not
	 */
	public  boolean handColumnField(T entity, String columnName, Object columnValue);

	/**
	 * get entity corresponding table name
	 * @param  entity class type
	 * @param entityClazz Class
	 * 		1. JPA annotation

	 * 		2. Subclass of {@link Entity}
	 * @return String table name
	 */
	public  String getEntityTableName(Class entityClazz);

	/**
	 * get entity corresponding table primary key
	 * @param  entity class type
	 * @param entityClazz Class
	 * 		1. JPA annotation

	 * 		2. Subclass of {@link Entity}
	 * @return String primary key name
	 */
	public  String getEntityIDName(Class entityClazz);

}