com.pkmmte.pkrss

Class PkRSS

java.lang.Object

com.pkmmte.pkrss.PkRSS

public class PkRSS
extends java.lang.Object

A powerful RSS feed manager for Android

Use #with(android.content.Context) for the global singleton instance or construct your own instance with PkRSS.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PkRSS.Builder Fluent API for creating PkRSS instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ARTICLE
static java.lang.String	KEY_ARTICLE_ID
static java.lang.String	KEY_ARTICLE_URL
static java.lang.String	KEY_CATEGORY
static java.lang.String	KEY_CATEGORY_NAME
static java.lang.String	KEY_FAVORITES
static java.lang.String	KEY_FEED_URL
static java.lang.String	KEY_READ_ARRAY
static java.lang.String	KEY_SEARCH
protected static java.lang.String	TAG

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearCache() Clears Downloader cache.
boolean	clearData() Clears all PkRSS data including Downloader cache, all articles in Favorite Database, and all articles marked as read.
boolean	containsFavorite(int id) Searches the FavoriteDatabase for the specified ID.
void	deleteAllFavorites() Clears the favorites database.
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.util.List<Article>>	get() Returns a HashMap containing all loaded Article objects.
Article	get(int id) Returns an Article object associated with the specified id.
java.util.List<Article>	get(java.lang.String url) Looks up the specified URL String from the saved HashMap.
java.util.List<Article>	get(java.lang.String url, java.lang.String search) Similar to get(String) but also looks for the search term.
java.util.List<Article>	getFavorites() Retrieves an ArrayList of articles from the Favorite Database.
protected static PkRSS	getInstance() Returns the global singleton instance.
protected java.util.Map<java.lang.String,java.lang.Integer>	getPageTracker()
int	hashCode()
boolean	isLoggingEnabled() true if debug logging is enabled.
boolean	isRead(int id)
protected void	load(Request request) Handles the specified Request.
RequestCreator	load(java.lang.String url) Starts a request with the specified URL.
protected void	log(java.lang.String message)
protected void	log(java.lang.String message, int type)
protected void	log(java.lang.String tag, java.lang.String message)
protected void	log(java.lang.String tag, java.lang.String message, int type)
void	markAllRead(boolean read) Marks/Unmarks all loaded articles as read.
void	markRead(int id, boolean read) Marks an article id as read.
boolean	saveFavorite(Article article) Saves an Article object to the favorites database.
boolean	saveFavorite(Article article, boolean favorite) Saves/Deletes an Article object to the favorites database.
boolean	saveFavorite(int id) Saves an Article object to the favorites database.
boolean	saveFavorite(int id, boolean favorite) Saves/Deletes an Article object to the favorites database.
void	setLoggingEnabled(boolean enabled) Toggle whether debug logging is enabled.
static PkRSS	with(Context context) The global default PkRSS instance.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_ARTICLE

public static final java.lang.String KEY_ARTICLE

See Also:

Constant Field Values

KEY_ARTICLE_ID

public static final java.lang.String KEY_ARTICLE_ID

See Also:

Constant Field Values

KEY_ARTICLE_URL

public static final java.lang.String KEY_ARTICLE_URL

See Also:

Constant Field Values

KEY_FEED_URL

public static final java.lang.String KEY_FEED_URL

See Also:

Constant Field Values

KEY_CATEGORY_NAME

public static final java.lang.String KEY_CATEGORY_NAME

See Also:

Constant Field Values

KEY_CATEGORY

public static final java.lang.String KEY_CATEGORY

See Also:

Constant Field Values

KEY_SEARCH

public static final java.lang.String KEY_SEARCH

See Also:

Constant Field Values

KEY_READ_ARRAY

public static final java.lang.String KEY_READ_ARRAY

See Also:

Constant Field Values

KEY_FAVORITES

public static final java.lang.String KEY_FAVORITES

See Also:

Constant Field Values

TAG

protected static final java.lang.String TAG

See Also:

Constant Field Values

Method Detail

with

public static PkRSS with(Context context)

The global default PkRSS instance.

This instance is automatically initialized with defaults that are suitable to most implementations.

If these settings do not meet the requirements of your application, you can construct your own instance with full control over the configuration by using PkRSS.Builder. You may also use PkRSS.Builder.buildSingleton() to build the singleton or PkRSS.Builder.replaceSingleton() to replace the existing singleton if it differs.

getInstance

protected static PkRSS getInstance()

Returns the global singleton instance. It may be null so use wisely!

Returns:

Global singleton instance. May be null.

setLoggingEnabled

public void setLoggingEnabled(boolean enabled)

Toggle whether debug logging is enabled.

isLoggingEnabled

public boolean isLoggingEnabled()

true if debug logging is enabled.

load

public RequestCreator load(java.lang.String url)

Starts a request with the specified URL.

URLs may be anything you wish as long as the Parser and/or Downloader supports it. See PkRSS.Builder for using your own custom Downloaders/Parsers.

Parameters:

url - URL to load feed from.

Returns:

A chained Request.

load

protected void load(Request request)
             throws java.io.IOException

Handles the specified Request. May throw an IOException for mishandled URLs or timeouts.

Parameters:

request - Request to execute.

Throws:

java.io.IOException

get

public java.util.Map<java.lang.String,java.util.List<Article>> get()

Returns a HashMap containing all loaded Article objects. The map key being the safe url.

Returns:

get

public java.util.List<Article> get(java.lang.String url)

Looks up the specified URL String from the saved HashMap.

Parameters:

url - Safe URL to look up loaded articles from. May also be KEY_FAVORITES.

Returns:

A List containing all loaded articles associated with that URL. May be null if no such URL has yet been loaded.

get

public java.util.List<Article> get(java.lang.String url,
                          java.lang.String search)

Similar to get(String) but also looks for the search term.

Parameters:

url - Safe URL to look up loaded articles from.

search - Search term.

Returns:

A List containing all loaded articles associated with that URL and query. May be null if no such URL has yet been loaded.

get

public Article get(int id)

Returns an Article object associated with the specified id.

Parameters:

id - ID belonging to such article.

Returns:

The Article associated with the specified id. May return null if no such article was found with that ID.

getFavorites

public java.util.List<Article> getFavorites()

Retrieves an ArrayList of articles from the Favorite Database.

Returns:

Either an Article List or null if database wasn't properly started.

markAllRead

public void markAllRead(boolean read)

Marks/Unmarks all loaded articles as read. This includes those loaded from all URLs and those stored in the favorites database. Those loaded after this was called will still be unread.

Parameters:

read -

markRead

public void markRead(int id,
            boolean read)

Marks an article id as read.

Parameters:

id - Article id to store its read state.

read - Whether or not to mark this id as read.

isRead

public boolean isRead(int id)

Parameters:

id - Article ID to check for its read state.

Returns:

true if such id was previously marked as read, false if it has not yet been marked as read.

saveFavorite

public boolean saveFavorite(int id)

Saves an Article object to the favorites database.

If possible, use the Article object itself instead to increase performance!

Parameters:

id - ID of the article to save.

Returns:

true if successful, false if otherwise.

saveFavorite

public boolean saveFavorite(int id,
                   boolean favorite)

Saves/Deletes an Article object to the favorites database.

If possible, use the Article object itself instead to increase performance!

Parameters:

id - ID of the article to save.

favorite - Whether to save or delete. true to save; false to delete.

Returns:

true if successful, false if otherwise.

saveFavorite

public boolean saveFavorite(Article article)

Saves an Article object to the favorites database.

Parameters:

article - Article object to save.

Returns:

true if successful, false if otherwise.

saveFavorite

public boolean saveFavorite(Article article,
                   boolean favorite)

Saves/Deletes an Article object to the favorites database.

Parameters:

article - Article object to save.

favorite - Whether to save or delete. true to save; false to delete.

Returns:

true if successful, false if otherwise.

deleteAllFavorites

public void deleteAllFavorites()

Clears the favorites database.

containsFavorite

public boolean containsFavorite(int id)

Searches the FavoriteDatabase for the specified ID.

Parameters:

id - Article ID which to search for.

Returns:

true if database contains it or false if otherwise or database not yet started.

clearCache

public boolean clearCache()

Clears Downloader cache.

Returns:

true if successfully cleared or false if otherwise.

clearData

public boolean clearData()

Clears all PkRSS data including Downloader cache, all articles in Favorite Database, and all articles marked as read.

Returns:

true if successfully cleared or false if otherwise.

getPageTracker

protected java.util.Map<java.lang.String,java.lang.Integer> getPageTracker()

Returns:

The Map used for storing page states.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

log

protected final void log(java.lang.String message)

log

protected final void log(java.lang.String tag,
       java.lang.String message)

log

protected final void log(java.lang.String message,
       int type)

log

protected final void log(java.lang.String tag,
       java.lang.String message,
       int type)