class: Feed

public class: Feed
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:20:28; Modified: 16.07.2009 15:20:28;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {230CA1E3-25F7-444c-84FE-F4241BE86515}
 

Goto: Custom Properties, Fields, Methods

Appears in: feed

Custom Properties
 
Feed Attributes
Attribute Details
private String
  cachingStatus
Notes: use caching if "true", do not use, otherwise
private String
  cachingTtl
Notes: TTL for until the channel, it will be recached after
private static const String
  CDATA
Initial: ""
Notes: private Search itemContainerSearch = new SearchBeanLocal();
@EJB private Search itemContainerSearch;
private String
  feedTypes
Notes: List of the all available types for the feed
private static const Logger
  logger
Initial: Logger.getLogger(Feed.class)
private String
  maximumRecords
Notes: Records limit
private HashMap
  paramHash
Initial: new HashMap()
Notes: Hash of the parameters/values
private ArrayList
  paramList
Initial: new ArrayList()
Notes: List of the parameters generated according to the URI
private String
  query
Notes: Search CQL query see: http://www.escidoc-project.de/documentation/Soap_api_doc_SB_Search.pdf
private String
  relLink
Notes: template for html rel link generation
private static const long
  serialVersionUID
Initial: 1L
private String
  sortKeys
Notes: Sort keys
private String
  uriMatcher
Notes: uriMatcher is RegExp for URI matching
 
Feed Methods
Operation Details
public
addAuthor(
   SyndPerson sp):void
Sequential
Notes: Add new SyndPerson as Author.
public
addCategory(
   SyndCategory sc):void
Sequential
Notes: Add new SyndCategory.
public
clone():Object
Sequential
Tags: annotations=@Override
Notes: (non-Javadoc)
@see com.sun.syndication.feed.synd.SyndFeedImpl#clone()
private
escapeUri(
   String uri):String
Sequential
public
generateRelLink(
   String uri):String
Sequential
Tags: throws=SyndicationException
public
generateUriMatcher(
   String uri):void
Sequential
Notes: Generate <code>UriMatcher</code> for the feed and list of the parameters <code>paramList</code> according to the <code>uri</code>.
public
getCachingStatus():String
Sequential
Notes: CachingStatus getter.
@return <code>CachingStatus</code>
public
getCachingTtl():String
Sequential
Notes: CachingTtl getter.
@return <code>CachingTtl</code>
private
getFeedMimeType(
   String feedType):String
Sequential
Tags: throws=SyndicationException
public
getFeedTypes():String
Sequential
Notes: FeedTypes getter.
@return <code>FeedTypes</code>
public
getMaximumRecords():String
Sequential
Notes: MaximumRecords getter.
@return <code>MaximumRecords</code>
public
getParamList():List
Sequential
Notes: ParamList getter
@return <code>ParamList</code>
public
getQuery():String
Sequential
Notes: Query getter.
@return <code>query</code>
public
getRelLink():String
Sequential
public
getSortKeys():String
Sequential
Notes: SortKeys getter
@return <code>sortKeys</code>
public
getUriMatcher():String
Sequential
Notes: UriMatcher getter.
@return <code>UriMatcher</code>
private
isRSS_09_or_091N_or_091U():boolean
Sequential
Notes: <code>True</code> for RSS 0.9, 0.91*
@return
private
performSearch(
   String query,
   String maximumRecords,
   String sortKeys):String
Sequential
Tags: throws=SyndicationException
Notes: Search for the items for feed entries population. The HTTP request to the SearchAndExport WEB interface is used
@return item list XML
public
populateEntries(
   String uri):void
Sequential
Tags: throws=SyndicationException
Notes: Main method for entries population of the feed/channel according to the <code>uri</code>
private
populateFeedElementsWithParams():void
Sequential
Tags: throws=SyndicationException
Notes: List of feed/channel elements to be populated by @see #populateFieldWithParams(String, String)
public
populateFieldWithParams(
   String name,
   String value):String
Sequential
Tags: throws=SyndicationException
Notes: Populate feed/channel element with the parameters from the <code>paramHash</code>
@return populated <code>value</code>
private
populateParamsFromUri(
   String uri):void
Sequential
Tags: throws=SyndicationException
Notes: Populate parameters with the values taken from the certain <code>uri</code> and populate <code>paramHash</code> with the parameter/value paars.
private
replaceXmlHeader(
   String xml):String
Sequential
Notes: Removes xml header
@return
public
setCachingStatus(
   String status):void
Sequential
Notes: CachingStatus setter.
public
setCachingTtl(
   String cachingTtl):void
Sequential
Notes: CachingTtl setter.
private
setChannelLimitations():void
Sequential
Notes: set channel limitations
private
setEntryLimitations(
   SyndEntry se):void
Sequential
Notes: set entry limitations
public
setFeedTypes(
   String feedTypes):void
Sequential
Notes: FeedTypes setter.
public
setMaximumRecords(
   String maximumRecords):void
Sequential
Notes: MaximumRecords setter.
public
setParamList(
   List paramList):void
Sequential
Notes: ParamList setter.
public
setQuery(
   String query):void
Sequential
Notes: Query setter.
public
setRelLink(
   String relLink):void
Sequential
public
setSortKeys(
   String sortKeys):void
Sequential
Notes: SortKeys setter.
public
setUri(
   String uri):void
Sequential
Tags: annotations=@Override
Notes: (non-Javadoc)
@see com.sun.syndication.feed.synd.SyndFeedImpl#setUri(java.lang.String)
public
setUriMatcher(
   String uriMatcher):void
Sequential
Notes: UriMatcher setter.
public
toString():String
Sequential
private
transformToEntryList(
   String itemListXml):List
Sequential
Tags: throws=SyndicationException
Notes: Transformation method takes ItemList XML and transforms it to the list of syndication entries (<code><List>SyndEntry</code>)
@return <List>SyndEntry