public interface FeedReader
This class defines a common interface for feed readers. If you want to implement a custom feed reader, your feed reader must implement this class.
Also, the name of the custom reader must be specified in the feed configuration file. For example,
The interface provides method to return the feed entries in form of a list, given the end point name. For each entry, individual attributes can also be fetched using the getter methods provided.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCategory(java.lang.Object entry)
Returns the category attribute of the feed entry
|
java.lang.String |
getContentLanguage(java.lang.Object entry)
Returns the content language attribute of the feed entry
|
java.lang.String |
getContentSource(java.lang.Object entry)
Returns the content source attribute of the feed entry
|
java.lang.String |
getContentType(java.lang.Object entry)
Returns the content type attribute of the feed entry
|
java.lang.String |
getContentValue(java.lang.Object entry)
Returns the content value attribute of the feed entry
|
java.util.Map |
getEntries(java.lang.String endPointName)
For a given endPointName, this function retrieves a Map of FeedID (String) to the corresponding list of entries present in the feed.
|
java.lang.String |
getIdentifier(java.lang.Object entry)
Returns the identifier attribute of the feed entry
|
java.lang.String |
getLongDescription(java.lang.Object entry)
Returns the long description attribute of the feed entry
|
java.lang.String |
getName(java.lang.Object entry)
Returns the name attribute of the a feed entry
|
java.lang.String |
getShortDescription(java.lang.Object entry)
Returns the short description attribute of the feed entry
|
static final java.lang.String COPYRIGHT
java.util.Map getEntries(java.lang.String endPointName) throws DataLoadApplicationException
endPointName
- The name of the feed end point as specified in the feed configuration file.
Using the feed end point name, the information specified in the configuration file, like, feed URL and connection properties will be retrieved by the utility.DataLoadApplicationException
java.lang.String getIdentifier(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getName(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getShortDescription(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getLongDescription(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getContentSource(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getContentType(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getContentValue(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getContentLanguage(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException
java.lang.String getCategory(java.lang.Object entry) throws DataLoadApplicationException
entry
- The feed entry object that needs to be parsed.DataLoadApplicationException