org.mybatis.dynamic.sql

Interface BasicColumn

All Known Subinterfaces:

BindableColumn<T>

All Known Implementing Classes:

AbstractAggregate, Add, Avg, BaseFunction, Count, CountAll, Lower, Max, Min, SqlColumn, Substring, Sum, Upper

public interface BasicColumn

Describes attributes of columns that are necessary for rendering if the column is not expected to be bound as a JDBC parameter. Columns in select lists, join expressions, and group by expressions are typically not bound.

Author:

Jeff Butler

Method Summary

Modifier and Type	Method and Description
Optional<String>	alias() Returns the columns alias if one has been specified.
BasicColumn	as(String alias) Returns a new instance of a BasicColumn with the alias set.
String	renderWithTableAlias(TableAliasCalculator tableAliasCalculator) Returns the name of the item aliased with a table name if appropriate.
default String	renderWithTableAndColumnAlias(TableAliasCalculator tableAliasCalculator) Returns the name of the item aliased with a table name and column alias if appropriate.

Method Detail

alias

Optional<String> alias()

Returns the columns alias if one has been specified.

Returns:

the column alias

as

BasicColumn as(String alias)

Returns a new instance of a BasicColumn with the alias set.

Parameters:

alias - the column alias to set

Returns:

new instance with alias set

renderWithTableAlias

String renderWithTableAlias(TableAliasCalculator tableAliasCalculator)

Returns the name of the item aliased with a table name if appropriate. For example, "a.foo". This is appropriate for where clauses and order by clauses.

Parameters:

tableAliasCalculator - the table alias calculator for the current renderer

Returns:

the item name with the table alias applied

renderWithTableAndColumnAlias

default String renderWithTableAndColumnAlias(TableAliasCalculator tableAliasCalculator)

Returns the name of the item aliased with a table name and column alias if appropriate. For example, "a.foo as bar". This is appropriate for select list clauses.

Parameters:

tableAliasCalculator - the table alias calculator for the current renderer

Returns:

the item name with the table and column aliases applied