Column (specrunner-sql 1.5.09 API)

java.lang.Object
- org.specrunner.sql.meta.Column

All Implemented Interfaces:

Serializable, IMergeable<Column>, IReplicable<Column>, IResetableExtended
```
public class Column
extends Object
implements IReplicable<Column>, IMergeable<Column>, IResetableExtended
```
Column meta model.

Author:

Thiago Santos.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Column()

Constructors
Constructor and Description
`Column()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Column`	`copy()` A clone of the object.
`String`	`getAlias()` Get the table alias.
`List<String>`	`getArguments()` Get the list of arguments.
`IComparator`	`getComparator()` Get the column comparator.
`IConverter`	`getConverter()` Get the column converter.
`IAbstraction`	`getDefaultExpression()` Get the column default value expression.
`Object`	`getDefaultValue()` Get the column default value.
`IFormatter`	`getFormatter()` Get formatter.
`List<String>`	`getFormatterArguments()` Get formatter arguments.
`String`	`getName()` Get the table name.
`Table`	`getParent()` Get the column table.
`String`	`getPointer()` Get the column pointer to a column with the type of this virtual register.
`IReader`	`getReader()` Get the column reader.
`String`	`getSequence()` Get sequence name, is column is a sequence.
`String`	`getTable()` Get column table reference.
`String`	`getTableOrAlias()` If column has table attribute returns it, otherwise return alias.
`void`	`initialize(IContext context)`
`boolean`	`isDate()` Get if the column is a date.
`boolean`	`isEnum()` Check if a column is a enumeration.
`boolean`	`isKey()` Get the key information.
`boolean`	`isReference()` Check if a given column values can be used as a reference for foreign references.
`boolean`	`isSequence()` Check if the column is a sequence.
`boolean`	`isVirtual()` Check if a given column must be resolved using virtual keys produced on demand by `getGenerateKeys()`.
`void`	`merge(Column other)` Merge two objects.
`Column`	`setAlias(String alias)` Set the table alias.
`Column`	`setArguments(List<String> arguments)` Set the list of arguments.
`Column`	`setComparator(IComparator comparator)` Set the column comparator.
`Column`	`setConverter(IConverter converter)` Set the column converter.
`Column`	`setDate(boolean date)` Set date flag.
`Column`	`setDefaultExpression(IAbstraction defaultExpression)` Set the column default value expression.
`Column`	`setDefaultValue(Object defaultValue)` Set the column default value.
`Column`	`setFormatter(IFormatter formatter)` The column formatter.
`Column`	`setFormatterArguments(List<String> formatterArguments)` Set column formatter.
`Column`	`setKey(boolean key)` Set the key flag.
`Column`	`setName(String name)` Set the table name.
`Column`	`setParent(Table parent)` Set the table.
`Column`	`setPointer(String pointer)` Set the pointer reference.
`Column`	`setReader(IReader reader)` Set the column reader.
`Column`	`setReference(boolean reference)` The reference flag.
`Column`	`setSequence(String sequence)` Set sequence name.
`Column`	`setTable(String table)` Set table property.
`Column`	`setVirtual(boolean virtual)` Set virtual flag.

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

- Constructor Detail
  - Column
```
public Column()
```
- Method Detail
  - getParent
```
public Table getParent()
```
    Get the column table.
    
    Returns:
    
    The table.
  - setParent
```
public Column setParent(Table parent)
```
    Set the table.
    
    Parameters:
    
    parent - The table.
    
    Returns:
    
    The column itself.
  - getAlias
```
public String getAlias()
```
    Get the table alias.
    
    Returns:
    
    The table name, if exists, null otherwise.
  - setAlias
```
public Column setAlias(String alias)
```
    Set the table alias.
    
    Parameters:
    
    alias - The alias.
    
    Returns:
    
    The table itself.
  - getName
```
public String getName()
```
    Get the table name.
    
    Returns:
    
    The table.
  - setName
```
public Column setName(String name)
```
    Set the table name.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    The column itself.
  - getTable
```
public String getTable()
```
    Get column table reference.
    
    Returns:
    
    Column table name if filled, otherwise, null.
  - setTable
```
public Column setTable(String table)
```
    Set table property.
    
    Parameters:
    
    table - A table name.
    
    Returns:
    
    The column itself.
  - getTableOrAlias
```
public String getTableOrAlias()
```
    If column has table attribute returns it, otherwise return alias.
    
    Returns:
    
    Table if exist prior to alias.
  - isKey
```
public boolean isKey()
```
    Get the key information.
    
    Returns:
    
    true, if the column is a key, false, otherwise.
  - setKey
```
public Column setKey(boolean key)
```
    Set the key flag.
    
    Parameters:
    
    key - The value.
    
    Returns:
    
    The column itself.
  - getSequence
```
public String getSequence()
```
    Get sequence name, is column is a sequence.
    
    Returns:
    
    Sequence name.
  - setSequence
```
public Column setSequence(String sequence)
```
    Set sequence name.
    
    Parameters:
    
    sequence - The sequence.
    
    Returns:
    
    The column itself.
  - isSequence
```
public boolean isSequence()
```
    Check if the column is a sequence.
    
    Returns:
    
    true, if column is a sequence, false, otherwise.
  - isDate
```
public boolean isDate()
```
    Get if the column is a date.
    
    Returns:
    
    true, if date column, false, otherwise.
  - setDate
```
public Column setDate(boolean date)
```
    Set date flag.
    
    Parameters:
    
    date - The flag.
    
    Returns:
    
    The column itself.
  - getReader
```
public IReader getReader()
```
    Get the column reader.
    
    Returns:
    
    The reader.
  - setReader
```
public Column setReader(IReader reader)
```
    Set the column reader.
    
    Parameters:
    
    reader - The reader.
    
    Returns:
    
    The column itself.
  - getConverter
```
public IConverter getConverter()
```
    Get the column converter.
    
    Returns:
    
    The converter.
  - setConverter
```
public Column setConverter(IConverter converter)
```
    Set the column converter.
    
    Parameters:
    
    converter - The converter.
    
    Returns:
    
    The column itself.
  - getArguments
```
public List<String> getArguments()
```
    Get the list of arguments.
    
    Returns:
    
    Arguments.
  - setArguments
```
public Column setArguments(List<String> arguments)
```
    Set the list of arguments.
    
    Parameters:
    
    arguments - List of arguments.
    
    Returns:
    
    The column itself.
  - isEnum
```
public boolean isEnum()
```
    Check if a column is a enumeration.
    
    Returns:
    
    true, if converter is enumeration based, false, otherwise.
  - getComparator
```
public IComparator getComparator()
```
    Get the column comparator.
    
    Returns:
    
    The comparator.
  - setComparator
```
public Column setComparator(IComparator comparator)
```
    Set the column comparator.
    
    Parameters:
    
    comparator - The comparator.
    
    Returns:
    
    The column itself.
  - getFormatter
```
public IFormatter getFormatter()
```
    Get formatter.
    
    Returns:
    
    The column formatter.
  - setFormatter
```
public Column setFormatter(IFormatter formatter)
```
    The column formatter.
    
    Parameters:
    
    formatter - A formatter.
    
    Returns:
    
    The column itself.
  - getFormatterArguments
```
public List<String> getFormatterArguments()
```
    Get formatter arguments.
    
    Returns:
    
    The arguments.
  - setFormatterArguments
```
public Column setFormatterArguments(List<String> formatterArguments)
```
    Set column formatter.
    
    Parameters:
    
    formatterArguments - Formatter arguments.
    
    Returns:
    
    Formatter.
  - getDefaultExpression
```
public IAbstraction getDefaultExpression()
```
    Get the column default value expression.
    
    Returns:
    
    The default value.
  - setDefaultExpression
```
public Column setDefaultExpression(IAbstraction defaultExpression)
```
    Set the column default value expression.
    
    Parameters:
    
    defaultExpression - The expression.
    
    Returns:
    
    The column itself.
  - getDefaultValue
```
public Object getDefaultValue()
```
    Get the column default value. Default values are expected to be non null.
    
    Returns:
    
    The default value.
  - setDefaultValue
```
public Column setDefaultValue(Object defaultValue)
```
    Set the column default value.
    
    Parameters:
    
    defaultValue - The value.
    
    Returns:
    
    The column itself.
  - isReference
```
public boolean isReference()
```
    Check if a given column values can be used as a reference for foreign references.
    
    Returns:
    
    true, if reference column, false, otherwise.
  - setReference
```
public Column setReference(boolean reference)
```
    The reference flag.
    
    Parameters:
    
    reference - The flag.
    
    Returns:
    
    The column itself.
  - isVirtual
```
public boolean isVirtual()
```
    Check if a given column must be resolved using virtual keys produced on demand by getGenerateKeys(). When this flag is on, in the specification there must be a previous table with naming matching this column name and the value must match that column reference field.
    
    Returns:
    
    The virtual flag.
  - setVirtual
```
public Column setVirtual(boolean virtual)
```
    Set virtual flag.
    
    Parameters:
    
    virtual - The virtual flag.
    
    Returns:
    
    The column itself.
  - getPointer
```
public String getPointer()
```
    Get the column pointer to a column with the type of this virtual register.
    
    Returns:
    
    The column to lookup for virtual key table alias.
  - setPointer
```
public Column setPointer(String pointer)
```
    Set the pointer reference.
    
    Parameters:
    
    pointer - A pointer.
    
    Returns:
    
    The column itself.
  - copy
```
public Column copy()
```
    Description copied from interface: IReplicable
    
    A clone of the object.
    
    Specified by:
    
    copy in interface IReplicable<Column>
    
    Returns:
    
    A clone.
  - merge
```
public void merge(Column other)
```
    Description copied from interface: IMergeable
    
    Merge two objects.
    
    Specified by:
    
    merge in interface IMergeable<Column>
    
    Parameters:
    
    other - The object to be merged.
  - initialize
```
public void initialize(IContext context)
```
    Specified by:
    
    initialize in interface IResetableExtended

Class Column

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Column

Method Detail

getParent

setParent

getAlias

setAlias

getName

setName

getTable

setTable

getTableOrAlias

isKey

setKey

getSequence

setSequence

isSequence

isDate

setDate

getReader

setReader

getConverter

setConverter

getArguments

setArguments

isEnum

getComparator

setComparator

getFormatter

setFormatter

getFormatterArguments

setFormatterArguments

getDefaultExpression

setDefaultExpression

getDefaultValue

setDefaultValue

isReference

setReference

isVirtual

setVirtual

getPointer

setPointer

copy

merge

initialize