com.aspc.publication

Class EditionFile

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.publication.EditionFile

All Implemented Interfaces:

SecondaryCacheGroup

public class EditionFile
extends DBObject

the file is for publication edition which is running on a "DROID".

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 file is for publication edition which is running on a "DROID"
static java.lang.String	DBCLASS_NAME the file is for publication edition which is running on a "DROID"

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static EditionFile	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
DBFile	findFile(java.lang.String... args) Link to DBFile object, the edition file.
EditionFileFormat	findFormat(java.lang.String... args) The format of this file.
EditionFileStatus	findFormatStatus(java.lang.String... args) The status of this edition file.
DBFile	findFormattedFile(java.lang.String... args) Formatted file.
static EditionFile	findKey(DataSource ds, int key) Find the target for this class by the primary key
Edition	getEdition() get the edition
DBFile	getFile(java.lang.String... args)
EditionFileFormat	getFormat(java.lang.String... args)
java.lang.String	getFormatMsg(java.lang.String... args)
EditionFileStatus	getFormatStatus(java.lang.String... args)
DBFile	getFormattedFile(java.lang.String... args)
int	getID(java.lang.String... args)
static DBQuery<EditionFile>	makeQuery(DataSource ds) Make a new QUERY for this class.
EditionFile	setEdition(com.aspc.dal.publication.Edition value, java.lang.String... args)
EditionFile	setFile(com.aspc.dal.file.DBFile value, java.lang.String... args)
EditionFile	setFormat(com.aspc.dal.publication.EditionFileFormat value, java.lang.String... args)
EditionFile	setFormatMsg(java.lang.String value, java.lang.String... args)
EditionFile	setFormatStatus(com.aspc.dal.publication.EditionFileStatus value, java.lang.String... args)
EditionFile	setID(int 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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, 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 file is for publication edition which is running on a "DROID"

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

the file is for publication edition which is running on a "DROID"

Constructor Detail

EditionFile

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

Throws:

java.lang.Exception

setEdition

@Nonnull
public EditionFile setEdition(com.aspc.dal.publication.Edition 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

Link to DBFile object, the edition file.

--> DBFile (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setFile

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

Throws:

java.lang.Exception

getFormat

@CheckReturnValue
 @Nullable
public EditionFileFormat getFormat(java.lang.String... args)

findFormat

@CheckReturnValue
 @Nonnull
public final EditionFileFormat findFormat(java.lang.String... args)
                                                               throws NotFoundException

The format of this file.

--> EditionFileFormat (String, Searchable)

Parameters:

args - the optional arguments

Returns:

EditionFileFormat

Throws:

NotFoundException - EditionFileFormat was not found

setFormat

@Nonnull
public EditionFile setFormat(com.aspc.dal.publication.EditionFileFormat value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getFormatMsg

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

setFormatMsg

@Nonnull
public EditionFile setFormatMsg(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getFormatStatus

@CheckReturnValue
 @Nullable
public EditionFileStatus getFormatStatus(java.lang.String... args)

findFormatStatus

@CheckReturnValue
 @Nonnull
public final EditionFileStatus findFormatStatus(java.lang.String... args)
                                                                     throws NotFoundException

The status of this edition file.

--> EditionFileStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

EditionFileStatus

Throws:

NotFoundException - EditionFileStatus was not found

setFormatStatus

@Nonnull
public EditionFile setFormatStatus(com.aspc.dal.publication.EditionFileStatus value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getFormattedFile

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

findFormattedFile

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

Formatted file.

--> DBFile (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

create

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

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The field parameters

Throws:

java.lang.Exception - a serious problem

extGetDerivedValue

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

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

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

Returns:

the value

Throws:

java.lang.Exception - A serious problem

getEdition

public Edition getEdition()

get the edition

Returns:

the edition