com.aspc.cms.component

Class FeedComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.component.FeedComponent

All Implemented Interfaces:

SecondaryCacheGroup

public class FeedComponent
extends SiteComponent

RSS feed processing component.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

10 Dec 2012

Author:

Liam

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID RSS feed processing component
static java.lang.String	DBCLASS_NAME RSS feed processing component

Fields inherited from class com.aspc.cms.SiteComponent

SNAP2MAP

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
FeedComponent(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page)
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
SiteFeedParser	findParser(java.lang.String... args) RSS Feed Parser.
FeedComponent	findTemplate(java.lang.String... args) The feed template.
java.lang.String	getCachePeriod(java.lang.String... args)
java.lang.String	getHandlebars(java.lang.String... args)
java.lang.String	getJsonData(java.lang.String... args)
java.lang.String	getPageDescriptionXPath(java.lang.String... args)
java.lang.String	getPageDescriptionXPathCalculated(java.lang.String... args)
java.lang.String	getPageImgXPath(java.lang.String... args)
java.lang.String	getPageImgXPathCalculated(java.lang.String... args)
java.lang.String	getPageKeywordsXPath(java.lang.String... args)
java.lang.String	getPageKeywordsXPathCalculated(java.lang.String... args)
java.lang.String	getPageTitleXPath(java.lang.String... args)
java.lang.String	getPageTitleXPathCalculated(java.lang.String... args)
java.lang.String	getPageURLXPath(java.lang.String... args)
java.lang.String	getPageURLXPathCalculated(java.lang.String... args)
SiteFeedParser	getParser(java.lang.String... args)
FeedComponent	getTemplate(java.lang.String... args)
java.lang.String	getUrl(java.lang.String... args)
java.lang.String	getXSLT(java.lang.String... args)
java.lang.String	getXsltCalculated(java.lang.String... args)
static org.w3c.dom.Document	makeDoc(WebClient client, java.lang.String url, java.lang.String timeToLive)
HTMLTags	makeTags(WebClient client, HTMLPage page, java.lang.String url, java.lang.String timeToLive)
HTMLTags	makeTags(WebClient client, HTMLPage page, java.lang.String url, java.lang.String timeToLive, ArticleComponent article)
static java.lang.String	parseURL(java.lang.String url, WebClient client) find ${XXXX} and replace with real value from client
FeedComponent	setCachePeriod(java.lang.String value, java.lang.String... args)
FeedComponent	setHandlebars(java.lang.String value, java.lang.String... args)
FeedComponent	setPageDescriptionXPath(java.lang.String value, java.lang.String... args)
FeedComponent	setPageImgXPath(java.lang.String value, java.lang.String... args)
FeedComponent	setPageKeywordsXPath(java.lang.String value, java.lang.String... args)
FeedComponent	setPageTitleXPath(java.lang.String value, java.lang.String... args)
FeedComponent	setPageURLXPath(java.lang.String value, java.lang.String... args)
FeedComponent	setParser(com.aspc.dal.cms.SiteFeedParser value, java.lang.String... args)
FeedComponent	setTemplate(com.aspc.dal.cms.component.FeedComponent value, java.lang.String... args)
FeedComponent	setUrl(java.lang.String value, java.lang.String... args)
FeedComponent	setXSLT(java.lang.String value, java.lang.String... args)
java.lang.String	toString() The description.

Methods inherited from class com.aspc.cms.SiteComponent

addEdit, addEdit, canHandleNoneType, changeLinks, editHTML, extCopy, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extValidateDelete, extValidateRecord, findContainer, findIcon, findKey, findOwnedBySite, findVisibilityDesktop, findVisibilityMobile, findVisibilityTablet, getAccessibilityWarningCount, getAccessibilityWarningResult, getComponentPath, getContainer, getCreatedTS, getDefaultEncoding, getDerivedStyleClass, getDescendant, getDisplayPath, getDisplayTitle, getDisplayType, getDisplayXPath, getHandlebarsData, getHandlebarsHelpers, getIcon, getIconPath, getKey, getName, getOwnedBySite, getPage, getResult, getSequence, getSnap2Id, getStyleClass, getStyleClassVariable, getTargetWindow, getVisibilityDesktop, getVisibilityMobile, getVisibilityTablet, hasAttributes, isFinalFg, isLocked, isRelevantComponent, makeClone, makeDIV, makeQuery, makeSane, parseText, process, setAccessibilityWarningCount, setAccessibilityWarningResult, setContainer, setCreatedTS, setFinalFg, setHasAttributes, setId, setKey, setName, setSequence, setSnap2Id, setStyleClass, setStyleClassVariable, setVisibilityDesktop, setVisibilityMobile, setVisibilityTablet, shouldShow

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

RSS feed processing component

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

RSS feed processing component

Constructor Detail

FeedComponent

public FeedComponent(DBClass def,
                     DataSource dataSource)
              throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getXSLT

@CheckReturnValue
 @Nonnull
public java.lang.String getXSLT(java.lang.String... args)

setXSLT

@Nonnull
public FeedComponent setXSLT(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getXsltCalculated

@CheckReturnValue
 @Nonnull
public java.lang.String getXsltCalculated(java.lang.String... args)

getCachePeriod

@CheckReturnValue
 @Nonnull
public java.lang.String getCachePeriod(java.lang.String... args)

setCachePeriod

@Nonnull
public FeedComponent setCachePeriod(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getHandlebars

@CheckReturnValue
 @Nonnull
public java.lang.String getHandlebars(java.lang.String... args)

setHandlebars

@Nonnull
public FeedComponent setHandlebars(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getJsonData

@CheckReturnValue
 @Nonnull
public java.lang.String getJsonData(java.lang.String... args)

getPageDescriptionXPath

@CheckReturnValue
 @Nonnull
public java.lang.String getPageDescriptionXPath(java.lang.String... args)

setPageDescriptionXPath

@Nonnull
public FeedComponent setPageDescriptionXPath(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getPageDescriptionXPathCalculated

@CheckReturnValue
 @Nonnull
public java.lang.String getPageDescriptionXPathCalculated(java.lang.String... args)

getPageImgXPath

@CheckReturnValue
 @Nonnull
public java.lang.String getPageImgXPath(java.lang.String... args)

setPageImgXPath

@Nonnull
public FeedComponent setPageImgXPath(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getPageImgXPathCalculated

@CheckReturnValue
 @Nonnull
public java.lang.String getPageImgXPathCalculated(java.lang.String... args)

getPageKeywordsXPath

@CheckReturnValue
 @Nonnull
public java.lang.String getPageKeywordsXPath(java.lang.String... args)

setPageKeywordsXPath

@Nonnull
public FeedComponent setPageKeywordsXPath(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getPageKeywordsXPathCalculated

@CheckReturnValue
 @Nonnull
public java.lang.String getPageKeywordsXPathCalculated(java.lang.String... args)

getPageTitleXPath

@CheckReturnValue
 @Nonnull
public java.lang.String getPageTitleXPath(java.lang.String... args)

setPageTitleXPath

@Nonnull
public FeedComponent setPageTitleXPath(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getPageTitleXPathCalculated

@CheckReturnValue
 @Nonnull
public java.lang.String getPageTitleXPathCalculated(java.lang.String... args)

getPageURLXPath

@CheckReturnValue
 @Nonnull
public java.lang.String getPageURLXPath(java.lang.String... args)

setPageURLXPath

@Nonnull
public FeedComponent setPageURLXPath(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getPageURLXPathCalculated

@CheckReturnValue
 @Nonnull
public java.lang.String getPageURLXPathCalculated(java.lang.String... args)

getParser

@CheckReturnValue
 @Nullable
public SiteFeedParser getParser(java.lang.String... args)

findParser

@CheckReturnValue
 @Nonnull
public final SiteFeedParser findParser(java.lang.String... args)
                                                            throws NotFoundException

RSS Feed Parser.

--> SiteFeedParser (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteFeedParser

Throws:

NotFoundException - SiteFeedParser was not found

setParser

@Nonnull
public FeedComponent setParser(com.aspc.dal.cms.SiteFeedParser value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getTemplate

@CheckReturnValue
 @Nullable
public FeedComponent getTemplate(java.lang.String... args)

findTemplate

@CheckReturnValue
 @Nonnull
public final FeedComponent findTemplate(java.lang.String... args)
                                                             throws NotFoundException

The feed template.

--> FeedComponent (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

RSS Feed

Throws:

NotFoundException - FeedComponent was not found

setTemplate

@Nonnull
public FeedComponent setTemplate(com.aspc.dal.cms.component.FeedComponent value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getUrl

@CheckReturnValue
 @Nonnull
public java.lang.String getUrl(java.lang.String... args)

setUrl

@Nonnull
public FeedComponent setUrl(@MatchesPattern(value="(/ReST/v2/article)|(/ReST/v2/article\\?|http://|https://).*|(/feed)|(/feed\\?|http://|https://).*")
                                     java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class SiteComponent

Throws:

java.lang.Exception - A Serious problem

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Description copied from class: DBObject

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Overrides:

extGetDerivedGlobalKey in class SiteComponent

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class SiteComponent

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

makeDoc

public static org.w3c.dom.Document makeDoc(WebClient client,
                                           @Nonnull
                                           java.lang.String url,
                                           java.lang.String timeToLive)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

makeTags

public HTMLTags makeTags(WebClient client,
                         HTMLPage page,
                         java.lang.String url,
                         java.lang.String timeToLive)
                  throws java.lang.Exception

Throws:

java.lang.Exception

makeTags

public HTMLTags makeTags(WebClient client,
                         HTMLPage page,
                         java.lang.String url,
                         java.lang.String timeToLive,
                         ArticleComponent article)
                  throws java.lang.Exception

Throws:

java.lang.Exception

extProcess

public HTMLComponent extProcess(WebClient client,
                                Site site,
                                HTMLPage page)
                         throws java.lang.Exception

Specified by:

extProcess in class SiteComponent

Throws:

java.lang.Exception

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class SiteComponent

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

parseURL

public static java.lang.String parseURL(java.lang.String url,
                                        WebClient client)

find ${XXXX} and replace with real value from client

Parameters:

url -

client - the client to use

Returns:

the value