| java.lang.Object
 org.clapper.curn.AbstractPersistentDataClient
| AbstractPersistentDataClient | | public class AbstractPersistentDataClient implements PersistentDataClient(Code) | | Abstract class that implements the
PersistentDataClient interface, providing stubs or simple versions of the methods. This class
makes it easier for a class to declare itself as a
PersistentDataClient, even if it doesn't need to implement all
the PersistentDataClient methods.
version:
$Revision: 6956 $ |
| Method Summary | |
| public Map<String, String> | getExtraFeedMetadata()
Get any extra metadata (i.e., data that is not associated with a feed
or an item) that is to be saved.
This stub implementation does nothing and returns an empty map.
a Map of all the name/value pairs to be associatedwith the feed. | | public Map<String, String> | getMetadataForFeed(FeedCacheEntry feedData)
Get the metadata that is to be saved with a particular feed or
channel.
This stub implementation does nothing and returns an empty map.
Parameters:
feedData - the FeedCacheEntry record for the feed a Map of all the name/value pairs to be associatedwith the feed. | | public Map<String, String> | getMetadataForItem(FeedCacheEntry itemData, FeedCacheEntry feedData)
Get the metadata that is to be saved with a particular item within a
feed.
This stub implementation does nothing and returns an empty map.
Parameters:
itemData - the FeedCacheEntry record for the item
Parameters:
feedData - the FeedCacheEntry record for the parent feed a Map of all the name/value pairs to be associatedwith the item. | | public String | getMetatdataNamespace()
Get the namespace for this object's metadata. | | public void | parseExtraMetadata(String name, String value)
Process an "extra" data item that is not associated with a feed
or an item. | | public void | parseFeedMetadata(String name, String value, FeedCacheEntry feedData)
Process a data item that has been read from the metadata store
and is associated with a feed (or channel). | | public void | parseItemMetadata(String name, String value, FeedCacheEntry itemData)
Process a data item that has been read from the metadata store
and is associated with a cached item. |
| AbstractPersistentDataClient | | protected AbstractPersistentDataClient()(Code) | | Creates a new instance of AbstractPersistentDataClient
|
| getExtraFeedMetadata | | public Map<String, String> getExtraFeedMetadata() throws CurnException(Code) | | Get any extra metadata (i.e., data that is not associated with a feed
or an item) that is to be saved.
This stub implementation does nothing and returns an empty map.
a Map of all the name/value pairs to be associatedwith the feed. The names should not be qualified by thenamespace; the caller will handle that. An empty or nullmap signifies that this object has no extract metadata.
throws:
CurnException - on error |
| getMetadataForFeed | | public Map<String, String> getMetadataForFeed(FeedCacheEntry feedData) throws CurnException(Code) | | Get the metadata that is to be saved with a particular feed or
channel.
This stub implementation does nothing and returns an empty map.
Parameters:
feedData - the FeedCacheEntry record for the feed a Map of all the name/value pairs to be associatedwith the feed. The names should not be qualified by thenamespace; the caller will handle that. An empty or nullmap signifies that this object has no metadata for the feed.
throws:
CurnException - on error |
| getMetadataForItem | | public Map<String, String> getMetadataForItem(FeedCacheEntry itemData, FeedCacheEntry feedData) throws CurnException(Code) | | Get the metadata that is to be saved with a particular item within a
feed.
This stub implementation does nothing and returns an empty map.
Parameters:
itemData - the FeedCacheEntry record for the item
Parameters:
feedData - the FeedCacheEntry record for the parent feed a Map of all the name/value pairs to be associatedwith the item. The names should not be qualified by thenamespace; the caller will handle that. An empty or nullmap signifies that this object has no metadata for the item.
throws:
CurnException - on error |
| getMetatdataNamespace | | public String getMetatdataNamespace()(Code) | | Get the namespace for this object's metadata. The namespace must
be unique. Think of it as a package name for the data. Recommendation:
Use the fully-qualified class name.
This implementation returns the fully-qualified class name of the
subclass.
the namespace |
| parseExtraMetadata | | public void parseExtraMetadata(String name, String value) throws CurnException(Code) | | Process an "extra" data item that is not associated with a feed
or an item. This method is called when the metadata store is
being loaded into memory at the beginning of a curn run.
This method is only called for data items within this object's name
space.
Parameters:
name - the name of the data item
Parameters:
value - its value
throws:
CurnException - on error
See Also: AbstractPersistentDataClient.getMetatdataNamespace |
| parseFeedMetadata | | public void parseFeedMetadata(String name, String value, FeedCacheEntry feedData) throws CurnException(Code) | | Process a data item that has been read from the metadata store
and is associated with a feed (or channel). This method is
called when the metadata store is being loaded into memory
at the beginning of a curn run. This method is only called
for data items within this object's name space.
This stub implementation does nothing.
Parameters:
name - the name associated with the data item
Parameters:
value - the (string) value of the data
Parameters:
feedData - the FeedCacheEntry record for the feed
See Also: AbstractPersistentDataClient.getMetatdataNamespace
throws:
CurnException - on error |
| parseItemMetadata | | public void parseItemMetadata(String name, String value, FeedCacheEntry itemData) throws CurnException(Code) | | Process a data item that has been read from the metadata store
and is associated with a cached item. This method is called when
the metadata store is being loaded into memory at the beginning
of a curn run. This method is only called for data items
within this object's name space.
This stub implementation does nothing.
Parameters:
name - the name associated with the data item
Parameters:
value - the (string) value of the data
Parameters:
itemData - The FeedCacheEntry data for the item
throws:
CurnException - on error
See Also: AbstractPersistentDataClient.getMetatdataNamespace |
|
|