com.aspc.file

Class DBFileTemplate

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.file.DBFileTemplate

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBFile, DBFileRemote

public abstract class DBFileTemplate
extends DBObject

The file template.

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

Since:

2 August 2013

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 GlobalId	DBCLASS_GID The file template
static java.lang.String	DBCLASS_NAME The file template
static java.lang.String	DBFILE_FMT_ORG Extension used for different formats of files
static java.lang.String	DBFILE_FMT_THUMB The thumb

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
DBFolder	findFolderId(java.lang.String... args) The folder that holds this file.
protected abstract java.lang.String	getCacheName(java.lang.String extension)
java.lang.String	getCachePeriod(java.lang.String... args)
DBFolder	getFolderId(java.lang.String... args)
double	getFullTextSearchScore(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMimeType(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
java.lang.String	getPrimaryType(java.lang.String... args)
java.util.List	getProperties(java.lang.String... args)
abstract java.io.File	getRawFile() The raw standard file.
java.io.File	getRawFile(java.lang.String fmt) Get the raw file in a particular format.
java.util.List<java.lang.String>	getReferencesUUID(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getTextContent(java.lang.String... args)
protected java.io.File	getThumbFile(java.lang.String fmt) The thumb tack file
java.lang.String	getURL(java.lang.String... args)
java.lang.String	getUUID(java.lang.String... args)
java.util.List<java.lang.String>	getWeakReferencesUUID(java.lang.String... args)
java.lang.String	getWebSafePath(java.lang.String... args)
boolean	isAudio() Is this file an audio file ?
boolean	isChildNode(java.lang.String... args)
boolean	isContains(java.lang.String... args)
boolean	isDescendantNode(java.lang.String... args)
boolean	isDirectory()
boolean	isImage() Is this file an image ?
boolean	isPublic(java.lang.String... args)
boolean	isReferenceable(java.lang.String... args)
boolean	isSameNode(java.lang.String... args)
boolean	isVersionable(java.lang.String... args)
DBFileTemplate	setCachePeriod(java.lang.String value, java.lang.String... args)
DBFileTemplate	setFolderId(com.aspc.dal.dbobj.folders.DBFolder value, java.lang.String... args)
DBFileTemplate	setID(int value, java.lang.String... args)
DBFileTemplate	setMimeType(java.lang.String value, java.lang.String... args)
DBFileTemplate	setName(java.lang.String value, java.lang.String... args)
DBFileTemplate	setPrimaryType(java.lang.String value, java.lang.String... args)
DBFileTemplate	setProperties(java.util.List value, java.lang.String... args)
DBFileTemplate	setReferenceable(boolean value, java.lang.String... args)
DBFileTemplate	setReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
DBFileTemplate	setSequence(int value, java.lang.String... args)
DBFileTemplate	setTextContent(java.lang.String value, java.lang.String... args)
DBFileTemplate	setUUID(java.lang.String value, java.lang.String... args)
DBFileTemplate	setVersionable(boolean value, java.lang.String... args)
DBFileTemplate	setWeakReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
java.lang.String	vDisplayName()
java.lang.String	vName()

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, 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 template

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The file template

DBFILE_FMT_ORG

public static final java.lang.String DBFILE_FMT_ORG

Extension used for different formats of files

See Also:

Constant Field Values

DBFILE_FMT_THUMB

public static final java.lang.String DBFILE_FMT_THUMB

The thumb

See Also:

Constant Field Values

Constructor Detail

DBFileTemplate

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

Method Detail

getID

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

setID

@Nonnull
public DBFileTemplate 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)

getUUID

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

setUUID

@Nonnull
public DBFileTemplate setUUID(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getCachePeriod

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

setCachePeriod

@Nonnull
public DBFileTemplate setCachePeriod(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isContains

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

getFolderId

@CheckReturnValue
 @Nullable
public DBFolder getFolderId(java.lang.String... args)

findFolderId

@CheckReturnValue
 @Nonnull
public final DBFolder findFolderId(java.lang.String... args)
                                                        throws NotFoundException

The folder that holds this file.

--> DBFolder (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Folder

Throws:

NotFoundException - DBFolder was not found

setFolderId

@Nonnull
public DBFileTemplate setFolderId(com.aspc.dal.dbobj.folders.DBFolder value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getFullTextSearchScore

@CheckReturnValue
public double getFullTextSearchScore(java.lang.String... args)

isChildNode

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

isDescendantNode

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

isSameNode

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

getMimeType

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

setMimeType

@Nonnull
public DBFileTemplate setMimeType(@MatchesPattern(value="[a-z\\-A-Z]+/[\\.a-z0-9_\\-A-Z\\+]+")
                                           java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public DBFileTemplate setName(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getPath

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

getPrimaryType

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

setPrimaryType

@Nonnull
public DBFileTemplate setPrimaryType(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getProperties

@CheckReturnValue
 @Nonnull
public java.util.List getProperties(java.lang.String... args)

setProperties

@Nonnull
public DBFileTemplate setProperties(java.util.List value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isPublic

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

isReferenceable

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

setReferenceable

@Nonnull
public DBFileTemplate setReferenceable(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getReferencesUUID

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getReferencesUUID(java.lang.String... args)

setReferencesUUID

@Nonnull
public DBFileTemplate setReferencesUUID(java.util.List<java.lang.String> value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

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

setSequence

@Nonnull
public DBFileTemplate setSequence(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getTextContent

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

setTextContent

@Nonnull
public DBFileTemplate setTextContent(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isVersionable

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

setVersionable

@Nonnull
public DBFileTemplate setVersionable(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getWeakReferencesUUID

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getWeakReferencesUUID(java.lang.String... args)

setWeakReferencesUUID

@Nonnull
public DBFileTemplate setWeakReferencesUUID(java.util.List<java.lang.String> value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getWebSafePath

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

isDirectory

@CheckReturnValue
public boolean isDirectory()

extGetDerivedValue

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

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

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

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

getRawFile

@Nullable
 @CheckReturnValue
public abstract java.io.File getRawFile()
                                                              throws java.lang.Exception

The raw standard file.

Returns:

The actual raw file

Throws:

java.lang.Exception - a serious error

getRawFile

@Nullable
 @CheckReturnValue
public java.io.File getRawFile(@Nonnull
                                                            java.lang.String fmt)
                                                     throws java.lang.Exception

Get the raw file in a particular format.

Parameters:

fmt - The format for the raw file

Returns:

The raw file.

Throws:

java.lang.Exception - A serious error.

isImage

@CheckReturnValue
public boolean isImage()

Is this file an image ?

Returns:

true if an image.

isAudio

@CheckReturnValue
public boolean isAudio()

Is this file an audio file ?

Returns:

true if an sound file.

getCacheName

@CheckReturnValue
 @Nonnull
protected abstract java.lang.String getCacheName(java.lang.String extension)

getThumbFile

@CheckReturnValue
 @Nonnull
protected java.io.File getThumbFile(@Nonnull
                                                                java.lang.String fmt)
                                                         throws java.lang.Exception

The thumb tack file

Parameters:

fmt - The format

Returns:

The problem

Throws:

java.lang.Exception - A serious problem

vName

@CheckReturnValue
 @Nonnull
public java.lang.String vName()

vDisplayName

@CheckReturnValue
 @Nonnull
public java.lang.String vDisplayName()