| java.lang.Object org.clapper.curn.plugins.MaxArticlesPlugIn
MaxArticlesPlugIn | public class MaxArticlesPlugIn implements MainConfigItemPlugIn,FeedConfigItemPlugIn,PostFeedParsePlugIn(Code) | | The MaxArticlesPlugIn can be used to set an upper limit on the
number of articles displayed for a feed (or for all feeds).
It looks for a default (main-configuration section) "MaxArticlesToShow"
parameter, and permits a per-feed "MaxArticlesToShow" parameter to override
the default. This plug-in deliberately uses a non-typical sort key to force
it to run after other stock plug-ins in the "post feed parse" phase.
Thus, this plug-in doesn't apply its maximum threshold test until
after:
This plug-in intercepts the following configuration parameters.
Section |
Parameter |
Meaning |
Default |
[curn] |
MaxArticlesToShow |
Global default specifying the maximum number of articles to show
per feed. Applies to all feeds that don't explicitly override this
parameter. |
None. (All articles are shown, subject to actions by other
plug-ins.) |
[Feedxxx] |
MaxArticlesToShow |
Per-feed parameter specifying the maximum number of articles to
show from the feed. |
The global MaxArticlesToShow setting. If there is
no global setting, then the default to show all articles in the
feed (subject to actions by other plug-ins). |
version: $Revision: 7041 $ |
MaxArticlesPlugIn | public MaxArticlesPlugIn()(Code) | | Default constructor (required).
|
getPlugInName | public String getPlugInName()(Code) | | Get a displayable name for the plug-in.
the name |
getPlugInSortKey | public String getPlugInSortKey()(Code) | | Get the sort key for this plug-in.
the sort key string. |
initPlugIn | public void initPlugIn() throws CurnException(Code) | | Initialize the plug-in. This method is called before any of the
plug-in methods are called.
throws: CurnException - on error |
runFeedConfigItemPlugIn | public boolean runFeedConfigItemPlugIn(String sectionName, String paramName, CurnConfig config, FeedInfo feedInfo) throws CurnException(Code) | | Called immediately after curn has read and processed a
configuration item in a "feed" configuration section. All
configuration items are passed, one by one, to each loaded plug-in.
If a plug-in class is not interested in a particular configuration
item, this method should simply return without doing anything. Note
that some configuration items may simply be variable assignment;
there's no real way to distinguish a variable assignment from a
blessed configuration item.
Parameters: sectionName - the name of the configuration section wherethe item was found Parameters: paramName - the name of the parameter Parameters: config - the active configuration Parameters: feedInfo - partially complete FeedInfo objectfor the feed. The URL is guaranteed to bepresent, but no other fields are. true to continue processing the feed,false to skip it throws: CurnException - on error See Also: CurnConfig See Also: FeedInfo See Also: FeedInfo.getURL |
runMainConfigItemPlugIn | public void runMainConfigItemPlugIn(String sectionName, String paramName, CurnConfig config) throws CurnException(Code) | | Called immediately after curn has read and processed a
configuration item in the main [curn] configuration section. All
configuration items are passed, one by one, to each loaded plug-in.
If a plug-in class is not interested in a particular configuration
item, this method should simply return without doing anything. Note
that some configuration items may simply be variable assignment;
there's no real way to distinguish a variable assignment from a
blessed configuration item.
Parameters: sectionName - the name of the configuration section wherethe item was found Parameters: paramName - the name of the parameter Parameters: config - the CurnConfig object throws: CurnException - on error See Also: CurnConfig |
runPostFeedParsePlugIn | public boolean runPostFeedParsePlugIn(FeedInfo feedInfo, FeedCache feedCache, RSSChannel channel) throws CurnException(Code) | | Called immediately after a feed is parsed, but before it is
otherwise processed. This method can return false to signal
curn that the feed should be skipped. For instance, a plug-in
that filters on the parsed feed data could use this method to weed
out non-matching feeds before they are downloaded. Similarly, a
plug-in that edits the parsed data (removing or editing individual
items, for instance) could use method to do so.
Parameters: feedInfo - the FeedInfo object for the feed thathas been downloaded and parsed. Parameters: feedCache - the feed cache Parameters: channel - the parsed channel data true if curn should continue to process thefeed, false to skip the feed. A return value offalse aborts all further processing on the feed.In particular, curn will not pass the feed along toother plug-ins that have yet to be notified of this event. throws: CurnException - on error See Also: RSSChannel See Also: FeedInfo |
|
|