Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES  

coldbox.system.web.feeds
Class RSS2Generator

WEB-INF.cftags.component
        extended by coldbox.system.web.feeds.SharedGenerator
            extended by coldbox.system.web.feeds.RSS2Generator

public class RSS2Generator

extends SharedGenerator

Methods belonging to the FeedGenerator plug-in that specifically relate to RSS creation

Constructor Summary
init()
 
Method Summary
 struct createInstances(struct instance)
          Variables used for the validation and creation of RSS 2 data
 string generateChannel(struct feedStruct, [struct ColumnMap='[runtime expression]'])
          Generate the RSS channel as XML
 struct generateDefaultPropertyMap()
          Generates the default property map
 string generateItems(struct feedStruct, [struct ColumnMap])
          Generate the RSS items as XML
private string generateNameSpace(struct columnMap, struct feedStruct)
          Generates the XML namespaces depending on the tags in use
 void verifyFeed(struct feedStruct, [struct ColumnMap='[runtime expression]'])
          Verify the RSS 2 feed structure and append auto-generated properties
private string verifyItems(query feedItems, [struct ColumnMap='[runtime expression]'], string invalidList)
          Verify the feed item data and structure
 
Methods inherited from class coldbox.system.web.feeds.SharedGenerator
RSSFormat, URLFormat, XSLFormat, cclicenseGenChannel, cclicenseGenItem, cclicenseValChannel, cclicenseValItem, dcmtGenChannel, dcmtGenItem, generateExtensionNameSpace, generateExtensionPropertyMap, generateNum1kSeparator, generateNumSuffix, generateRFC822Date, itunesGenChannel, itunesGenItem, itunesValChannel, ituneseValItem, opensearchGenChannel, opensearchValChannel, parseColumnMap, slashGenItem, slashValItem, validateDaysList, validateHoursList, validateItunesDuration, validateNNInteger, validatePerson, validateRFC1766, validateRFC3066, validateRFC822Date, validateURI, validateURL, validatecommonslicense
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()

Method Detail

createInstances

public struct createInstances(struct instance)
Variables used for the validation and creation of RSS 2 data

Overrides:
createInstances in class SharedGenerator
Parameters:
instance -

generateChannel

public string generateChannel(struct feedStruct, [struct ColumnMap='[runtime expression]'])
Generate the RSS channel as XML

Parameters:
feedStruct - The structure used to build a feed
ColumnMap - The column mapper to wire items to queries

generateDefaultPropertyMap

public struct generateDefaultPropertyMap()
Generates the default property map

generateItems

public string generateItems(struct feedStruct, [struct ColumnMap])
Generate the RSS items as XML

Parameters:
feedStruct - The structure used to build a feed
ColumnMap - The column mapper to map items to queries

generateNameSpace

private string generateNameSpace(struct columnMap, struct feedStruct)
Generates the XML namespaces depending on the tags in use

Parameters:
columnMap - The column map structure
feedStruct - The feed structure

verifyFeed

public void verifyFeed(struct feedStruct, [struct ColumnMap='[runtime expression]'])
Verify the RSS 2 feed structure and append auto-generated properties

Parameters:
feedStruct - The structure used to build a feed
ColumnMap - The column mapper to map items to queries

verifyItems

private string verifyItems(query feedItems, [struct ColumnMap='[runtime expression]'], string invalidList)
Verify the feed item data and structure

Parameters:
feedItems - The feed items
ColumnMap - The column mapper to map items to queries
invalidList - Existing collection of debug/validation errors
Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES