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

Class StringCollectionLens<C extends java.util.Collection<java.lang.String>>

java.lang.Object

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

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

All Implemented Interfaces:

Refractor<C>

Direct Known Subclasses:

CommaDelimStringsListLens, FormFeedDelimStringsListLens

public abstract class StringCollectionLens<C extends java.util.Collection<java.lang.String>>
extends Lens<C>
implements Refractor<C>

Provides a canonical implementation of a Lens which can marshal a collection of strings to/from a single column in a database row.

Since:

zer0bandwidth-net/android 0.1.5 (#42)

Constructor Summary

Constructors

Constructor and Description
StringCollectionLens()

Method Summary

Modifier and Type	Method and Description
StringCollectionLens<C>	addToBundle(android.os.Bundle bndl, java.lang.String sKey, C val) Adds the collection of strings to a Bundle as a string array.
StringCollectionLens<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) Fetches a collection of strings from a Bundle as a string array.
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.
protected abstract C	getCollectionInstance() Implementation classes must provide a concrete override of this method to generate instances of the collection class which contains the list items.
protected abstract java.lang.String	getDelimiter() Implementation classes must provide a concrete override of this method to declare the delimiter that is used/sought between items in the serialized list.
java.lang.String	getSQLiteDataType() Defines the SQLite data type to be used when writing a value into the database.
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.
java.lang.String	toStringValue(C asValues) Serializes the list as a string, using the delimiter provided by getDelimiter().

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

getSQLiteDefaultString, getSQLiteDefaultValue, 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, getSQLiteDefaultValue, getValueFrom

Constructor Detail

StringCollectionLens

public StringCollectionLens()

Method Detail

getDelimiter

protected abstract java.lang.String getDelimiter()

Implementation classes must provide a concrete override of this method to declare the delimiter that is used/sought between items in the serialized list.

Returns:

the delimiter in the serialized list

getCollectionInstance

protected abstract C getCollectionInstance()

Implementation classes must provide a concrete override of this method to generate instances of the collection class which contains the list items.

Returns:

a collection capable of storing the list items

toStringValue

public java.lang.String toStringValue(C asValues)

Serializes the list as a string, using the delimiter provided by getDelimiter().

Parameters:

asValues - a collection of string values

Returns:

a serialization of the list

getSQLiteDataType

public java.lang.String getSQLiteDataType()

Description copied from interface: Refractor

Defines the SQLite data type to be used when writing a value into the database. This is used to create the column definition.

Specified by:

getSQLiteDataType in interface Refractor<C extends java.util.Collection<java.lang.String>>

Returns:

the SQLite data type string for this Java data type

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.Collection<java.lang.String>>

Overrides:

toSQLiteString in class Lens<C extends java.util.Collection<java.lang.String>>

Parameters:

o - the Java thing to be converted

Returns:

a string serialization for use in an SQLite statement

addToContentValues

public StringCollectionLens<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.Collection<java.lang.String>>

Parameters:

vals - the set of content values

sKey - the content value key

val - the value to be stored

Returns:

(fluid)

addToBundle

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

Adds the collection of strings to a Bundle as a string array. This will always be rendered in the bundle as a string array, regardless of the algorithm that would marshal the collection to/from a database as a string serialization.

Specified by:

addToBundle in interface Refractor<C extends java.util.Collection<java.lang.String>>

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.Collection<java.lang.String>>

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)

Fetches a collection of strings from a Bundle as a string array. This will always be rendered in the bundle as a string array, regardless of the algorithm that would marshal the collection to/from a database as a string serialization.

Specified by:

fromBundle in interface Refractor<C extends java.util.Collection<java.lang.String>>

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)