com.aspc.DBObj.Folders

Class DBFolder

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Folders.DBFolder

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBReportFolder, SmegDBFolder

public class DBFolder
extends DBObject

Is a database implementation of a standard file system folder/directory. Additional properties may be associated with a database folder like "description" and "public" These properties maybe used in conjuction with the ACLs to produce flexible access controls.

Notes

core

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

Since:

June 1, 2001, 11:51 AM

Author:

Jason McGrath

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 Is a database implementation of a standard file system folder/directory.
static java.lang.String	DBCLASS_NAME Is a database implementation of a standard file system folder/directory.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBFolder	create(MutableDataSource mds) Make a new instance of this class.
DBFolder	createFolder(java.lang.String name)
java.lang.String	displayName() The human display name of this object.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) When parent folder or folder name is changed update the duplicate check field.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreValidate() correct the unique folder issue.
protected void	extValidateDelete(ValidationList list) Extend this method to add validation to a record then deleted.
protected ValidationError	extValidateField(DBField field, ValidationList list) 1) You can't change the name of the root folder.
static DBFolder	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBFolder	findParentId(java.lang.String... args) Parent Id.
DBTriStateOption	findRawRecord(java.lang.String... args) TriState field to set the derived field 'recordFileOpenings'.
int	getCountFiles(java.lang.String... args)
int	getCountFolders(java.lang.String... args)
int	getCountItems(java.lang.String... args)
java.util.Date	getCreatedTime(java.lang.String... args)
java.lang.String	getDuplicationCheck(java.lang.String... args)
double	getFullTextSearchScore(java.lang.String... args)
int	getID(java.lang.String... args)
java.util.Date	getLastModifiedTS()
java.lang.String	getName() The folder's name
int	getOne(java.lang.String... args)
DBFolder	getParentId(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)
DBTriStateOption	getRawRecord(java.lang.String... args)
java.util.List<java.lang.String>	getReferencesUUID(java.lang.String... args)
int	getSequence(java.lang.String... args)
long	getTotalSize(java.lang.String... args)
double	getTotalSizeMB(java.lang.String... args)
java.lang.String	getUUID(java.lang.String... args)
java.util.List<java.lang.String>	getWeakReferencesUUID(java.lang.String... args)
boolean	hasCreateAccess(java.lang.String... args)
boolean	hasDeleteAccess(java.lang.String... args)
boolean	hasFullAccess(java.lang.String... args)
boolean	hasModifyAccess(java.lang.String... args)
boolean	hasReadAccess(java.lang.String... args)
boolean	isAllowDuplicates(java.lang.String... args)
boolean	isChildNode(java.lang.String... args)
boolean	isChildOf(java.lang.String... args)
boolean	isContains(java.lang.String... args)
boolean	isDescendantNode(java.lang.String... args)
boolean	isDirectory()
boolean	isFinalFg(java.lang.String... args)
boolean	isPublic(java.lang.String... args)
boolean	isRecordFileOpenings(java.lang.String... args)
boolean	isReferenceable(java.lang.String... args)
boolean	isSameNode(java.lang.String... args)
boolean	isVersionable(java.lang.String... args)
long	lastModified()
com.aspc.dal.file.DBNode[]	listNodes()
static DBQuery<DBFolder>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBFolder	setAllowDuplicates(boolean value, java.lang.String... args)
DBFolder	setCreatedTime(java.util.Date value, java.lang.String... args)
DBFolder	setDuplicationCheck(java.lang.String value, java.lang.String... args)
DBFolder	setFinalFg(boolean value, java.lang.String... args)
DBFolder	setID(int value, java.lang.String... args)
DBFolder	setName(java.lang.String value, java.lang.String... args)
DBFolder	setParentId(com.aspc.dal.dbobj.folders.DBFolder value, java.lang.String... args)
DBFolder	setPrimaryType(java.lang.String value, java.lang.String... args)
DBFolder	setProperties(java.util.List value, java.lang.String... args)
DBFolder	setRawRecord(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
DBFolder	setReferenceable(boolean value, java.lang.String... args)
DBFolder	setReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
DBFolder	setSequence(int value, java.lang.String... args)
DBFolder	setUUID(java.lang.String value, java.lang.String... args)
DBFolder	setVersionable(boolean value, java.lang.String... args)
DBFolder	setWeakReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
java.lang.String	toString() The display name
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, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, 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, 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

Is a database implementation of a standard file system folder/directory. Additional properties may be associated with a database folder like "description" and "public" These properties maybe used in conjuction with the ACLs to produce flexible access controls.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Is a database implementation of a standard file system folder/directory. Additional properties may be associated with a database folder like "description" and "public" These properties maybe used in conjuction with the ACLs to produce flexible access controls.

Constructor Detail

DBFolder

public DBFolder(DBClass def,
                DataSource dataSource)
         throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The data source 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 DBFolder setID(int value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getUUID

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

setUUID

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

Throws:

java.lang.Exception

isAllowDuplicates

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

setAllowDuplicates

@Nonnull
public DBFolder setAllowDuplicates(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isContains

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

getCountFiles

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

getCountFolders

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

getCountItems

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

getCreatedTime

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

setCreatedTime

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

Throws:

java.lang.Exception

getDuplicationCheck

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

setDuplicationCheck

@Nonnull
public DBFolder setDuplicationCheck(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isFinalFg

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

setFinalFg

@Nonnull
public DBFolder setFinalFg(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getFullTextSearchScore

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

hasCreateAccess

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

hasDeleteAccess

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

hasFullAccess

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

hasModifyAccess

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

hasReadAccess

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

isChildNode

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

isChildOf

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

isDescendantNode

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

isSameNode

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

setName

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

Throws:

java.lang.Exception

getOne

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

getParentId

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

findParentId

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

Parent Id.

--> DBFolder (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

sub folder

Throws:

NotFoundException - DBFolder was not found

setParentId

@Nonnull
public DBFolder setParentId(com.aspc.dal.dbobj.folders.DBFolder 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 DBFolder 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 DBFolder 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)

getRawRecord

@CheckReturnValue
 @Nullable
public DBTriStateOption getRawRecord(java.lang.String... args)

findRawRecord

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findRawRecord(java.lang.String... args)
                                                                 throws NotFoundException

TriState field to set the derived field 'recordFileOpenings'.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setRawRecord

@Nonnull
public DBFolder setRawRecord(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isRecordFileOpenings

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

isReferenceable

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

setReferenceable

@Nonnull
public DBFolder 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 DBFolder 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 DBFolder setSequence(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getTotalSize

@CheckReturnValue
public long getTotalSize(java.lang.String... args)

getTotalSizeMB

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

isVersionable

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

setVersionable

@Nonnull
public DBFolder 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 DBFolder setWeakReferencesUUID(java.util.List<java.lang.String> value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

create

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

createFolder

public DBFolder createFolder(java.lang.String name)
                      throws java.lang.Exception

Throws:

java.lang.Exception

listNodes

public com.aspc.dal.file.DBNode[] listNodes()
                                     throws java.lang.Exception

Throws:

java.lang.Exception

displayName

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

The human display name of this object.

Overrides:

displayName in class DBObject

Returns:

the display name

toString

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

The display name

Overrides:

toString in class DBObject

Returns:

The display name

extValidateDelete

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

Extend this method to add validation to a record then deleted.

Overrides:

extValidateDelete in class DBObject

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

extValidateField

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

1) You can't change the name of the root folder.

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to validate

list - The validation list

Returns:

The validation error.

Throws:

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

When parent folder or folder name is changed update the duplicate check field.

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

extPreValidate

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

correct the unique folder issue.

Overrides:

extPreValidate in class DBObject

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 derived value

Throws:

java.lang.Exception - A serious problem

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject. Remove duplicate permissions

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

getName

public java.lang.String getName()

The folder's name

Returns:

The name

getLastModifiedTS

public java.util.Date getLastModifiedTS()

lastModified

public long lastModified()

isDirectory

public boolean isDirectory()

vName

public java.lang.String vName()

vDisplayName

public java.lang.String vDisplayName()