com.avaje.ebean

Class RawSqlBuilder

java.lang.Object

com.avaje.ebean.RawSqlBuilder

public class RawSqlBuilder
extends Object

Builds RawSql instances from a SQL string and column mappings.

Note that RawSql can also be defined in ebean-orm.xml files and be used as a named query.

See Also:

RawSql

Field Summary

Fields

Modifier and Type	Field and Description
static String	IGNORE_COLUMN Special property name assigned to a DB column that should be ignored.

Method Summary

Modifier and Type	Method and Description
RawSqlBuilder	columnMapping(String dbColumn, String propertyName) Set the mapping of a DB Column to a bean property.
RawSqlBuilder	columnMappingIgnore(String dbColumn) Ignore this DB column.
RawSql	create() Create the immutable RawSql object.
protected RawSql.Sql	getSql() Return the internal parsed Sql object (for testing).
static RawSqlBuilder	parse(String sql) Return a RawSqlBuilder parsing the sql.
static RawSql	resultSet(ResultSet resultSet, String... propertyNames) Create and return a RawSql object based on the resultSet and list of properties the columns in the resultSet map to.
RawSqlBuilder	tableAliasMapping(String tableAlias, String path) Modify any column mappings with the given table alias to have the path prefix.
static RawSqlBuilder	unparsed(String sql) Return an unparsed RawSqlBuilder.

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_COLUMN

public static final String IGNORE_COLUMN

Special property name assigned to a DB column that should be ignored.

See Also:

Constant Field Values

Method Detail

resultSet

public static RawSql resultSet(ResultSet resultSet,
                               String... propertyNames)

Create and return a RawSql object based on the resultSet and list of properties the columns in the resultSet map to.

The properties listed in the propertyNames must be in the same order as the columns in the resultSet.

unparsed

public static RawSqlBuilder unparsed(String sql)

Return an unparsed RawSqlBuilder. Unlike a parsed one this query can not be modified - so no additional WHERE or HAVING expressions can be added to this query.

parse

public static RawSqlBuilder parse(String sql)

Return a RawSqlBuilder parsing the sql.

The sql statement will be parsed so that Ebean can determine where it can insert additional WHERE or HAVING expressions.

Additionally the selected columns are parsed to determine the column ordering. This also means additional checks can be made with the column mapping - specifically we can check that all columns are mapped and that correct column names are entered into the mapping.

columnMapping

public RawSqlBuilder columnMapping(String dbColumn,
                                   String propertyName)

Set the mapping of a DB Column to a bean property.

For Unparsed SQL the columnMapping MUST be defined in the same order that the columns appear in the SQL statement.

Parameters:

dbColumn - the DB column that we are mapping to a bean property

propertyName - the bean property that we are mapping the DB column to.

columnMappingIgnore

public RawSqlBuilder columnMappingIgnore(String dbColumn)

Ignore this DB column. It is not mapped to any bean property.

tableAliasMapping

public RawSqlBuilder tableAliasMapping(String tableAlias,
                                       String path)

Modify any column mappings with the given table alias to have the path prefix.

For example modify all mappings with table alias "c" to have the path prefix "customer".

For the "Root type" you don't need to specify a tableAliasMapping.

create

public RawSql create()

Create the immutable RawSql object. Do this after all the column mapping has been defined.

getSql

protected RawSql.Sql getSql()

Return the internal parsed Sql object (for testing).