com.avaje.ebean

Class RawSql.ColumnMapping

java.lang.Object

com.avaje.ebean.RawSql.ColumnMapping

All Implemented Interfaces:

Serializable

Enclosing class:

RawSql

public static final class RawSql.ColumnMapping
extends Object
implements Serializable

Defines the column mapping for raw sql DB columns to bean properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawSql.ColumnMapping.Column A Column of the RawSql that is mapped to a bean property (or ignored).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnMapping() Construct for unparsed sql.
protected	ColumnMapping(boolean parsed, LinkedHashMap<String,RawSql.ColumnMapping.Column> dbColumnMap) Construct an immutable ColumnMapping based on collected information.
protected	ColumnMapping(List<RawSql.ColumnMapping.Column> columns) Construct from parsed sql where the columns have been identified.
protected	ColumnMapping(String... propertyNames) Construct for ResultSet use.

Method Summary

Modifier and Type	Method and Description
protected void	columnMapping(String dbColumn, String propertyName)
boolean	contains(String property) Return true if the property is mapped.
protected RawSql.ColumnMapping	createImmutableCopy() Creates an immutable copy of this ColumnMapping.
boolean	equals(Object o)
Iterator<RawSql.ColumnMapping.Column>	getColumns() Return an iterator of the Columns.
int	getIndexPosition(String property) Return the index position by bean property name.
Map<String,String>	getMapping() Return the mapping by DB column.
int	hashCode()
boolean	isParsed() Returns true if the Columns where supplied by parsing the sql select clause.
protected Map<String,RawSql.ColumnMapping.Column>	mapping() Return the column mapping.
int	size() Return the number of columns in this column mapping.
void	tableAliasMapping(String tableAlias, String path) Modify any column mappings with the given table alias to have the path prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnMapping

protected ColumnMapping(List<RawSql.ColumnMapping.Column> columns)

Construct from parsed sql where the columns have been identified.

ColumnMapping

protected ColumnMapping()

Construct for unparsed sql.

ColumnMapping

protected ColumnMapping(String... propertyNames)

Construct for ResultSet use.

ColumnMapping

protected ColumnMapping(boolean parsed,
                        LinkedHashMap<String,RawSql.ColumnMapping.Column> dbColumnMap)

Construct an immutable ColumnMapping based on collected information.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

contains

public boolean contains(String property)

Return true if the property is mapped.

createImmutableCopy

protected RawSql.ColumnMapping createImmutableCopy()

Creates an immutable copy of this ColumnMapping.

Throws:

IllegalStateException - when a propertyName has not been defined for a column.

columnMapping

protected void columnMapping(String dbColumn,
                             String propertyName)

isParsed

public boolean isParsed()

Returns true if the Columns where supplied by parsing the sql select clause.

In the case where the columns where parsed then we can do extra checks on the column mapping such as, is the column a valid one in the sql and whether all the columns in the sql have been mapped.

size

public int size()

Return the number of columns in this column mapping.

mapping

protected Map<String,RawSql.ColumnMapping.Column> mapping()

Return the column mapping.

getMapping

public Map<String,String> getMapping()

Return the mapping by DB column.

getIndexPosition

public int getIndexPosition(String property)

Return the index position by bean property name.

getColumns

public Iterator<RawSql.ColumnMapping.Column> getColumns()

Return an iterator of the Columns.

tableAliasMapping

public void 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.