SQLightable.Reflection

java.lang.Object
- net.zer0bandwidth.android.lib.database.sqlitehouse.SQLightable.Reflection<T>

Type Parameters:

T - the class being reflected

Enclosing interface:

SQLightable
```
public static class SQLightable.Reflection<T extends SQLightable>
extends java.lang.Object
```
A full reflection of a SQLightable object, which represents, and is used to marshal data for, an SQLite table. Usable by SQLiteHouse and any other class that needs to know how this table class is defined.

Since:

zer0bandwidth-net/android 0.1.7 (#50)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`SQLightable.Reflection.Column` A full reflection of a `SQLiteColumn` field.
`static class`	`SQLightable.Reflection.ColumnMap<ST extends SQLightable>` Provides a syntactic shorthand for working with maps of fields to column reflections.
`class`	`SQLightable.Reflection.ColumnSequencer` Orders `SQLightable.Reflection.Column` attributes in a list.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`LOG_TAG`
`protected java.util.ArrayList<SQLightable.Reflection.Column>`	`m_aColumns` A simple list of columns, sorted roughly by the sequence defined by the corresponding fields' `SQLiteColumn` annotations.
`protected SQLiteTable`	`m_antTable` The annotation on the reflected table class.
`protected java.lang.Class<T>`	`m_clsTable` The class being reflected.
`protected java.lang.reflect.Field`	`m_fldKey` The field that is the primary key for the table.
`protected java.lang.reflect.Field`	`m_fldMagicID` The field that is the class's placeholder for the magic SQLite auto-incremented row key, if any.
`protected java.util.HashMap<java.lang.String,java.lang.reflect.Field>`	`m_mapColNames` Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — this is no longer populated; use `getColumn(String)` to directly fetch a column reflection corresponding to the DB column name, then use `SQLightable.Reflection.Column.getField()` to get the field
`protected java.util.HashMap<java.lang.String,SQLightable.Reflection.Column>`	`m_mapColumns` A map of DB column names to column schemas.
`protected SQLightable.Reflection.ColumnMap<T>`	`m_mapFields` A map of fields to their column schemas.
`protected java.lang.String`	`m_sTableName` The name of the table.

Constructor Summary

Constructors
Constructor and Description

Reflection(java.lang.Class<T> cls)
Constructor kicks off a reflection of the selected class.

Constructors
Constructor and Description
`Reflection(java.lang.Class<T> cls)` Constructor kicks off a reflection of the selected class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DeletionBuilder`	`buildDelete()` Get an instance of a `DeletionBuilder` initialized with the table name discovered by this reflection.
`static <ST extends SQLightable> DeletionBuilder`	`buildDelete(java.lang.Class<ST> cls)` Shorthand to get an instance of `DeletionBuilder` initialized with the table name that would be reflected for the specified schematic class.
`InsertionBuilder`	`buildInsert()` Get an instance of an `InsertionBuilder` initialized with the table name discovered by this reflection.
`static <ST extends SQLightable> InsertionBuilder`	`buildInsert(java.lang.Class<ST> cls)` Shorthand to get an instance of `InsertionBuilder` initialized with the table name that would be reflected for the specified schematic class.
`SelectionBuilder`	`buildSelect()` Get an instance of a `SelectionBuilder` initialized with the table name discovered by this reflection.
`static <ST extends SQLightable> SelectionBuilder`	`buildSelect(java.lang.Class<ST> cls)` Shorthand to get an instance of `SelectionBuilder` initialized with the table name that would be reflected for the specified schematic class.
`UpdateBuilder`	`buildUpdate()` Get an instance of an `UpdateBuilder` initialized with the table name discovered by this reflection.
`static <ST extends SQLightable> UpdateBuilder`	`buildUpdate(java.lang.Class<ST> cls)` Shorthand to get an instance of `UpdateBuilder` initialized with the table name that would be reflected for the specified schematic class.
`T`	`fromBundle(android.os.Bundle bndl)` Reads fields from a supplied `Bundle`, and marshals it into a schematic class instance.
`T`	`fromCursor(android.database.Cursor crs)` Reads a row of data from the specified cursor, and marshals it into a schematic class instance corresponding to the table from which the row was fetched.
`java.lang.String`	`getAddColumnSQL(SQLightable.Reflection.Column col)` Generates the SQL statement which will add the specified column to this table.
`SQLightable.Reflection.Column`	`getColumn(java.lang.String sColName)` Accesses the reflection of a database column (and its corresponding class field) with the specified name.
`SQLightable.Reflection.Column`	`getColumnDef(java.lang.reflect.Field fld)` Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — it's unlikely that anything outside of SQLiteHouse itself would have also reflected the class and want to get to the column that way
`SQLightable.Reflection.Column`	`getColumnDef(java.lang.String sColName)` Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — use `getColumn(java.lang.String)` instead
`SQLightable.Reflection.ColumnMap<T>`	`getColumnMap()` Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — use `getColumns()` to get the list of columns directly, or get `getColumn(String)` to get a specific column
`java.util.List<SQLightable.Reflection.Column>`	`getColumns()` Accesses the ordered list of column reflections.
`java.lang.reflect.Field`	`getField(java.lang.String sColName)` Accesses the field in the schematic class corresponding to the name of a column in the table described by the class.
`int`	`getFirstSchemaVersion()` Determines the first version of the schema in which this schematic class was included.
`T`	`getInstance()` Constructs an empty instance of the `SQLightable` implementation class reflected in this object.
`SQLightable.Reflection.Column`	`getKeyColumn()` Accesses the column reflection for the field defined as the practical key for the table.
`java.lang.reflect.Field`	`getKeyField()` Accesses the field that was defined as the practical key for the table.
`SQLightable.Reflection.Column`	`getKeyOrMagicIDColumn()` Tries to find a usable key column, by first looking for a field defined as the practical key, then looking for a field defined as the magic auto-incremented row ID, then returning `null` if neither is defined.
`SQLightable.Reflection.Column`	`getMagicIDColumn()` Accesses the column reflection for the field defined as the container for the SQLite magic auto-incremented row ID, if any.
`java.lang.reflect.Field`	`getMagicIDField()` Accesses the field that was defined as the container for the SQLite magic auto-incremented row ID, if any.
`SQLiteTable`	`getTableAttrs()` Accesses the `SQLiteTable` annotation that defines the attributes of the table described by this schematic class.
`java.lang.Class<T>`	`getTableClass()` Accesses the schematic class reflected in this object.
`java.lang.String`	`getTableCreationSQL()` Generates the SQL statement which will create the table represented by this schematic class, based on the class itself, and its `SQLiteTable` annotation (if any).
`java.lang.String`	`getTableName()` Accesses the name of the database table described by this schematic class.
`static <ST extends SQLightable> java.lang.String`	`getTableName(java.lang.Class<ST> cls)` Standardized way to choose the name of a SQLite table based on the schematic class definition and its annotations, if any.
`protected static <ST extends SQLightable> java.lang.String`	`getTableName(java.lang.Class<ST> cls, SQLiteTable antTable)` Standardized way to choose the name of a SQLite table based on the annotation attached to the schematic class.
`protected void`	`processInheritanceTo(java.lang.Class<?> cls, int nSince)` If the class being reflected is annotated with `SQLiteInheritColumns`, then this method will update the `Reflection`'s list of "inherited" fields with anything that is annotated with `SQLiteColumn` in the class's parent.
`static <ST extends SQLightable> SQLightable.Reflection<ST>`	`reflect(java.lang.Class<ST> cls)` Obtain a reflection of the specified schematic class.
`protected SQLightable.Reflection<T>`	`reflectColumns()` Analyzes the fields defined in the selected class and its ancestors, to produce a complete, ordered list of columns for the database table in this version of the schema.
`android.os.Bundle`	`toBundle(T oSource)` Extracts the values of all known fields, corresponding to database table columns, from a schematic class instance, and returns a `Bundle` instance containing those values.
`android.content.ContentValues`	`toContentValues(T oSource)` Extracts the values of all known fields, corresponding to database table columns, from a schematic class instance, and returns a `ContentValues` instance containing those values.

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

- Field Detail
  - LOG_TAG
```
public static final java.lang.String LOG_TAG
```
  - m_clsTable
```
protected java.lang.Class<T extends SQLightable> m_clsTable
```
    The class being reflected.
  - m_antTable
```
protected SQLiteTable m_antTable
```
    The annotation on the reflected table class.
  - m_sTableName
```
protected java.lang.String m_sTableName
```
    The name of the table. Stored once, read repeatedly.
  - m_mapFields
```
protected SQLightable.Reflection.ColumnMap<T extends SQLightable> m_mapFields
```
    A map of fields to their column schemas.
  - m_mapColNames
```
protected java.util.HashMap<java.lang.String,java.lang.reflect.Field> m_mapColNames
```
    Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — this is no longer populated; use getColumn(String) to directly fetch a column reflection corresponding to the DB column name, then use SQLightable.Reflection.Column.getField() to get the field
    
    A map of DB column names to field definitions.
  - m_aColumns
```
protected java.util.ArrayList<SQLightable.Reflection.Column> m_aColumns
```
    A simple list of columns, sorted roughly by the sequence defined by the corresponding fields' SQLiteColumn annotations. Replaces m_mapFields, from which we used only the values (the list of columns).
    
    Since:
    
    zer0bandwidth-net/android 0.2.1 (#56)
  - m_mapColumns
```
protected java.util.HashMap<java.lang.String,SQLightable.Reflection.Column> m_mapColumns
```
    A map of DB column names to column schemas. Replaces m_mapColNames, which mapped to fields.
    
    Since:
    
    zer0bandwidth-net/android 0.2.1 (#56)
  - m_fldKey
```
protected java.lang.reflect.Field m_fldKey
```
    The field that is the primary key for the table.
  - m_fldMagicID
```
protected java.lang.reflect.Field m_fldMagicID
```
    The field that is the class's placeholder for the magic SQLite auto-incremented row key, if any.
- Constructor Detail
  - Reflection
```
public Reflection(java.lang.Class<T> cls)
           throws IntrospectionException
```
    Constructor kicks off a reflection of the selected class.
    
    Parameters:
    
    cls - the class being reflected
    
    Throws:
    
    IntrospectionException - if something goes wrong
- Method Detail
  - reflect
```
public static <ST extends SQLightable> SQLightable.Reflection<ST> reflect(java.lang.Class<ST> cls)
```
    Obtain a reflection of the specified schematic class.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    Returns:
    
    a reflection of the class
  - getTableName
```
public static <ST extends SQLightable> java.lang.String getTableName(java.lang.Class<ST> cls)
```
    Standardized way to choose the name of a SQLite table based on the schematic class definition and its annotations, if any.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    Returns:
    
    either the name specified in the annotation, or a lower-cased transformation of the class name itself, if the annotation is not provided
  - getTableName
```
protected static <ST extends SQLightable> java.lang.String getTableName(java.lang.Class<ST> cls,
                                                                        SQLiteTable antTable)
```
    Standardized way to choose the name of a SQLite table based on the annotation attached to the schematic class.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    antTable - the annotation that describes the table defined by the class (may be null)
    
    Returns:
    
    either the name specified in the annotation, or a lower-cased transformation of the class name itself, if the annotation is not present
    
    See Also:
    
    getTableName(Class), getTableName()
  - buildInsert
```
public static <ST extends SQLightable> InsertionBuilder buildInsert(java.lang.Class<ST> cls)
```
    Shorthand to get an instance of InsertionBuilder initialized with the table name that would be reflected for the specified schematic class. Use this method when you need a query builder but don't need to retain a copy of the reflection.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    Returns:
    
    a builder for an INSERT statement
  - buildUpdate
```
public static <ST extends SQLightable> UpdateBuilder buildUpdate(java.lang.Class<ST> cls)
```
    Shorthand to get an instance of UpdateBuilder initialized with the table name that would be reflected for the specified schematic class. Use this method when you need a query builder but don't need to retain a copy of the reflection.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    Returns:
    
    a builder for an UPDATE statement
  - buildSelect
```
public static <ST extends SQLightable> SelectionBuilder buildSelect(java.lang.Class<ST> cls)
```
    Shorthand to get an instance of SelectionBuilder initialized with the table name that would be reflected for the specified schematic class. Use this method when you need a query builder but don't need to retain a copy of the reflection.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    Returns:
    
    a builder for a SELECT statement
  - buildDelete
```
public static <ST extends SQLightable> DeletionBuilder buildDelete(java.lang.Class<ST> cls)
```
    Shorthand to get an instance of DeletionBuilder initialized with the table name that would be reflected for the specified schematic class. Use this method when you need a query builder but don't need to retain a copy of the reflection.
    
    Type Parameters:
    
    ST - the schematic class
    
    Parameters:
    
    cls - the schematic class
    
    Returns:
    
    a builder for a DELETE statement
  - reflectColumns
```
protected SQLightable.Reflection<T> reflectColumns()
```
    Analyzes the fields defined in the selected class and its ancestors, to produce a complete, ordered list of columns for the database table in this version of the schema. Deprecates and replaces initFieldMap().
    
    Returns:
    
    (fluid)
    
    Since:
    
    zer0bandwidth-net/android 0.2.1 (#56)
  - processInheritanceTo
```
protected void processInheritanceTo(java.lang.Class<?> cls,
                                    int nSince)
```
    If the class being reflected is annotated with SQLiteInheritColumns, then this method will update the Reflection's list of "inherited" fields with anything that is annotated with SQLiteColumn in the class's parent. Note that the parent class does not need to be annotated as an SQLiteTable, nor does it need to implement SQLightable. THIS METHOD WILL RECURSE as long as it continues to find and traverse classes whose parents are also annotated with SQLiteInheritColumns.
    
    Parameters:
    
    cls - the class to be examined; this is originally called with the class that is being reflected, and may recurse with its parent as far as we continue to see SQLiteInheritColumns annotations
    
    Since:
    
    zer0bandwidth-net/android 0.2.1 (#56)
    
    See Also:
    
    reflectColumns()
  - getTableClass
```
public java.lang.Class<T> getTableClass()
```
    Accesses the schematic class reflected in this object.
    
    Returns:
    
    the class reflected in this object
  - getTableAttrs
```
public SQLiteTable getTableAttrs()
```
    Accesses the SQLiteTable annotation that defines the attributes of the table described by this schematic class.
    
    Returns:
    
    the annotation of table attributes
  - getTableName
```
public java.lang.String getTableName()
```
    Accesses the name of the database table described by this schematic class. If the name is not explicitly given in an annotation, then it will be derived by lower-casing the simple name of the schematic class itself.
    
    Returns:
    
    the name of the table
    
    See Also:
    
    getTableName(Class, SQLiteTable)
  - getColumn
```
public SQLightable.Reflection.Column getColumn(java.lang.String sColName)
```
    Accesses the reflection of a database column (and its corresponding class field) with the specified name.
    
    Parameters:
    
    sColName - the name of a column in the database table
    
    Returns:
    
    the reflection of that column
    
    Since:
    
    zer0bandwidth-net/android 0.2.1 (#56)
  - getField
```
public java.lang.reflect.Field getField(java.lang.String sColName)
```
    Accesses the field in the schematic class corresponding to the name of a column in the table described by the class.
    
    Parameters:
    
    sColName - the name of a column in the database table
    
    Returns:
    
    the field in this schematic class which corresponds to that column
  - getColumns
```
public java.util.List<SQLightable.Reflection.Column> getColumns()
```
    Accesses the ordered list of column reflections.
    
    Returns:
    
    the list of database columns
    
    Since:
    
    zer0bandwidth-net/android 0.2.1 (#56)
  - getColumnMap
```
public SQLightable.Reflection.ColumnMap<T> getColumnMap()
```
    Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — use getColumns() to get the list of columns directly, or get getColumn(String) to get a specific column
    
    Accesses the complete map of fields and column reflections.
    
    Returns:
    
    the complete map of fields and columns
  - getColumnDef
```
public SQLightable.Reflection.Column getColumnDef(java.lang.reflect.Field fld)
```
    Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — it's unlikely that anything outside of SQLiteHouse itself would have also reflected the class and want to get to the column that way
    
    Accesses the SQLite column definition defined by the given field in the schematic class.
    
    Parameters:
    
    fld - the field that corresponds to a database table column
    
    Returns:
    
    a reflection of that column
  - getColumnDef
```
public SQLightable.Reflection.Column getColumnDef(java.lang.String sColName)
```
    Deprecated. zer0bandwidth-net/android 0.2.1 (#56) — use getColumn(java.lang.String) instead
    
    Accesses the SQLite column definition for the given column name.
    
    Parameters:
    
    sColName - the name of the table column
    
    Returns:
    
    a reflection of that column
  - getKeyField
```
public java.lang.reflect.Field getKeyField()
```
    Accesses the field that was defined as the practical key for the table.
    
    Returns:
    
    the field usable as a key
  - getKeyColumn
```
public SQLightable.Reflection.Column getKeyColumn()
```
    Accesses the column reflection for the field defined as the practical key for the table.
    
    Returns:
    
    the reflection of the table's key column
  - getMagicIDField
```
public java.lang.reflect.Field getMagicIDField()
```
    Accesses the field that was defined as the container for the SQLite magic auto-incremented row ID, if any.
    
    Returns:
    
    the field which holds the auto-inc row ID
  - getMagicIDColumn
```
public SQLightable.Reflection.Column getMagicIDColumn()
```
    Accesses the column reflection for the field defined as the container for the SQLite magic auto-incremented row ID, if any.
    
    Returns:
    
    the reflection of the table's row ID column
  - getKeyOrMagicIDColumn
```
public SQLightable.Reflection.Column getKeyOrMagicIDColumn()
```
    Tries to find a usable key column, by first looking for a field defined as the practical key, then looking for a field defined as the magic auto-incremented row ID, then returning null if neither is defined.
    
    Returns:
    
    a column usable as a key, or null if neither a practical key nor a magic row ID column is defined
  - getTableCreationSQL
```
public java.lang.String getTableCreationSQL()
```
    Generates the SQL statement which will create the table represented by this schematic class, based on the class itself, and its SQLiteTable annotation (if any).
    
    Returns:
    
    an SQL statement which will create the SQLite table
  - getAddColumnSQL
```
public java.lang.String getAddColumnSQL(SQLightable.Reflection.Column col)
```
    Generates the SQL statement which will add the specified column to this table.
    
    Parameters:
    
    col - the reflection of the column to be added
    
    Returns:
    
    an SQL statement which adds the column to this table
  - getFirstSchemaVersion
```
public int getFirstSchemaVersion()
```
    Determines the first version of the schema in which this schematic class was included. If the SQLiteTable annotation is missing, then the method returns 1.
    
    Returns:
    
    the schema version in which the schematic class was introduced
  - getInstance
```
public T getInstance()
              throws IntrospectionException
```
    Constructs an empty instance of the SQLightable implementation class reflected in this object.
    
    Returns:
    
    an empty instance of the schematic class
    
    Throws:
    
    IntrospectionException - if the schematic class could not be constructed for some reason
  - fromCursor
```
public T fromCursor(android.database.Cursor crs)
             throws IntrospectionException,
                    SchematicException
```
    Reads a row of data from the specified cursor, and marshals it into a schematic class instance corresponding to the table from which the row was fetched.
    
    Parameters:
    
    crs - the cursor which is currently pointing to a data row
    
    Returns:
    
    an instance of the class, containing the cursor's current row
    
    Throws:
    
    IntrospectionException - if the data class could not be constructed for some reason
    
    SchematicException - if the data could not be properly marshalled into the class instance
  - fromBundle
```
public T fromBundle(android.os.Bundle bndl)
             throws IntrospectionException,
                    SchematicException
```
    Reads fields from a supplied Bundle, and marshals it into a schematic class instance.
    
    Parameters:
    
    bndl - the bundle into which data was marshalled
    
    Returns:
    
    an instance of the class, containing the bundled data
    
    Throws:
    
    IntrospectionException - if the data class could not be constructed for some reason
    
    SchematicException - if the data could not be properly marshalled into the class instance
  - toContentValues
```
public android.content.ContentValues toContentValues(T oSource)
                                              throws SchematicException
```
    Extracts the values of all known fields, corresponding to database table columns, from a schematic class instance, and returns a ContentValues instance containing those values. Replaces SQLiteHouse#toContentValues(SQLightable).
    
    Parameters:
    
    oSource - the object to be processed
    
    Returns:
    
    the values that would be stored in the database
    
    Throws:
    
    SchematicException - if no Refractor implementation can be found for one of the columns/fields
  - toBundle
```
public android.os.Bundle toBundle(T oSource)
                           throws SchematicException
```
    Extracts the values of all known fields, corresponding to database table columns, from a schematic class instance, and returns a Bundle instance containing those values.
    
    Parameters:
    
    oSource - the object to be processed
    
    Returns:
    
    the values that would be stored in the database
    
    Throws:
    
    SchematicException - if no Refractor implementation can be found for one of the column's fields
  - buildInsert
```
public InsertionBuilder buildInsert()
```
    Get an instance of an InsertionBuilder initialized with the table name discovered by this reflection.
    
    Returns:
    
    a builder for an INSERT statement
  - buildUpdate
```
public UpdateBuilder buildUpdate()
```
    Get an instance of an UpdateBuilder initialized with the table name discovered by this reflection.
    
    Returns:
    
    a builder for an UPDATE statement
  - buildSelect
```
public SelectionBuilder buildSelect()
```
    Get an instance of a SelectionBuilder initialized with the table name discovered by this reflection.
    
    Returns:
    
    a builder for a SELECT statement
  - buildDelete
```
public DeletionBuilder buildDelete()
```
    Get an instance of a DeletionBuilder initialized with the table name discovered by this reflection.
    
    Returns:
    
    a builder for a DELETE statement

Class SQLightable.Reflection<T extends SQLightable>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_TAG

m_clsTable

m_antTable

m_sTableName

m_mapFields

m_mapColNames

m_aColumns

m_mapColumns

m_fldKey

m_fldMagicID

Constructor Detail

Reflection

Method Detail

reflect

getTableName

getTableName

buildInsert

buildUpdate

buildSelect

buildDelete

reflectColumns

processInheritanceTo

getTableClass

getTableAttrs

getTableName

getColumn

getField

getColumns

getColumnMap

getColumnDef

getColumnDef

getKeyField

getKeyColumn

getMagicIDField

getMagicIDColumn

getKeyOrMagicIDColumn

getTableCreationSQL

getAddColumnSQL

getFirstSchemaVersion

getInstance

fromCursor

fromBundle

toContentValues

toBundle

buildInsert

buildUpdate

buildSelect

buildDelete