org.blojsom.plugin.fetcher
Class FetcherHelperPlugin.FetcherHelper

java.lang.Object
  extended byorg.blojsom.plugin.fetcher.FetcherHelperPlugin.FetcherHelper
Enclosing class:
FetcherHelperPlugin

public class FetcherHelperPlugin.FetcherHelper
extends java.lang.Object

Fetcher helper is the actual class with methods for retrieving blog entries.

Since:
blojsom 2.24
Author:
David Czarnecki

Constructor Summary
FetcherHelperPlugin.FetcherHelper(BlojsomFetcher fetcher, BlogUser blog)
          Create a new instance of the fetcher helper.
 
Method Summary
 BlogEntry[] fetchEntriesForCategory(java.lang.String categoryName, int entriesLimit)
          Fetch entries for a given category allowing for a limit on number of entries returned.
 BlogEntry[] fetchEntriesForFlavor(java.lang.String flavor, int entriesLimit)
          Fetch entries for a given flavor allowing for a limit on number of entries returned.
 BlogEntry fetchPermalink(java.lang.String categoryName, java.lang.String permalink)
          Fetch a specific entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FetcherHelperPlugin.FetcherHelper

public FetcherHelperPlugin.FetcherHelper(BlojsomFetcher fetcher,
                                         BlogUser blog)
Create a new instance of the fetcher helper.

Parameters:
fetcher - BlojsomFetcher used to retrieve entries
blog - BlogUser information
Method Detail

fetchEntriesForCategory

public BlogEntry[] fetchEntriesForCategory(java.lang.String categoryName,
                                           int entriesLimit)
Fetch entries for a given category allowing for a limit on number of entries returned.

Parameters:
categoryName - Category name
entriesLimit - Limit on number of entries to return. Use -1 for all entries from category.
Returns:
Entries from specified category

fetchEntriesForFlavor

public BlogEntry[] fetchEntriesForFlavor(java.lang.String flavor,
                                         int entriesLimit)
Fetch entries for a given flavor allowing for a limit on number of entries returned.

Parameters:
flavor - Flavor name
entriesLimit - Limit on number of entries to return. Use -1 for all entries from category.
Returns:
Entries for specified flavor

fetchPermalink

public BlogEntry fetchPermalink(java.lang.String categoryName,
                                java.lang.String permalink)
Fetch a specific entry.

Parameters:
categoryName - Category name
permalink - Permalink name of entry.
Returns:
Permalink entry or null if no entry is found matching the criteria