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	RawSql.ColumnMapping() Construct for unparsed sql.
protected	RawSql.ColumnMapping(boolean parsed, LinkedHashMap<String,RawSql.ColumnMapping.Column> dbColumnMap) Construct an immutable ColumnMapping based on collected information.
protected	RawSql.ColumnMapping(List<RawSql.ColumnMapping.Column> columns) Construct from parsed sql where the columns have been identified.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	columnMapping(String dbColumn, String propertyName)
protected RawSql.ColumnMapping	createImmutableCopy() Creates an immutable copy of this ColumnMapping.
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.
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	queryHash() Return the query hash for this column mapping.
int	size() Return the number of columns in this column mapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawSql.ColumnMapping

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

Construct from parsed sql where the columns have been identified.

RawSql.ColumnMapping

protected RawSql.ColumnMapping()

Construct for unparsed sql.

RawSql.ColumnMapping

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

Construct an immutable ColumnMapping based on collected information.

Method Detail

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)

queryHash

public int queryHash()

Return the query hash for this column mapping.

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.