Package com.storedobject.core

Class FileFolder

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.FileFolder

All Implemented Interfaces:

Displayable, StringFiller, Detail, HasChildren, HasId

public final class FileFolder
extends StoredObject
implements Detail, HasChildren

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
FileFolder()

Method Summary

Modifier and Type	Method	Description
void	circulate(Transaction transaction, boolean recursive)
static void	columns(Columns columns)
static FileFolder	createFolders(Transaction transaction, String path)
static FileFolder	get(String path)
static FileFolder	get(String path, FileFolder parent)
List<DocumentConfiguration>	getConfiguration()
String	getLogic()
String	getName()
FileFolder	getParentFolder()
static FileFolder	getRoot()
FileFolder	getRootFolder()
Id	getUniqueId()	Get the Id of the class instance that makes this instance unique.
static void	indices(Indices indices)
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Check if the given class is a "master" for this class.
boolean	isRoot()
static String[]	links()
ObjectIterator<FileData>	listFiles()
ObjectIterator<FileData>	listFiles(String condition)
ObjectIterator<FileData>	listFiles(String condition, String orderBy)
ObjectIterator<FileFolder>	listFolders()
ObjectIterator<FileFolder>	listFolders(String condition)
ObjectIterator<FileFolder>	listFolders(String condition, String orderBy)
boolean	matches(FileData file)
void	resetCache()
static String[]	searchColumns()
void	setLogic(String logic)
void	setName(String name)
String	toDisplay()	Display representation of the instance used for human-friendly display.
String	toString()	String representation of the instance.
void	validateChildAttach(StoredObject child, int linkType)	Do validation when a child is attached.
void	validateChildDetach(StoredObject child, int linkType)	Do validation when a child is detached.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.storedobject.core.Detail

copyValuesFrom, getId, getUniqueValue

Constructor Details

FileFolder

public FileFolder()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

searchColumns

public static String[] searchColumns()

links

public static String[] links()

setName

public void setName(String name)

getName

@Column(order=1)
public String getName()

setLogic

public void setLogic(String logic)

getLogic

@Column(order=2,
        required=false)
public String getLogic()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getUniqueId

public Id getUniqueId()

Description copied from interface: Detail

Get the Id of the class instance that makes this instance unique. (By default, generally, the Id of this instance is returned).

Specified by:

getUniqueId in interface Detail

Returns:

Id of the class instance that makes this instance unique.

isDetailOf

public boolean isDetailOf(Class<? extends StoredObject> masterClass)

Description copied from interface: Detail

Check if the given class is a "master" for this class. (Must return a consistent value).

Specified by:

isDetailOf in interface Detail

Parameters:

masterClass - Class to check.

Returns:

True if it is a "master" to this detail class. Otherwise, false.

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

toDisplay

public String toDisplay()

Description copied from class: StoredObject

Display representation of the instance used for human-friendly display.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

Display representation of the instance.

createFolders

public static FileFolder createFolders(Transaction transaction,
 String path)
                                throws Exception

Throws:

Exception

get

public static FileFolder get(String path)

get

public static FileFolder get(String path,
 FileFolder parent)

getParentFolder

public FileFolder getParentFolder()

getRootFolder

public FileFolder getRootFolder()

getConfiguration

public List<DocumentConfiguration> getConfiguration()

resetCache

public void resetCache()

matches

public boolean matches(FileData file)

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

validateChildDetach

public void validateChildDetach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is detached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildDetach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

validateChildAttach

public void validateChildAttach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is attached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildAttach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

circulate

public void circulate(Transaction transaction,
 boolean recursive)
               throws Exception

Throws:

Exception

listFolders

public ObjectIterator<FileFolder> listFolders()

listFolders

public ObjectIterator<FileFolder> listFolders(String condition)

listFolders

public ObjectIterator<FileFolder> listFolders(String condition,
 String orderBy)

listFiles

public ObjectIterator<FileData> listFiles()

listFiles

public ObjectIterator<FileData> listFiles(String condition)

listFiles

public ObjectIterator<FileData> listFiles(String condition,
 String orderBy)

isRoot

public boolean isRoot()

getRoot

public static FileFolder getRoot()