com.avaje.ebeaninternal.server.deploy.id

Class IdBinderMultiple

java.lang.Object

com.avaje.ebeaninternal.server.deploy.id.IdBinderMultiple

All Implemented Interfaces:

IdBinder

public final class IdBinderMultiple
extends Object
implements IdBinder

Bind an Id that is made up of multiple separate properties.

The id passed in for binding is expected to be a map with the key being the String name of the property and the value being that properties bind value.

Constructor Summary

Constructors

Constructor and Description
IdBinderMultiple(BeanProperty[] idProps)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIdInBindValue(SpiExpressionRequest request, Object value)
void	appendSelect(DbSqlContext ctx, boolean subQuery) Append to the select clause.
void	bindId(DataBind bind, Object idValue) Binds an id value to a prepared statement.
void	bindId(DefaultSqlUpdate sqlUpdate, Object idValue) Bind the id value to a SqlUpdate statement.
void	buildSelectExpressionChain(String prefix, List<String> selectChain)
Object	convertSetId(Object idValue, Object bean) Cast or convert the Id value if necessary and optionally set it.
BeanProperty	findBeanProperty(String dbColumnName) Find a BeanProperty that is mapped to the database column.
String	getAssocIdInExpr(String prefix) Return the logical id in expression taking into account embedded id's.
String	getAssocOneIdExpr(String prefix, String operator) Build a string of the logical expressions.
String	getBindIdInSql(String baseTableAlias) Return the sql for binding the id using an IN clause.
String	getBindIdSql(String baseTableAlias) Return the sql for binding the id to.
Object[]	getBindValues(Object idValue) Return the values as an array of scalar bindable values.
String	getDefaultOrderBy() Return the default order by that may need to be used if the query includes a many property.
String	getIdInValueExpr(int size) Return the binding expression (like "?" or "(?,?)")for the Id.
String	getIdInValueExprDelete(int size) Same as getIdInValueExpr but for delete by id.
String	getIdProperty() Return the name(s) of the Id property(s).
Object[]	getIdValues(Object bean) Return the id values for a given bean.
String	getOrderBy(String pathPrefix, boolean ascending)
BeanProperty[]	getProperties() Return the id properties in flat form.
int	getPropertyCount() Return the number of scalar properties for this id.
void	initialise() Initialise the binder.
boolean	isComplexId() Return false if the id is a simple scalar and false if it is embedded or concatenated.
void	loadIgnore(DbReadContext ctx) Ignore the appropriate number of scalar properties for this id.
Object	read(DbReadContext ctx) Read the id value from the result set and return it.
Object	readData(DataInput dataInput) Read the Id value from the binary DataInput.
Object	readSet(DbReadContext ctx, Object bean) Read the id value from the result set and set it to the bean also returning it.
void	writeData(DataOutput dataOutput, Object idValue) Write the Id value to binary DataOuput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdBinderMultiple

public IdBinderMultiple(BeanProperty[] idProps)

Method Detail

initialise

public void initialise()

Description copied from interface: IdBinder

Initialise the binder.

Specified by:

initialise in interface IdBinder

getOrderBy

public String getOrderBy(String pathPrefix,
                boolean ascending)

Specified by:

getOrderBy in interface IdBinder

buildSelectExpressionChain

public void buildSelectExpressionChain(String prefix,
                              List<String> selectChain)

Specified by:

buildSelectExpressionChain in interface IdBinder

getPropertyCount

public int getPropertyCount()

Description copied from interface: IdBinder

Return the number of scalar properties for this id.

Specified by:

getPropertyCount in interface IdBinder

getIdProperty

public String getIdProperty()

Description copied from interface: IdBinder

Return the name(s) of the Id property(s). Comma delimited if there is more than one.

This can be used to include in a query.

Specified by:

getIdProperty in interface IdBinder

findBeanProperty

public BeanProperty findBeanProperty(String dbColumnName)

Description copied from interface: IdBinder

Find a BeanProperty that is mapped to the database column.

Specified by:

findBeanProperty in interface IdBinder

isComplexId

public boolean isComplexId()

Description copied from interface: IdBinder

Return false if the id is a simple scalar and false if it is embedded or concatenated.

Specified by:

isComplexId in interface IdBinder

getDefaultOrderBy

public String getDefaultOrderBy()

Description copied from interface: IdBinder

Return the default order by that may need to be used if the query includes a many property.

Specified by:

getDefaultOrderBy in interface IdBinder

getProperties

public BeanProperty[] getProperties()

Description copied from interface: IdBinder

Return the id properties in flat form.

Specified by:

getProperties in interface IdBinder

addIdInBindValue

public void addIdInBindValue(SpiExpressionRequest request,
                    Object value)

Specified by:

addIdInBindValue in interface IdBinder

getIdInValueExprDelete

public String getIdInValueExprDelete(int size)

Description copied from interface: IdBinder

Same as getIdInValueExpr but for delete by id.

Specified by:

getIdInValueExprDelete in interface IdBinder

getIdInValueExpr

public String getIdInValueExpr(int size)

Description copied from interface: IdBinder

Return the binding expression (like "?" or "(?,?)")for the Id.

Specified by:

getIdInValueExpr in interface IdBinder

getBindIdInSql

public String getBindIdInSql(String baseTableAlias)

Description copied from interface: IdBinder

Return the sql for binding the id using an IN clause.

Specified by:

getBindIdInSql in interface IdBinder

getIdValues

public Object[] getIdValues(Object bean)

Description copied from interface: IdBinder

Return the id values for a given bean.

Specified by:

getIdValues in interface IdBinder

getBindValues

public Object[] getBindValues(Object idValue)

Description copied from interface: IdBinder

Return the values as an array of scalar bindable values.

For concatenated keys that use an Embedded bean or multiple id properties this determines the field values are returns them as an Object array.

Added primarily for Query.addWhere().add(Expr.idEq()) support.

Specified by:

getBindValues in interface IdBinder

readData

public Object readData(DataInput dataInput)
                throws IOException

Description copied from interface: IdBinder

Read the Id value from the binary DataInput.

Specified by:

readData in interface IdBinder

Throws:

IOException

writeData

public void writeData(DataOutput dataOutput,
             Object idValue)
               throws IOException

Description copied from interface: IdBinder

Write the Id value to binary DataOuput.

Specified by:

writeData in interface IdBinder

Throws:

IOException

loadIgnore

public void loadIgnore(DbReadContext ctx)

Description copied from interface: IdBinder

Ignore the appropriate number of scalar properties for this id.

Specified by:

loadIgnore in interface IdBinder

readSet

public Object readSet(DbReadContext ctx,
             Object bean)
               throws SQLException

Description copied from interface: IdBinder

Read the id value from the result set and set it to the bean also returning it.

Specified by:

readSet in interface IdBinder

Throws:

SQLException

read

public Object read(DbReadContext ctx)
            throws SQLException

Description copied from interface: IdBinder

Read the id value from the result set and return it.

Specified by:

read in interface IdBinder

Throws:

SQLException

bindId

public void bindId(DefaultSqlUpdate sqlUpdate,
          Object idValue)

Description copied from interface: IdBinder

Bind the id value to a SqlUpdate statement.

Specified by:

bindId in interface IdBinder

bindId

public void bindId(DataBind bind,
          Object idValue)
            throws SQLException

Description copied from interface: IdBinder

Binds an id value to a prepared statement.

Specified by:

bindId in interface IdBinder

Throws:

SQLException

appendSelect

public void appendSelect(DbSqlContext ctx,
                boolean subQuery)

Description copied from interface: IdBinder

Append to the select clause.

Specified by:

appendSelect in interface IdBinder

getAssocIdInExpr

public String getAssocIdInExpr(String prefix)

Description copied from interface: IdBinder

Return the logical id in expression taking into account embedded id's.

Specified by:

getAssocIdInExpr in interface IdBinder

getAssocOneIdExpr

public String getAssocOneIdExpr(String prefix,
                       String operator)

Description copied from interface: IdBinder

Build a string of the logical expressions.

Typically used to build a id = ? string.

Specified by:

getAssocOneIdExpr in interface IdBinder

getBindIdSql

public String getBindIdSql(String baseTableAlias)

Description copied from interface: IdBinder

Return the sql for binding the id to. This includes table alias and columns that make up the id.

Specified by:

getBindIdSql in interface IdBinder

convertSetId

public Object convertSetId(Object idValue,
                  Object bean)

Description copied from interface: IdBinder

Cast or convert the Id value if necessary and optionally set it.

The Id value is not assumed to be the correct type so it is converted to the correct type. Typically this is because we could get a Integer, Long or BigDecimal depending on the JDBC driver and situation.

If the bean is not null, then the value is set to the bean.

Specified by:

convertSetId in interface IdBinder