com.aspc.cms.spider

Class SiteSpider

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.spider.SiteSpider

All Implemented Interfaces:

SecondaryCacheGroup

public class SiteSpider
extends DBObject

Site Spider.

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

Since:

20 April 2013

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 java.lang.String	AGENT
static GlobalId	DBCLASS_GID Site Spider
static java.lang.String	DBCLASS_NAME Site Spider

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SiteSpider	create(MutableDataSource mds) Make a new instance of this class.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
SiteSpiderConfig	findConfiguration(java.lang.String... args) The configuration for this spider.
static SiteSpider	findKey(DataSource ds, int key) Find the target for this class by the primary key
SiteSpiderConfig	getConfiguration(java.lang.String... args)
int	getID(java.lang.String... args)
int	getMaxPages(java.lang.String... args)
java.lang.String	getMessage(java.lang.String... args)
java.lang.String	getSiteName(java.lang.String... args)
java.lang.String	getURL(java.lang.String... args)
boolean	isImportNow(java.lang.String... args)
static DBQuery<SiteSpider>	makeQuery(DataSource ds) Make a new QUERY for this class.
SiteSpider	setConfiguration(com.aspc.dal.cms.spider.SiteSpiderConfig value, java.lang.String... args)
SiteSpider	setID(int value, java.lang.String... args)
SiteSpider	setImportNow(boolean value, java.lang.String... args)
SiteSpider	setMaxPages(int value, java.lang.String... args)
SiteSpider	setMessage(java.lang.String value, java.lang.String... args)
SiteSpider	setSiteName(java.lang.String value, java.lang.String... args)
SiteSpider	setURL(java.lang.String value, java.lang.String... args)

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, 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, toString, 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

Site Spider

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Site Spider

AGENT

public static final java.lang.String AGENT

See Also:

Constant Field Values

Constructor Detail

SiteSpider

public SiteSpider(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

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public SiteSpider setID(int 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 SiteSpider setURL(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getConfiguration

@CheckReturnValue
 @Nullable
public SiteSpiderConfig getConfiguration(java.lang.String... args)

findConfiguration

@CheckReturnValue
 @Nonnull
public final SiteSpiderConfig findConfiguration(java.lang.String... args)
                                                                     throws NotFoundException

The configuration for this spider.

--> SiteSpiderConfig (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteSpiderConfig

Throws:

NotFoundException - SiteSpiderConfig was not found

setConfiguration

@Nonnull
public SiteSpider setConfiguration(com.aspc.dal.cms.spider.SiteSpiderConfig value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isImportNow

@CheckReturnValue
public boolean isImportNow(java.lang.String... args)

setImportNow

@Nonnull
public SiteSpider setImportNow(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getMaxPages

@CheckReturnValue
 @Nonnegative
public int getMaxPages(java.lang.String... args)

setMaxPages

@Nonnull
public SiteSpider setMaxPages(int value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

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

setMessage

@Nonnull
public SiteSpider setMessage(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getSiteName

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

setSiteName

@Nonnull
public SiteSpider setSiteName(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static SiteSpider create(@Nonnull
                                                            MutableDataSource mds)
                                                     throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<SiteSpider> makeQuery(@Nonnull
                                                                        DataSource ds)
                                                                 throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static SiteSpider findKey(@Nonnull
                                                             DataSource ds,
                                                             int key)
                                                      throws NotFoundException,
                                                             java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

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 DBObject

Throws:

java.lang.Exception - A Serious problem