com.aspc.publication

Class PublicationTemplate

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.publication.PublicationTemplate

All Implemented Interfaces:

SecondaryCacheGroup

public class PublicationTemplate
extends DBObject

The template used to generate a publication, which is running on "DROID ".

Notes

A command shall be created to process a Publication record in order to create jobs. It will use the information contained in the Publication and its linked records to schedule a command on a queue and specify on complete and on error actions.

DESIGN

Process Publication Command

The process publication command will take the following form:

JOB SCHEDULE { process_cmd } QUEUE process_queue

ON_COMPLETE {

UPDATE PublicationEditionFile

SET status = ok

WHERE key IS $id$

}

ON_ERROR {

UPDATE PublicationEditionFile

SET status = 'failed'

WHERE key IS $id$

}

This command will be run for all PublicationTemplate classes linked to the Publication. The process_cmd and process_queue fields correspond to fields on the PublicationTemplate class. When the job is run it will create the PublicationEditionFile record.

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

Since:

15 June, 2005

Author:

Luke Butt

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 The template used to generate a publication, which is running on "DROID ".
static java.lang.String	DBCLASS_NAME The template used to generate a publication, which is running on "DROID ".

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PublicationTemplate	create(MutableDataSource mds) Make a new instance of this class.
DBFile	findFile(java.lang.String... args) The file the template is stored as.
static PublicationTemplate	findKey(DataSource ds, int key) Find the target for this class by the primary key
Publication	findPublication(java.lang.String... args) link to Publication object, the publication generated by the template.
DBQueue	findQueue(java.lang.String... args) The queue to submit this template for processing.
java.lang.String	getCommand(java.lang.String... args)
DBFile	getFile(java.lang.String... args)
int	getID(java.lang.String... args)
Publication	getPublication(java.lang.String... args)
DBQueue	getQueue(java.lang.String... args)
static DBQuery<PublicationTemplate>	makeQuery(DataSource ds) Make a new QUERY for this class.
PublicationTemplate	setCommand(java.lang.String value, java.lang.String... args)
PublicationTemplate	setFile(com.aspc.dal.file.DBFile value, java.lang.String... args)
PublicationTemplate	setID(int value, java.lang.String... args)
PublicationTemplate	setPublication(com.aspc.dal.publication.Publication value, java.lang.String... args)
PublicationTemplate	setQueue(com.aspc.dal.job.DBQueue 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, extPreSaveRecord, 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

The template used to generate a publication, which is running on "DROID ".

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The template used to generate a publication, which is running on "DROID ".

Constructor Detail

PublicationTemplate

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

Throws:

java.lang.Exception

getCommand

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

setCommand

@Nonnull
public PublicationTemplate setCommand(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getFile

@CheckReturnValue
 @Nullable
public DBFile getFile(java.lang.String... args)

findFile

@CheckReturnValue
 @Nonnull
public final DBFile findFile(java.lang.String... args)
                                                  throws NotFoundException

The file the template is stored as.

--> DBFile (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setFile

@Nonnull
public PublicationTemplate setFile(com.aspc.dal.file.DBFile value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getPublication

@CheckReturnValue
 @Nullable
public Publication getPublication(java.lang.String... args)

findPublication

@CheckReturnValue
 @Nonnull
public final Publication findPublication(java.lang.String... args)
                                                              throws NotFoundException

link to Publication object, the publication generated by the template.

--> Publication (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Publication

Throws:

NotFoundException - Publication was not found

setPublication

@Nonnull
public PublicationTemplate setPublication(com.aspc.dal.publication.Publication value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getQueue

@CheckReturnValue
 @Nullable
public DBQueue getQueue(java.lang.String... args)

findQueue

@CheckReturnValue
 @Nonnull
public final DBQueue findQueue(java.lang.String... args)
                                                    throws NotFoundException

The queue to submit this template for processing.

--> DBQueue (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBQueue

Throws:

NotFoundException - DBQueue was not found

setQueue

@Nonnull
public PublicationTemplate setQueue(com.aspc.dal.job.DBQueue value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static PublicationTemplate 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<PublicationTemplate> 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 PublicationTemplate 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