Converter (SQL Query Builders 3.0.2 API)

java.lang.Object
- com.healthmarketscience.sqlbuilder.Converter<SrcType,DstType>

```
public abstract class Converter<SrcType,DstType>
extends Object
```
Class which encapsulates various object to SqlObject conversions.

Author:

James Ahlborn

Field Summary

Fields
Modifier and Type	Field and Description
`static Converter<Column,SqlObject>`	`COLUMN_TO_OBJ` Converter which converts a Column to a ColumnObject.
`static Converter<Object,SqlObject>`	`COLUMN_VALUE_TO_OBJ` Converter which converts a column value object to a SqlObject using `toColumnSqlObject(Object)`
`static Converter<Object,SqlObject>`	`CUSTOM_COLUMN_TO_OBJ` Converter which converts a custom column object to a SqlObject using `toCustomColumnSqlObject(Object)`
`static Converter<Object,SqlObject>`	`CUSTOM_TABLE_DEF_TO_OBJ` Converter which converts a custom table def object to a SqlObject using `toCustomTableDefSqlObject(Object)`
`static Converter<Object,Condition>`	`CUSTOM_TO_CONDITION` Converter which converts an Object to a Condition using `toConditionObject(Object)`
`static Converter<Object,SqlObject>`	`CUSTOM_TO_CONSTRAINTCLAUSE` Converter which converts an Object to a SqlObject using `toCustomConstraintSqlObject(java.lang.Object)`
`static Converter<Object,Expression>`	`CUSTOM_TO_EXPRESSION` Converter which converts an Object to an Expression using `toExpressionObject(Object)`
`static Converter<Object,SqlObject>`	`CUSTOM_TO_OBJ` Converter which converts an Object to a CustomSql using `toCustomSqlObject(Object)`
`static Converter<Object,Subquery>`	`CUSTOM_TO_SUBQUERY` Converter which converts an Object to a Subquery using `toSubquery(java.lang.Object)`
`static Converter<Object,SqlObject>`	`TYPED_COLUMN_TO_OBJ` Converter which converts a Column to a TypedColumnObject or a value object to a SqlObject using `toCustomSqlObject(Object)`
`static Converter<Object,SqlObject>`	`VALUE_TO_OBJ` Converter which converts a value object to a SqlObject using `toValueSqlObject(Object)`

Constructor Summary

Constructors
Constructor and Description

Converter()

Constructors
Constructor and Description
`Converter()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract DstType`	`convert(SrcType src)` Converts the given src object to a SqlObject of the expected type.
`static SqlObject`	`toColumnSqlObject(Column col)` Converts a Column to a SqlObject.
`static SqlObject`	`toColumnSqlObject(Column col, String alias)` Converts a Column to a SqlObject with the given alias.
`static SqlObject`	`toColumnSqlObject(Object obj)` Converts a column Object to a SqlObject.
`static SqlObject`	`toColumnSqlObject(Object obj, String alias)` Converts a column Object to a SqlObject with the given alias.
`static Condition`	`toConditionObject(Object obj)` Converts an Object to a Condition.
`static SqlObject`	`toConstraintSqlObject(Constraint constraint)` Converts a Constraint to a SqlObject.
`static SqlObject`	`toCustomColumnSqlObject(Object obj)` Converts a column Object to a SqlObject.
`static SqlObject`	`toCustomColumnSqlObject(Object obj, String alias)` Converts a column Object to a SqlObject.
`static SqlObject`	`toCustomConstraintClause(Object obj)` Converts an constraint clause Object to a SqlObject.
`static SqlObject`	`toCustomConstraintSqlObject(Object obj)` Converts a constraint Object to a SqlObject for use in a constraint clause..
`static SqlObject`	`toCustomFunctionSqlObject(Object obj)` Converts a function Object to a SqlObject.
`static SqlObject`	`toCustomIndexSqlObject(Object obj)` Converts a index Object to a SqlObject.
`static SqlObject`	`toCustomSqlObject(Object obj)` Converts an Object to a custom SqlObject.
`static SqlObject`	`toCustomSqlObject(Object obj, String alias)` Converts an Object to a custom SqlObject.
`static SqlObject`	`toCustomTableDefSqlObject(Object table)` Converts a table Object to a SqlObject.
`static SqlObject`	`toCustomTableSqlObject(Object obj)` Converts a table Object to a SqlObject.
`static SqlObject`	`toCustomTypedColumnSqlObject(Object column)` Converts a column Object to a SqlObject.
`static Expression`	`toExpressionObject(Object obj)` Converts an Object to an Expression.
`static SqlObject`	`toFunctionSqlObject(Function function)` Converts a Function to a SqlObject.
`static SqlObject`	`toIndexSqlObject(Index index)` Converts a Index to a SqlObject.
`static Subquery`	`toSubquery(Object obj)` Converts an Object to a Subquery.
`static SqlObject`	`toTableDefSqlObject(Table table)` Converts a Table to a table definition SqlObject.
`static SqlObject`	`toTableSqlObject(Table table)` Converts a Table to a SqlObject.
`static SqlObject`	`toValueSqlObject(Object obj)` Converts a value Object to a SqlObject.
`static SqlObject`	`toValueSqlObject(Object obj, String alias)` Converts a value Object to a SqlObject with the given alias.

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

- Field Detail
  - CUSTOM_TO_OBJ
```
public static final Converter<Object,SqlObject> CUSTOM_TO_OBJ
```
    Converter which converts an Object to a CustomSql using toCustomSqlObject(Object)
  - COLUMN_TO_OBJ
```
public static final Converter<Column,SqlObject> COLUMN_TO_OBJ
```
    Converter which converts a Column to a ColumnObject.
    Conversions (in order):
    - Column -> ColumnObject
    - null -> SqlObject.NULL_VALUE
  - VALUE_TO_OBJ
```
public static final Converter<Object,SqlObject> VALUE_TO_OBJ
```
    Converter which converts a value object to a SqlObject using toValueSqlObject(Object)
  - COLUMN_VALUE_TO_OBJ
```
public static final Converter<Object,SqlObject> COLUMN_VALUE_TO_OBJ
```
    Converter which converts a column value object to a SqlObject using toColumnSqlObject(Object)
  - CUSTOM_COLUMN_TO_OBJ
```
public static final Converter<Object,SqlObject> CUSTOM_COLUMN_TO_OBJ
```
    Converter which converts a custom column object to a SqlObject using toCustomColumnSqlObject(Object)
  - CUSTOM_TO_EXPRESSION
```
public static final Converter<Object,Expression> CUSTOM_TO_EXPRESSION
```
    Converter which converts an Object to an Expression using toExpressionObject(Object)
  - CUSTOM_TO_CONDITION
```
public static final Converter<Object,Condition> CUSTOM_TO_CONDITION
```
    Converter which converts an Object to a Condition using toConditionObject(Object)
  - TYPED_COLUMN_TO_OBJ
```
public static final Converter<Object,SqlObject> TYPED_COLUMN_TO_OBJ
```
    Converter which converts a Column to a TypedColumnObject or a value object to a SqlObject using toCustomSqlObject(Object)
  - CUSTOM_TO_SUBQUERY
```
public static final Converter<Object,Subquery> CUSTOM_TO_SUBQUERY
```
    Converter which converts an Object to a Subquery using toSubquery(java.lang.Object)
  - CUSTOM_TO_CONSTRAINTCLAUSE
```
public static final Converter<Object,SqlObject> CUSTOM_TO_CONSTRAINTCLAUSE
```
    Converter which converts an Object to a SqlObject using toCustomConstraintSqlObject(java.lang.Object)
  - CUSTOM_TABLE_DEF_TO_OBJ
```
public static final Converter<Object,SqlObject> CUSTOM_TABLE_DEF_TO_OBJ
```
    Converter which converts a custom table def object to a SqlObject using toCustomTableDefSqlObject(Object)
- Constructor Detail
  - Converter
```
public Converter()
```
- Method Detail
  - convert
```
public abstract DstType convert(SrcType src)
```
    Converts the given src object to a SqlObject of the expected type.
    
    Parameters:
    
    src - object to be coerced
    
    Returns:
    
    the src object coerced to the desired type
  - toColumnSqlObject
```
public static SqlObject toColumnSqlObject(Column col)
```
    Converts a Column to a SqlObject.
    Conversions (in order):
    - Column -> ColumnObject
    Parameters:
    
    col - object to coerce to a column SqlObject
    
    Returns:
    
    a SqlObject for the given Column appropriate for referencing the column most anywhere in a query
  - toColumnSqlObject
```
public static SqlObject toColumnSqlObject(Column col,
                                          String alias)
```
    Converts a Column to a SqlObject with the given alias.
    Conversions (in order):
    - Column -> ColumnObject
    Result of previous conversion is wrapped as an AliasedObject if the given alias is non-null.
    Parameters:
    
    col - object to coerce to a column SqlObject
    
    alias - optional column alias for the object
    
    Returns:
    
    a SqlObject for the given Column with the given alias appropriate for referencing the column most anywhere in a query
  - toTableSqlObject
```
public static SqlObject toTableSqlObject(Table table)
```
    Converts a Table to a SqlObject.
    Conversions (in order):
    - Table -> TableObject
    Parameters:
    
    table - object to coerce to a table SqlObject
    
    Returns:
    
    a SqlObject for the given Table
  - toConstraintSqlObject
```
public static SqlObject toConstraintSqlObject(Constraint constraint)
```
    Converts a Constraint to a SqlObject.
    Conversions (in order):
    - Constraint -> ConstraintObject
    Parameters:
    
    constraint - object to coerce to a constraint SqlObject
    
    Returns:
    
    a SqlObject for the given Constraint
  - toTableDefSqlObject
```
public static SqlObject toTableDefSqlObject(Table table)
```
    Converts a Table to a table definition SqlObject.
    Conversions (in order):
    - Table -> TableDefObject
    Parameters:
    
    table - object to coerce to a table SqlObject
    
    Returns:
    
    a SqlObject for the given Table
  - toIndexSqlObject
```
public static SqlObject toIndexSqlObject(Index index)
```
    Converts a Index to a SqlObject.
    Conversions (in order):
    - Index -> IndexObject
    Parameters:
    
    index - object to coerce to a index SqlObject
    
    Returns:
    
    a SqlObject for the given Index
  - toFunctionSqlObject
```
public static SqlObject toFunctionSqlObject(Function function)
```
    Converts a Function to a SqlObject.
    Conversions (in order):
    - Function -> FunctionObject
    Parameters:
    
    function - object to coerce to a function SqlObject
    
    Returns:
    
    a SqlObject for the given Function
  - toColumnSqlObject
```
public static SqlObject toColumnSqlObject(Object obj)
```
    Converts a column Object to a SqlObject.
    Conversions (in order):
    - Column -> ColumnObject
    - null -> SqlObject.NULL_VALUE
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - SqlObject -> SqlObject
    - Object -> ValueObject
    Parameters:
    
    obj - object to coerce to a column SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toColumnSqlObject
```
public static SqlObject toColumnSqlObject(Object obj,
                                          String alias)
```
    Converts a column Object to a SqlObject with the given alias.
    Conversions (in order):
    - Column -> ColumnObject
    - null -> SqlObject.NULL_VALUE
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - SqlObject -> SqlObject
    - Object -> ValueObject
    Result of previous conversion is wrapped as an AliasedObject if the given alias is non-null.
    Parameters:
    
    obj - object to coerce to a column SqlObject
    
    alias - optional column alias for the object
    
    Returns:
    
    a SqlObject for the given Object with the given alias.
  - toCustomColumnSqlObject
```
public static SqlObject toCustomColumnSqlObject(Object obj)
```
    Converts a column Object to a SqlObject.
    Conversions (in order):
    - Column -> ColumnObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom column SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toCustomColumnSqlObject
```
public static SqlObject toCustomColumnSqlObject(Object obj,
                                                String alias)
```
    Converts a column Object to a SqlObject.
    Conversions (in order):
    - Column -> ColumnObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom column SqlObject
    
    alias - optional column alias for the object
    
    Returns:
    
    a SqlObject for the given Object.
  - toCustomTableSqlObject
```
public static SqlObject toCustomTableSqlObject(Object obj)
```
    Converts a table Object to a SqlObject.
    Conversions (in order):
    - Table -> TableObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom table SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toCustomConstraintSqlObject
```
public static SqlObject toCustomConstraintSqlObject(Object obj)
```
    Converts a constraint Object to a SqlObject for use in a constraint clause..
    Conversions (in order):
    - Constraint -> ConstraintObject
    - null -> null
    If none of the previous conversions are applied, the following conversions are tried in order, then wrapped in a ConstraintClause.Prefix.
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom constraint SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toCustomIndexSqlObject
```
public static SqlObject toCustomIndexSqlObject(Object obj)
```
    Converts a index Object to a SqlObject.
    Conversions (in order):
    - Index -> IndexObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom index SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toCustomFunctionSqlObject
```
public static SqlObject toCustomFunctionSqlObject(Object obj)
```
    Converts a function Object to a SqlObject.
    Conversions (in order):
    - Function -> FunctionObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom function SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toValueSqlObject
```
public static SqlObject toValueSqlObject(Object obj)
```
    Converts a value Object to a SqlObject.
    Conversions (in order):
    - null -> SqlObject.NULL_VALUE
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - SqlObject -> SqlObject
    - Object -> ValueObject
    Parameters:
    
    obj - object to coerce to a value SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toValueSqlObject
```
public static SqlObject toValueSqlObject(Object obj,
                                         String alias)
```
    Converts a value Object to a SqlObject with the given alias.
    Conversions (in order):
    - null -> SqlObject.NULL_VALUE
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - SqlObject -> SqlObject
    - Object -> ValueObject
    Result of previous conversion is wrapped as an AliasedObject if the given alias is non-null.
    Parameters:
    
    obj - object to coerce to a value SqlObject
    
    alias - optional column alias for the object
    
    Returns:
    
    a SqlObject for the given Object with the given alias.
  - toCustomSqlObject
```
public static SqlObject toCustomSqlObject(Object obj)
```
    Converts an Object to a custom SqlObject.
    Conversions (in order):
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a custom SqlObject
    
    Returns:
    
    a SqlObject for the given Object.
  - toCustomSqlObject
```
public static SqlObject toCustomSqlObject(Object obj,
                                          String alias)
```
    Converts an Object to a custom SqlObject.
    Conversions (in order):
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Result of previous conversion is wrapped as an AliasedObject if the given alias is non-null.
    Parameters:
    
    obj - object to coerce to a custom SqlObject
    
    alias - optional column alias for the object
    
    Returns:
    
    a SqlObject for the given Object with the given alias.
  - toCustomTableDefSqlObject
```
public static SqlObject toCustomTableDefSqlObject(Object table)
```
    Converts a table Object to a SqlObject.
    Conversions (in order):
    - Table -> TableDefObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    table - object to coerce to a table definition SqlObject
    
    Returns:
    
    the given table Object wrapped as a SqlObject.
  - toCustomTypedColumnSqlObject
```
public static SqlObject toCustomTypedColumnSqlObject(Object column)
```
    Converts a column Object to a SqlObject.
    Conversions (in order):
    - Column -> TypedColumnObject
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    column - object to coerce to a typed column definition SqlObject
    
    Returns:
    
    the given table Object wrapped as a SqlObject.
  - toExpressionObject
```
public static Expression toExpressionObject(Object obj)
```
    Converts an Object to an Expression.
    Conversions (in order):
    - Expression -> Expression
    - Column -> ColumnObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - null -> SqlObject.NULL_VALUE
    - Result of the conversions below wrapped as a CustomExpression
    - SqlObject -> SqlObject
      
      Object -> ValueObject
    Parameters:
    
    obj - object to coerce to an Expression
    
    Returns:
    
    the given Object as an Expression
  - toConditionObject
```
public static Condition toConditionObject(Object obj)
```
    Converts an Object to a Condition.
    Conversions (in order):
    - Condition -> Condition
    - Result of the conversions below wrapped as a CustomCondition
    - Column -> ColumnObject
      
      null -> SqlObject.NULL_VALUE
      
      SqlObject -> SqlObject
      
      Boolean -> BooleanValueObject
      
      Number -> NumberValueObject
      
      Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a Condition
    
    Returns:
    
    the given Object as a Condition
  - toSubquery
```
public static Subquery toSubquery(Object obj)
```
    Converts an Object to a Subquery.
    Conversions (in order):
    - Subquery -> Subquery
    - Object -> Subquery
    Parameters:
    
    obj - object to coerce to a Subquery
    
    Returns:
    
    a Subquery for the given Object.
  - toCustomConstraintClause
```
public static SqlObject toCustomConstraintClause(Object obj)
```
    Converts an constraint clause Object to a SqlObject.
    Conversions (in order):
    - Constraint -> ConstraintClause
    - null -> SqlObject.NULL_VALUE
    - SqlObject -> SqlObject
    - Boolean -> BooleanValueObject
    - Number -> NumberValueObject
    - Object -> CustomSql
    Parameters:
    
    obj - object to coerce to a constraint clause SqlObject
    
    Returns:
    
    a SqlObject for the given Object.

Class Converter<SrcType,DstType>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CUSTOM_TO_OBJ

COLUMN_TO_OBJ

VALUE_TO_OBJ

COLUMN_VALUE_TO_OBJ

CUSTOM_COLUMN_TO_OBJ

CUSTOM_TO_EXPRESSION

CUSTOM_TO_CONDITION

TYPED_COLUMN_TO_OBJ

CUSTOM_TO_SUBQUERY

CUSTOM_TO_CONSTRAINTCLAUSE

CUSTOM_TABLE_DEF_TO_OBJ

Constructor Detail

Converter

Method Detail

convert

toColumnSqlObject

toColumnSqlObject

toTableSqlObject

toConstraintSqlObject

toTableDefSqlObject

toIndexSqlObject

toFunctionSqlObject

toColumnSqlObject

toColumnSqlObject

toCustomColumnSqlObject

toCustomColumnSqlObject

toCustomTableSqlObject

toCustomConstraintSqlObject

toCustomIndexSqlObject

toCustomFunctionSqlObject

toValueSqlObject

toValueSqlObject

toCustomSqlObject

toCustomSqlObject

toCustomTableDefSqlObject

toCustomTypedColumnSqlObject

toExpressionObject

toConditionObject

toSubquery

toCustomConstraintClause