net.zer0bandwidth.android.lib.database.sqlitehouse.refractor

Class CalendarLens<C extends java.util.Calendar>

java.lang.Object

net.zer0bandwidth.android.lib.database.sqlitehouse.refractor.Lens<C>

net.zer0bandwidth.android.lib.database.sqlitehouse.refractor.CalendarLens<C>

All Implemented Interfaces:

Refractor<C>

Direct Known Subclasses:

GregorianCalendarLens

public class CalendarLens<C extends java.util.Calendar>
extends Lens<C>
implements Refractor<C>

Marshals Calendar objects.

The lens converts all dates into integer GMT timestamps for storage in the DB, then recreates the Calendar objects upon retrieval. This is because integer timestamps are more reliably stored and are absolute (no fretting about timezones).

For custom calendar implementations, extend this class with your own empty descendant templatized on your calendar:

     public class CustomCalendarLens
     extends CalendarLens<CustomCalendar>
     implements Refractor<CustomCalendar>
     {}
 

Since:

zer0bandwidth-net/android 0.1.4 (#26)

Constructor Summary

Constructors

Constructor and Description
CalendarLens()

Method Summary

Modifier and Type	Method and Description
CalendarLens<C>	addToBundle(android.os.Bundle bndl, java.lang.String sKey, C val) Determines the correct method in Bundle to be used to add the specified value to an existing bundle.
CalendarLens<C>	addToContentValues(android.content.ContentValues vals, java.lang.String sKey, C val) Determines the correct method in ContentValues to be used to add the specified value to a set of content values.
C	fromBundle(android.os.Bundle bndl, java.lang.String sKey) Determines the correct method in Bundle to be used to fetch the specified column, then returns that value.
C	fromCursor(android.database.Cursor crs, java.lang.String sKey) Determines the correct method in Cursor to be used to fetch the specified column, then returns that value.
java.lang.String	getSQLiteDataType() Because SQLiteHouse will manage all datetime data elements as integer timestamps, the SQLite data type chosen here is the integer type.
C	getSQLiteDefaultValue() When a date cannot be null, this class provides a default value at the start of the epoch.
java.lang.String	toSQLiteString(C o) Converts a Java thing's value into a string to be used in a SQLite query, for example, in a WHERE clause filter.

Methods inherited from class net.zer0bandwidth.android.lib.database.sqlitehouse.refractor.Lens

getSQLiteDefaultString, getValueFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.zer0bandwidth.android.lib.database.sqlitehouse.refractor.Refractor

getSQLiteDefaultString, getValueFrom

Constructor Detail

CalendarLens

public CalendarLens()

Method Detail

getSQLiteDataType

public java.lang.String getSQLiteDataType()

Because SQLiteHouse will manage all datetime data elements as integer timestamps, the SQLite data type chosen here is the integer type.

Specified by:

getSQLiteDataType in interface Refractor<C extends java.util.Calendar>

Returns:

"INT"

getSQLiteDefaultValue

public C getSQLiteDefaultValue()

When a date cannot be null, this class provides a default value at the start of the epoch.

Specified by:

getSQLiteDefaultValue in interface Refractor<C extends java.util.Calendar>

Overrides:

getSQLiteDefaultValue in class Lens<C extends java.util.Calendar>

Returns:

a Calendar initialized at epoch time zero

toSQLiteString

public java.lang.String toSQLiteString(C o)

Description copied from interface: Refractor

Converts a Java thing's value into a string to be used in a SQLite query, for example, in a WHERE clause filter.

Specified by:

toSQLiteString in interface Refractor<C extends java.util.Calendar>

Overrides:

toSQLiteString in class Lens<C extends java.util.Calendar>

Parameters:

o - the Java thing to be converted

Returns:

a string serialization for use in an SQLite statement

addToContentValues

public CalendarLens<C> addToContentValues(android.content.ContentValues vals,
                                          java.lang.String sKey,
                                          C val)

Description copied from interface: Refractor

Determines the correct method in ContentValues to be used to add the specified value to a set of content values.

Specified by:

addToContentValues in interface Refractor<C extends java.util.Calendar>

Parameters:

vals - the set of content values

sKey - the content value key

val - the value to be stored

Returns:

(fluid)

addToBundle

public CalendarLens<C> addToBundle(android.os.Bundle bndl,
                                   java.lang.String sKey,
                                   C val)

Description copied from interface: Refractor

Determines the correct method in Bundle to be used to add the specified value to an existing bundle.

Specified by:

addToBundle in interface Refractor<C extends java.util.Calendar>

Parameters:

bndl - the bundle

sKey - the field's key

val - the value to be stored

Returns:

(fluid)

Since:

zer0bandwidth-net/android 0.1.7 (#50)

fromCursor

public C fromCursor(android.database.Cursor crs,
                    java.lang.String sKey)

Description copied from interface: Refractor

Determines the correct method in Cursor to be used to fetch the specified column, then returns that value.

Specified by:

fromCursor in interface Refractor<C extends java.util.Calendar>

Parameters:

crs - the cursor from which data should be fetched

sKey - the data column name

Returns:

the value from the cursor

fromBundle

public C fromBundle(android.os.Bundle bndl,
                    java.lang.String sKey)

Description copied from interface: Refractor

Determines the correct method in Bundle to be used to fetch the specified column, then returns that value.

Specified by:

fromBundle in interface Refractor<C extends java.util.Calendar>

Parameters:

bndl - the bundle from which data should be fetched

sKey - the data column name

Returns:

the value from the bundle

Since:

zer0bandwidth-net/android 0.1.7 (#50)