BooleanColumn (DBvolution 7 0.9.11-SNAPSHOT API)

java.lang.Object
- nz.co.gregs.dbvolution.expressions.BooleanExpression
- - nz.co.gregs.dbvolution.columns.BooleanColumn

All Implemented Interfaces:

ColumnProvider, DBExpression, ExpressionColumn<DBBoolean>, BooleanResult, EqualComparable<BooleanResult>, ExpressionCanHaveNullValues, ExpressionHasStandardStringResult
```
public class BooleanColumn
extends BooleanExpression
implements ColumnProvider
```
Represents a database column storing a boolean value.
This class adds the necessary methods to use a boolean column like a boolean expression.
Internally the class uses an AbsractColumn to store the column and overrides methods in BooleanExpression to insert the column into the expression.
Generally you get a BooleanColumn using RowDefinition.column(DBBoolean).
Support DBvolution at Patreon

Author:

Gregory Graham

See Also:
RowDefinition, AbstractColumn, BooleanExpression

Constructor Summary

Constructors
Constructor and Description
`BooleanColumn(RowDefinition row, Boolean field)` Create a BooleanColumn for the supplied field of the supplied row
`BooleanColumn(RowDefinition row, DBBoolean field)` Create a BooleanColumn for the supplied field of the supplied row

Method Summary

Methods
Modifier and Type	Method and Description
`BooleanColumn`	`copy()` A Complete Copy Of This DBValue.
`AbstractColumn`	`getColumn()` Returns the AbstractColumn from this ColumnProvider.
`Set<DBRow>`	`getTablesInvolved()` Returns a Set of the DBRow instances involved in this expression.
`BooleanExpression`	`is(DBBoolean boolColumn)` Create an expression to compare this column to the other column using EQUALS.
`boolean`	`isAggregator()` Returns TRUE if this expression is an Aggregator like SUM() or LEAST().
`boolean`	`isBooleanStatement()` Indicates whether the result is a boolean statement or boolean value.
`boolean`	`isPurelyFunctional()` Indicates whether or not the expression includes table columns.
`void`	`setUseTableAlias(boolean useTableAlias)` Indicates whether the ColumnProvider should use the table alias during query creation.
`String`	`toSQLString(DBDefinition db)` Produces the snippet provided by this class.

Methods inherited from class nz.co.gregs.dbvolution.expressions.BooleanExpression
allOf, and, anyOf, asExpressionColumn, count, falseExpression, getIncludesNull, getQueryableDatatypeForExpressionValue, ifThenElse, ifThenElse, ifThenElse, ifThenElse, ifThenElse, ifThenElse, ifThenElse, ifThenElse, ifThenElse, integerValue, is, is, is, isNot, isNot, isNotNull, isNotNull, isNotNull, isNull, isNull, isNull, isRelationship, negate, noneOf, not, notAllOf, numberValue, or, seekGreaterThan, seekGreaterThan, seekGreaterThan, seekGreaterThan, seekLessThan, seekLessThan, seekLessThan, seekLessThan, someButNotAllOf, stringResult, trueExpression, value, value, xor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BooleanColumn
```
public BooleanColumn(RowDefinition row,
             Boolean field)
```
    Create a BooleanColumn for the supplied field of the supplied row
    
    Parameters:
    row - the row that the field belongs to
    field - the field that represents the column
  - BooleanColumn
```
public BooleanColumn(RowDefinition row,
             DBBoolean field)
```
    Create a BooleanColumn for the supplied field of the supplied row
    
    Parameters:
    row - the row that the field belongs to
    field - the field that represents the column
- Method Detail
  - toSQLString
```
public String toSQLString(DBDefinition db)
```
    Description copied from interface: DBExpression
    
    Produces the snippet provided by this class.
    This is only used internally.
    If you are extending DBvolution and adding a new function this is the place to format the information for use in SQL. A DBDefinition instance is provided to supply context and so your SQL can used on multiple database engines.
    
    Specified by:
    
    toSQLString in interface DBExpression
    
    Overrides:
    
    toSQLString in class BooleanExpression
    
    Parameters:
    db - the target database
    Support DBvolution at Patreon
    
    Returns:
    the DBValue formatted as a SQL snippet
  - copy
```
public BooleanColumn copy()
```
    Description copied from interface: DBExpression
    
    A Complete Copy Of This DBValue.
    Immutability in DBvolution is maintain by internally copying objects.
    This method enables immutability by performing a deep copy of the object.
    Singletons may return themselves but all other objects must return a new instance with copies of all mutable fields.
    Support DBvolution at Patreon
    
    Specified by:
    
    copy in interface DBExpression
    
    Specified by:
    
    copy in interface BooleanResult
    
    Overrides:
    
    copy in class BooleanExpression
    
    Returns:
    a copy of this DBValue
  - getColumn
```
public AbstractColumn getColumn()
```
    Description copied from interface: ColumnProvider
    
    Returns the AbstractColumn from this ColumnProvider.
    Support DBvolution at Patreon
    
    Specified by:
    
    getColumn in interface ColumnProvider
    
    Returns:
    the column that this provider supplies.
  - getTablesInvolved
```
public Set<DBRow> getTablesInvolved()
```
    Description copied from interface: DBExpression
    
    Returns a Set of the DBRow instances involved in this expression.
    Used by QueryGraph to plot the connections between tables and avoid cartesian joins.
    Support DBvolution at Patreon
    
    Specified by:
    
    getTablesInvolved in interface DBExpression
    
    Overrides:
    
    getTablesInvolved in class BooleanExpression
    
    Returns:
    a set of DBRow instances involved in this DBExpression.
  - setUseTableAlias
```
public void setUseTableAlias(boolean useTableAlias)
```
    Description copied from interface: ColumnProvider
    
    Indicates whether the ColumnProvider should use the table alias during query creation.
    the standard implementation is this.column.setUseTableAlias(useTableAlias); and passes the boolean along to the underlying AbstractColumn
    
    Specified by:
    
    setUseTableAlias in interface ColumnProvider
    
    Parameters:
    useTableAlias - true or false
  - isPurelyFunctional
```
public boolean isPurelyFunctional()
```
    Description copied from interface: DBExpression
    
    Indicates whether or not the expression includes table columns.
    Purely functional expressions use only in-built functions or literal values to produce results and do not require data from tables.
    Some databases, notably MS SQLServer, can not group purely functional expressions.
    Support DBvolution at Patreon
    
    Specified by:
    
    isPurelyFunctional in interface DBExpression
    
    Overrides:
    
    isPurelyFunctional in class BooleanExpression
    
    Returns:
    TRUE if the expression does not access table data, otherwise FALSE.
  - isAggregator
```
public boolean isAggregator()
```
    Description copied from interface: DBExpression
    
    Returns TRUE if this expression is an Aggregator like SUM() or LEAST().
    Subclasses must implement this method returning TRUE if the expression will combine the results of several rows to produce a result. If the expression relies on subexpressions, then the isAggregator method must return TRUE if the subexpressions include an aggregator.
    Aggregators collect several rows together to produce a single result. Examples are MAX, MIN, and AVERAGE.
    They are only appropriate in the SELECT clause and generally require the GROUP BY clause to be useful.
    Aggregators are used with DBReport. Aggregator expressions are included in the SELECT clause but excluded from the GROUP BY clause.
    Support DBvolution at Patreon
    
    Specified by:
    
    isAggregator in interface DBExpression
    
    Overrides:
    
    isAggregator in class BooleanExpression
    
    Returns:
    TRUE if this DBExpression represents an aggregating functions
  - is
```
public BooleanExpression is(DBBoolean boolColumn)
```
    Create an expression to compare this column to the other column using EQUALS.
    
    Parameters:
    boolColumn - an instance to compare to
    Support DBvolution at Patreon
    
    Returns:
    a BooleanExpression
  - isBooleanStatement
```
public boolean isBooleanStatement()
```
    Description copied from interface: BooleanResult
    
    Indicates whether the result is a boolean statement or boolean value.
    A boolean statement is a a comparison like 1=1 which results in a boolean value and is used in the where clause. Conversely a boolean value is the database representation TRUE or FALSE.
    
    The distinction is subtle but required to deal with databases which do not have a full-feature boolean datatype.
    
    Support DBvolution at Patreon
    
    Specified by:
    
    isBooleanStatement in interface BooleanResult
    
    Overrides:
    
    isBooleanStatement in class BooleanExpression
    
    Returns:
    TRUE if the BooleanResult is a boolean statement, FALSE otherwise.

Class BooleanColumn

Constructor Summary

Method Summary

Methods inherited from class nz.co.gregs.dbvolution.expressions.BooleanExpression

Methods inherited from class java.lang.Object

Constructor Detail

BooleanColumn

BooleanColumn

Method Detail

toSQLString

copy

getColumn

getTablesInvolved

setUseTableAlias

isPurelyFunctional

isAggregator

is

isBooleanStatement