com.xdev.jadoth.sqlengine.internal

Class SqlColumn

java.lang.Object

com.xdev.jadoth.sqlengine.internal.QueryPart

com.xdev.jadoth.sqlengine.internal.SqlExpression

com.xdev.jadoth.sqlengine.internal.SqlIdentifier

com.xdev.jadoth.sqlengine.internal.SqlColumn

All Implemented Interfaces:

Copyable, SelectItem, Serializable

Direct Known Subclasses:

SqlField, SqlStar

public class SqlColumn
extends SqlIdentifier

The Class SqlColumn.

Author:

Thomas Muenz

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xdev.jadoth.sqlengine.internal.SqlIdentifier

validationPattern

Fields inherited from class com.xdev.jadoth.sqlengine.internal.SqlExpression

expression

Fields inherited from class com.xdev.jadoth.sqlengine.internal.QueryPart

ASEXPRESSION, defaultClauseStringBuilderLength, defaultExpressionStringBuilderLength, defaultQueryStringBuilderLength, DELIMIT_ALIASES, DELIMIT_COLUMN_IDENTIFIERS, DELIMIT_TABLE_IDENTIFIERS, ESCAPE_DBL_QUOTES, ESCAPE_QUOTES, FLAGS_TAKEN, MINIINDENT, OMITALIAS, PACKED, QUALIFY_BY_TABLE, SINGLELINE, UNQUALIFIED

Constructor Summary

Constructors

Constructor and Description
SqlColumn() Instantiates a new sql column.
SqlColumn(String columnName) Instantiates a new sql column.
SqlColumn(TableExpression owner, Object columnName) Instantiates a new sql column.
SqlColumn(TableExpression owner, String columnName) Instantiates a new sql column.

Method Summary

Modifier and Type	Method and Description
protected StringBuilder	assemble(DbmsDMLAssembler<?> dmlAssembler, StringBuilder sb, int indentLevel, int flags) Assemble.
static SqlColumn	createSqlColumn(String expression) Creates the sql column.
String	getColumnName() Returns the actual name of the column without leading alias.
TableExpression	getOwner() Gets the owner.
boolean	isDelimited()
static boolean	needsDelimiting(String columnName) Note that this method can only contain logic that applies to ALL DBMS (such as recognition of spaces in the column name).
SqlColumn	setDelimited(boolean delimited)
void	setOwner(TableExpression owner) Sets the owner.
ColumnValueAssignment	value(Object value)
static SqlColumn	wrap(Object column) Wraps column in an instance of SqlColumn with owner null. If column already is an instance of SqlColumn, it is returned directly.
static SqlColumn[]	wrap(Object[] columns)

Methods inherited from class com.xdev.jadoth.sqlengine.internal.SqlIdentifier

validateIdentifierString

Methods inherited from class com.xdev.jadoth.sqlengine.internal.SqlExpression

_ASC, _DESC, _NULLS_FIRST, _NULLS_LAST, AS, BETWEEN, c, CONCAT, CONTAINS, copy, copyAS, eq, getExpression, getExpressionObject, gt, gte, IN, IS_NOT_NULL, IS_NULL, LIKE, lt, lte, ne, NOT_BETWEEN, NOT_CONTAINS, NOT_IN, NOT_LIKE, o, toString

Methods inherited from class com.xdev.jadoth.sqlengine.internal.QueryPart

assembleAlias, assembleObject, assembleQuery, bitAsExpression, bitDelimitAliases, bitDelimitColumnIdentifiers, bitDelimitTableIdentifiers, bitEscapeDoubleQuotes, bitMiniIndent, bitOmitAlias, bitPacked, bitQualified, bitQualifyByTable, bitSingleLine, concat, concatSqlExpressions, EscapeQuotes, flagsToString, function, indent, isAsExpression, isDelimitAliases, isDelimitColumnIdentifiers, isDelimitTableIdentifiers, isEscapeDoubleQuotes, isEscapeQuotes, isMiniIndent, isOmitAlias, isPacked, isQualifyByTable, isSingleLine, isUnqualified, keyword, list, printFlags, setAsExpression, setDelimitAliases, setDelimitColumnIdentifiers, setDelimitTableIdentifiers, setEscapeDoubleQuotes, setEscapeQuotes, setMiniIndent, setPacked, setQualified, setQualifyByTable, setSingleLine, setUseAlias

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlColumn

public SqlColumn()

Instantiates a new sql column.

SqlColumn

public SqlColumn(String columnName)
          throws SQLEngineInvalidIdentifier

Instantiates a new sql column.

Parameters:

columnName - the columnName

Throws:

SQLEngineInvalidIdentifier - the sQL engine invalid identifier

SqlColumn

public SqlColumn(TableExpression owner,
                 String columnName)
          throws SQLEngineInvalidIdentifier

Instantiates a new sql column.

Parameters:

owner - the owner

expression - the expression

Throws:

SQLEngineInvalidIdentifier - the sQL engine invalid identifier

SqlColumn

public SqlColumn(TableExpression owner,
                 Object columnName)

Instantiates a new sql column.

Parameters:

owner - the owner

expression - the expression

Method Detail

wrap

public static final SqlColumn wrap(Object column)

Wraps column in an instance of SqlColumn with owner null.
If column already is an instance of SqlColumn, it is returned directly.

if column is not an instance of SqlColumn, the value of toString() is used when the query is assembled.

Parameters:

column - any object whose toString() method returns a desired, apropriate qualified column name during query assembly.

Returns:

column wrapped as a SqlColumn object.

wrap

public static final SqlColumn[] wrap(Object[] columns)

needsDelimiting

public static boolean needsDelimiting(String columnName)

Note that this method can only contain logic that applies to ALL DBMS (such as recognition of spaces in the column name). Otherwise the result would no longer be DBMS-independant. Recognition of DBMS-proprietary keywords etc. must be done by the DBMS at assembly time.

Parameters:

columnName -

Returns:

createSqlColumn

public static SqlColumn createSqlColumn(String expression)
                                 throws SQLEngineRuntimeException

Creates the sql column.

Parameters:

expression - the expression

Returns:

the sql column

Throws:

SQLEngineRuntimeException - the sQL engine runtime exception

getColumnName

public String getColumnName()

Returns the actual name of the column without leading alias.

Returns:

the column name

isDelimited

public boolean isDelimited()

getOwner

public TableExpression getOwner()

Gets the owner.

Returns:

the owner

setOwner

public void setOwner(TableExpression owner)

Sets the owner.

Parameters:

owner - the new owner

setDelimited

public SqlColumn setDelimited(boolean delimited)

value

public ColumnValueAssignment value(Object value)

assemble

protected StringBuilder assemble(DbmsDMLAssembler<?> dmlAssembler,
                                 StringBuilder sb,
                                 int indentLevel,
                                 int flags)

Description copied from class: QueryPart

Assemble.

Overrides:

assemble in class SqlExpression

Parameters:

dmlAssembler -

sb -

indentLevel -

flags -

Returns:

See Also:

SqlExpression.assemble(com.xdev.jadoth.sqlengine.dbms.DbmsDMLAssembler, java.lang.StringBuilder, int, int)