com.aspc.publication

Class Publication

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.publication.Publication

All Implemented Interfaces:

SecondaryCacheGroup

public class Publication
extends DBObject

Contains information about a feed that is scheduled to run on a 'DROID'. The feed result is converted to a publication and distributed to clients.

Notes

The Publication provides a definition for the automated production of documents and their distribution to the relevant recipents.

The Publication defines the details for the next distribution which includes:
- the PublicationRecipients which defines the recipients who will receive
- the distribution method (i.e Email, FTP)
- the format of the documents(i.e PDF)
- the PublicationTemplates which defines the commands used to produce the original documents before conversion to specific formats
- the schedule through a series of PublicationRepeatRules (These repeat rules implement the iCalendar standard rfc2445.).

The time of the next publication is determined through the field Publication::nextRunTime which is calculated as the most recent time as calculated through each of the PublicationRepeatRules.

Events trigger the generation of a new Editions when the next Publication time is reached. This is done through the DBEvent which scans for Publication::nextRunTime less than the current time. The DBAction for this DBEvent will call the command EDITION CREATE publication

The EDITION CREATE command will generate an Edition, EditionRecipient and EditionFile which will then generate the desired documents and then distribute.

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 Contains information about a feed that is scheduled to run on a 'DROID'.
static java.lang.String	DBCLASS_NAME Contains information about a feed that is scheduled to run on a 'DROID'.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Publication	create(MutableDataSource mds) Make a new instance of this class.
Person	findAnalyst(java.lang.String... args) Name of analyst or data administrator responsible for feed.
PublicationNote	findCurrentNote(java.lang.String... args) The last note entered.
static Publication	findKey(DataSource ds, int key) Find the target for this class by the primary key
Country	findRegion(java.lang.String... args) The Region.
Person	getAnalyst(java.lang.String... args)
java.lang.String	getAnalystName(java.lang.String... args)
java.util.Date	getCalculatedNextRunTime(java.lang.String... args)
PublicationNote	getCurrentNote(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getHeadline(java.lang.String... args)
int	getID(java.lang.String... args)
java.util.Date	getLastRunTime(java.lang.String... args)
java.util.Date	getManNextRunTime(java.lang.String... args)
java.util.Date	getNextRunTime(java.lang.String... args)
java.lang.String	getOutputFileName(java.lang.String... args)
java.lang.String	getProcessingStatus(java.lang.String... args)
Country	getRegion(java.lang.String... args)
boolean	isCreateTagFile(java.lang.String... args)
boolean	isExternal(java.lang.String... args)
boolean	isInactiveFg(java.lang.String... args)
boolean	isInternal(java.lang.String... args)
boolean	isReview(java.lang.String... args)
static DBQuery<Publication>	makeQuery(DataSource ds) Make a new QUERY for this class.
Publication	setAnalyst(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
Publication	setCalculatedNextRunTime(java.util.Date value, java.lang.String... args)
Publication	setCreateTagFile(boolean value, java.lang.String... args)
Publication	setDescription(java.lang.String value, java.lang.String... args)
Publication	setExternal(boolean value, java.lang.String... args)
Publication	setHeadline(java.lang.String value, java.lang.String... args)
Publication	setID(int value, java.lang.String... args)
Publication	setInactiveFg(boolean value, java.lang.String... args)
Publication	setInternal(boolean value, java.lang.String... args)
Publication	setManNextRunTime(java.util.Date value, java.lang.String... args)
Publication	setOutputFileName(java.lang.String value, java.lang.String... args)
Publication	setProcessingStatus(java.lang.String value, java.lang.String... args)
Publication	setRegion(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Publication	setReview(boolean 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

Contains information about a feed that is scheduled to run on a 'DROID'. The feed result is converted to a publication and distributed to clients.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Contains information about a feed that is scheduled to run on a 'DROID'. The feed result is converted to a publication and distributed to clients.

Constructor Detail

Publication

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

Throws:

java.lang.Exception

getAnalyst

@CheckReturnValue
 @Nullable
public Person getAnalyst(java.lang.String... args)

findAnalyst

@CheckReturnValue
 @Nonnull
public final Person findAnalyst(java.lang.String... args)
                                                     throws NotFoundException

Name of analyst or data administrator responsible for feed.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setAnalyst

@Nonnull
public Publication setAnalyst(com.aspc.dal.dbobj.contact.Person value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getAnalystName

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

getCalculatedNextRunTime

@CheckReturnValue
 @Nullable
public java.util.Date getCalculatedNextRunTime(java.lang.String... args)

setCalculatedNextRunTime

@Nonnull
public Publication setCalculatedNextRunTime(java.util.Date value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

isCreateTagFile

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

setCreateTagFile

@Nonnull
public Publication setCreateTagFile(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getCurrentNote

@CheckReturnValue
 @Nullable
public PublicationNote getCurrentNote(java.lang.String... args)

findCurrentNote

@CheckReturnValue
 @Nonnull
public final PublicationNote findCurrentNote(java.lang.String... args)
                                                                  throws NotFoundException

The last note entered.

--> PublicationNote (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

PublicationNote

Throws:

NotFoundException - PublicationNote was not found

getDescription

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

setDescription

@Nonnull
public Publication setDescription(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isExternal

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

setExternal

@Nonnull
public Publication setExternal(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getHeadline

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

setHeadline

@Nonnull
public Publication setHeadline(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isInactiveFg

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

setInactiveFg

@Nonnull
public Publication setInactiveFg(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isInternal

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

setInternal

@Nonnull
public Publication setInternal(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getLastRunTime

@CheckReturnValue
 @Nullable
public java.util.Date getLastRunTime(java.lang.String... args)

getManNextRunTime

@CheckReturnValue
 @Nullable
public java.util.Date getManNextRunTime(java.lang.String... args)

setManNextRunTime

@Nonnull
public Publication setManNextRunTime(java.util.Date value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getNextRunTime

@CheckReturnValue
 @Nullable
public java.util.Date getNextRunTime(java.lang.String... args)

getOutputFileName

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

setOutputFileName

@Nonnull
public Publication setOutputFileName(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getProcessingStatus

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

setProcessingStatus

@Nonnull
public Publication setProcessingStatus(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getRegion

@CheckReturnValue
 @Nullable
public Country getRegion(java.lang.String... args)

findRegion

@CheckReturnValue
 @Nonnull
public final Country findRegion(java.lang.String... args)
                                                     throws NotFoundException

The Region.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setRegion

@Nonnull
public Publication setRegion(com.aspc.dal.dbobj.misc.Country value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isReview

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

setReview

@Nonnull
public Publication setReview(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

create

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