| java.lang.Object
 org.clapper.curn.plugins.RetainArticlesPlugIn
| RetainArticlesPlugIn | | public class RetainArticlesPlugIn implements MainConfigItemPlugIn,FeedConfigItemPlugIn,ForceFeedDownloadPlugIn,PostFeedParsePlugIn(Code) | | The RetainArticlesPlugIn can be used to force articles in a feed
(or in all feeds) to be displayed more than once. It looks for a default
(main-configuration section) "ShowArticlesFor" parameter, and it permits
a per-feed "ShowArticlesFor" parameter to override the default. The
configuration parameter takes a time interval, expressed in a
natural language string. (The
IgnoreOldArticlesPlugIn class uses
the same time interval form.) Examples:
- 3 days
- 1 week
- 365 days
- 12 hours, 30 minutes
Valid interval names (in English) are:
- "millisecond", "milliseconds", "ms"
- "second", "seconds", "sec", "secs"
- "minutes", "minutes", "min", "mins"
- "hour", "hours", "hr", "hrs"
- "day", "days"
- "week", "weeks"
This plug-in uses the
org.clapper.util
library's
Duration
class to parse the age/duration values. See that class for more details.
This plug-in intercepts the following configuration parameters.
| Section |
Parameter |
Meaning |
Default |
| [curn] |
ShowArticlesFor |
Global default specifying how long to retain an article. Applies to
all feeds that don't explicitly override this parameter. |
None. (Articles displayed only once.) |
| [Feedxxx] |
IgnoreArticlesOlderThan |
Per-feed parameter specifying how long to retain an article. |
The global IgnoreArticlesOlderThan setting. If there is
no global setting, then the default is to display articles only
once. |
WARNING: Beware of interactions with the
IgnoreOldArticlesPlugIn class. For instance, if you use
"ShowArticlesFor" to show articles for 5 days, but you also use
"IgnoreArticlesOlderThan" to discard articles older than 2 days,
the "IgnoreArticlesOlderThan parameter takes precedence.
version:
$Revision: 7041 $ |
| RetainArticlesPlugIn | | public RetainArticlesPlugIn()(Code) | | Creates a new instance of RetainArticlesPlugIn
|
| forceFeedDownload | | public boolean forceFeedDownload(FeedInfo feedInfo, FeedCache feedCache) throws CurnException(Code) | | This method determines (based on some internal criteria) whether
a given feed should be downloaded even if it hasn't changed. If multiple
plug-ins implement this interface, then only one needs to return
true for the feed download to be forced.
Parameters:
feedInfo - the FeedInfo object for the feed thathas been downloaded and parsed.
Parameters:
feedCache - the feed cache, or null if there isn't one true if the feed should be downloaded and parsedeven if it's not out of date; false if curn'snormal downloading rules should apply.
throws:
CurnException - on error |
| 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 |
|
|