net.zer0bandwidth.android.lib.database.sqlitehouse

Class SQLightable.Reflection.Column

java.lang.Object

net.zer0bandwidth.android.lib.database.sqlitehouse.SQLightable.Reflection.Column

Enclosing class:

SQLightable.Reflection<T extends SQLightable>

public class SQLightable.Reflection.Column
extends java.lang.Object

A full reflection of a SQLiteColumn field. Used by SQLightable.Reflection. Replaces SQLiteHouse#getColumnDefinitionClause(QueryContext).

Since:

zer0bandwidth-net/android 0.1.7 (#50)

Field Summary

Fields

Modifier and Type	Field and Description
protected SQLiteColumn	m_antColumn The annotation that defines the column schema.
protected boolean	m_bKey Indicates whether the column is also annotated as a key.
protected java.lang.reflect.Field	m_fldColumn The field that defines the column schema.
protected Refractor	m_lens The Refractor implementation to be used for the column.
protected int	m_nSince The version of the schema in which the column was added to the reflected table.

Constructor Summary

Constructors

Constructor and Description
Column(java.lang.reflect.Field fld) Initializes the object with the selected field's data.

Method Summary

Modifier and Type	Method and Description
protected Refractor	discoverRefractor() Discovers the Refractor implementation to be used for this column field.
SQLiteColumn	getColAttrs() Accesses the schematic annotation.
java.lang.String	getColumnCreationClause() Generates the SQL clause that will create this column as part of a CREATE TABLE or ALTER TABLE ADD COLUMN statement.
java.lang.reflect.Field	getField() Accesses the schematic field.
java.lang.String	getName() Shorthand to get the DB column name from the annotation.
Refractor	getRefractor() Accesses the column's Refractor implementation.
int	getSince()
java.lang.String	getSQLColumnValueFrom(T o) Tries to discover the value of this column within the corresponding field of an instance of the schematic class that defines it.
boolean	isKey() Indicates whether the column was annotated as a key.
protected SQLightable.Reflection.Column	setSince(int n)

Methods inherited from class java.lang.Object

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

Field Detail

m_fldColumn

protected java.lang.reflect.Field m_fldColumn

The field that defines the column schema.

m_antColumn

protected SQLiteColumn m_antColumn

The annotation that defines the column schema.

m_bKey

protected boolean m_bKey

Indicates whether the column is also annotated as a key.

m_lens

protected Refractor m_lens

The Refractor implementation to be used for the column.

m_nSince

protected int m_nSince

The version of the schema in which the column was added to the reflected table. This is the maximum of any since value in the annotations on the field's declaration, the enclosing class's declaration, or any SQLiteInheritColumns found while tracing the reflected class's lineage.

Since:

zer0bandwidth-net/android 0.2.1 (#56)

Constructor Detail

Column

public Column(java.lang.reflect.Field fld)
       throws SchematicException,
              IntrospectionException

Initializes the object with the selected field's data.

Parameters:

fld - the field to be analyzed

Throws:

SchematicException - if the field does not have a SQLiteColumn annotation

IntrospectionException - if something goes wrong while analyzing the field

Method Detail

discoverRefractor

protected Refractor discoverRefractor()
                               throws IntrospectionException,
                                      SchematicException

Discovers the Refractor implementation to be used for this column field.

Returns:

the implementation which marshals this field's data

Throws:

IntrospectionException - if the refractor instance can't be created

SchematicException - if the refractor class can't be resolved

getField

public java.lang.reflect.Field getField()

Accesses the schematic field.

getColAttrs

public SQLiteColumn getColAttrs()

Accesses the schematic annotation.

isKey

public boolean isKey()

Indicates whether the column was annotated as a key.

getName

public java.lang.String getName()

Shorthand to get the DB column name from the annotation.

getRefractor

public Refractor getRefractor()

Accesses the column's Refractor implementation.

getSince

public int getSince()

setSince

protected SQLightable.Reflection.Column setSince(int n)

getColumnCreationClause

public java.lang.String getColumnCreationClause()

Generates the SQL clause that will create this column as part of a CREATE TABLE or ALTER TABLE ADD COLUMN statement.

Returns:

an SQL statement which defines the column

getSQLColumnValueFrom

public java.lang.String getSQLColumnValueFrom(T o)

Tries to discover the value of this column within the corresponding field of an instance of the schematic class that defines it.

Parameters:

o - an instance of the schematic class that defined this column

Returns:

the SQLite string representation of the value

Throws:

SchematicException - if something goes wrong while trying to discover the value