com.aspc.file

Class DBFileLocation

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.file.DBFileLocation

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFileLocation
extends DBObject

The physical location of a version of a file.
There can be a number DBFileLocations for each DBFile.

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

Since:

24 Mar 2005

Author:

Nigel Leck

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	CONST_STATUS_RENAME_LOGIC_DONE A public const variable to indicate the execution status of a particular code segment
static java.lang.String	CONST_STATUS_RESET A public const variable to indicate the execution status of a particular code segment
static GlobalId	DBCLASS_GID The physical location of a version of a file.
static java.lang.String	DBCLASS_NAME The physical location of a version of a file.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addDocsDir(java.lang.String url) append docs dir to url
static DBFileLocation	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extFixUp() The extended fix up routine
protected void	extPreSaveRecord() Additional functionality WHILE saving this record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
DBFile	findFile(java.lang.String... args) The file that is stored at this location.
static DBFileLocation	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBFileStoreVolume	findVolume(java.lang.String... args) The volume that the file is stored on.
DBFile	getFile(java.lang.String... args)
java.lang.String	getID(java.lang.String... args)
java.lang.String	getImportPath(java.lang.String... args)
java.lang.String	getImportURL(java.lang.String... args)
static java.lang.String	getRenameLogicExecutionStatus() Provide a public read only property for selftest to verify whether a particular code segment was executed.
DBFileStore	getStore() Retrieves the file store the the associated volume is located on
java.lang.String	getURLs(boolean requireAdminURL, boolean haMode) Get this list of URLs that file exists on
java.lang.String	getVersion(java.lang.String... args)
DBFileStoreVolume	getVolume(java.lang.String... args)
static DBQuery<DBFileLocation>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBFileLocation	setFile(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBFileLocation	setID(java.lang.String value, java.lang.String... args)
DBFileLocation	setImportPath(java.lang.String value, java.lang.String... args)
DBFileLocation	setImportURL(java.lang.String value, java.lang.String... args)
DBFileLocation	setVersion(java.lang.String value, java.lang.String... args)
DBFileLocation	setVolume(com.aspc.dal.file.DBFileStoreVolume 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, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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 physical location of a version of a file.
There can be a number DBFileLocations for each DBFile.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The physical location of a version of a file.
There can be a number DBFileLocations for each DBFile.

CONST_STATUS_RESET

public static final java.lang.String CONST_STATUS_RESET

A public const variable to indicate the execution status of a particular code segment

See Also:

Constant Field Values

CONST_STATUS_RENAME_LOGIC_DONE

public static final java.lang.String CONST_STATUS_RENAME_LOGIC_DONE

A public const variable to indicate the execution status of a particular code segment

See Also:

Constant Field Values

Constructor Detail

DBFileLocation

public DBFileLocation(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
 @Nonnull
public java.lang.String getID(java.lang.String... args)

setID

@Nonnull
public DBFileLocation setID(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 that is stored at this location.

--> DBFile (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setFile

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

Throws:

java.lang.Exception

getImportPath

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

setImportPath

@Nonnull
public DBFileLocation setImportPath(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getImportURL

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

setImportURL

@Nonnull
public DBFileLocation setImportURL(@MatchesPattern(value="[a-z]{3,5}://[\\-\\w\\*@\\./:\\\\~=]+(,[a-z]{3,5}://[\\w\\*@\\./:\\\\~=]+)*,*")
                                            java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getVersion

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

setVersion

@Nonnull
public DBFileLocation setVersion(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getVolume

@CheckReturnValue
 @Nullable
public DBFileStoreVolume getVolume(java.lang.String... args)

findVolume

@CheckReturnValue
 @Nonnull
public final DBFileStoreVolume findVolume(java.lang.String... args)
                                                               throws NotFoundException

The volume that the file is stored on.

--> DBFileStoreVolume (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBFileStoreVolume

Throws:

NotFoundException - DBFileStoreVolume was not found

setVolume

@Nonnull
public DBFileLocation setVolume(com.aspc.dal.file.DBFileStoreVolume value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBFileLocation 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<DBFileLocation> 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 DBFileLocation findKey(@Nonnull
                                                                 DataSource ds,
                                                                 @Nonnull
                                                                 java.lang.String 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

getStore

@CheckReturnValue
 @Nullable
public DBFileStore getStore()

Retrieves the file store the the associated volume is located on

Returns:

the associated DBFileStore

eventFieldUpdated

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

Additional business logic when a field is updated.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - A serious problem

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

getURLs

public java.lang.String getURLs(boolean requireAdminURL,
                                boolean haMode)
                         throws java.lang.Exception

Get this list of URLs that file exists on

Parameters:

requireAdminURL - Require the admin URL

haMode - Returns multiple URLs if required for HA (high availability)

Returns:

The list of URLs

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

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

Additional functionality WHILE saving this record to the database.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A serious problem

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - the field

Throws:

DBAccessException - No access to modify

extPreValidate

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

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extFixUp

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

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

addDocsDir

public static java.lang.String addDocsDir(java.lang.String url)

append docs dir to url

Parameters:

url - url

Returns:

url with docs dir appended

getRenameLogicExecutionStatus

@CheckReturnValue
public static java.lang.String getRenameLogicExecutionStatus()

Provide a public read only property for selftest to verify whether a particular code segment was executed.

Returns:

ThreadLocal a flag to indicate whether the rename logic code was executed or not.