com.avaje.ebeaninternal.server.deploy.id.ImportedId Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

Ebean

There is a newer version: 2.8.1

package com.avaje.ebeaninternal.server.deploy.id;

import java.sql.SQLException;

import com.avaje.ebeaninternal.server.deploy.BeanProperty;
import com.avaje.ebeaninternal.server.deploy.DbSqlContext;
import com.avaje.ebeaninternal.server.deploy.IntersectionRow;
import com.avaje.ebeaninternal.server.persist.dml.GenerateDmlRequest;
import com.avaje.ebeaninternal.server.persist.dmlbind.BindableRequest;

/**
 * Represents a imported property.
 */
public interface ImportedId {

	public void addFkeys(String name);
	
	/**
	 * Return true if this id is a simple single scalar value. False if it is a
	 * compound id (embedded or multiple).
	 */
	public boolean isScalar();

	/**
	 * Return the logical property name.
	 */
	public String getLogicalName();

	/**
	 * For scalar id return the related single db column.
	 * 
	 * This is essentially the imported foreign key column (where there is only
	 * one).
	 * 
	 */
	public String getDbColumn();

	/**
	 * Append the the SQL query statement.
	 */
	public void sqlAppend(DbSqlContext ctx);

	/**
	 * Append to the DML statement.
	 */
	public void dmlAppend(GenerateDmlRequest request);

	/**
	 * Append to the DML statement to the where clause.
	 */
	public void dmlWhere(GenerateDmlRequest request, Object bean);

	/**
	 * Return true if the id value has changed.
	 */
	public boolean hasChanged(Object bean, Object oldValues);
	
	/**
	 * Bind the value from the bean.
	 */
	public void bind(BindableRequest request, Object bean, boolean bindNull) throws SQLException;

	/**
	 * For inserting into ManyToMany intersection.
	 */
	public void buildImport(IntersectionRow row, Object other);

	/**
	 * Used to derive a missing concatenated key from multiple imported keys.
	 */
	public BeanProperty findMatchImport(String matchDbColumn);
}