Package com.storedobject.core

Class FileData

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.FileData

All Implemented Interfaces:

Displayable, StringFiller, ContentType, Detail, HasId, HasParents, HasStreamData

Direct Known Subclasses:

Document, MemoAttachment, VirtualFileData

public class FileData
extends StoredObject
implements Detail, HasParents, ContentType, HasStreamData

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
FileData()
FileData(FileData link)
FileData(String name)
FileData(String name, FileData link)

Method Summary

Modifier and Type	Method	Description
void	circulate(Transaction transaction)
static void	columns(Columns columns)
static FileData	create(String path, StreamData streamData, Transaction transaction)
static FileData	get(String path)
FileCirculation	getCirculation(Id personId)
FileCirculation	getCirculation(Person person)
String	getContentType()
String	getDetails()
ComputedDate	getExpiryDate()
StreamData	getFile()
String	getFileExtension()
Id	getFileId()
FileFolder	getFolder()
String	getName()	Retrieves the name associated with the implementing entity.
FileData	getPreviousVersion()
ComputedDate	getReadBefore()
ComputedMinute	getReadBeforeTime()
String	getReadStamp()
FileFolder	getRootFolder()
StreamData	getStreamData()	Retrieves an instance of StreamData.
static void	indices(Indices indices)
boolean	isAudio()
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Check if the given class is a "master" for this class.
boolean	isEmpty()
boolean	isImage()
boolean	isLink()
boolean	isPDF()
boolean	isVideo()
void	linkTo(Transaction transaction, StoredObject object, String attribute)
void	linkTo(Transaction transaction, String link)
void	replaceWith(Transaction transaction, FileData file)	Replace this version with another version.
FileData	restore(Transaction transaction)	Restore the previous version of this.
void	saveInFolder(Transaction transaction, String folderPath)
final void	setFile(Id fileId)
void	setFile(StreamData file)
void	setFile(BigDecimal idValue)
void	setName(String name)
String	toString()	String representation of the instance.
void	unlinkFrom(Transaction transaction, FileFolder folder)
void	validate()	The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions).
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateParentDetach(StoredObject parent, int linkType)	Do validation when this gets detached from a parent object.
static boolean	validName(String name)	Check the given name is a valida file name or not.
void	view(Device device)

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, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, 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.ContentType

getLink, getMimeType, isHTML, isMedia, isText

Methods inherited from interface com.storedobject.core.Detail

copyValuesFrom, getId, getUniqueId, getUniqueValue

Methods inherited from interface com.storedobject.core.HasStreamData

getFileName

Constructor Details

FileData

public FileData()

FileData

public FileData(String name)

FileData

public FileData(FileData link)

FileData

public FileData(String name,
 FileData link)

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

setName

public void setName(String name)

getName

@Column(caption="Name/Reference",
        order=1)
public String getName()

Description copied from interface: HasStreamData

Retrieves the name associated with the implementing entity.

Specified by:

getName in interface HasStreamData

Returns:

a String representing the name, or null if no name is available.

setFile

public final void setFile(Id fileId)

setFile

public void setFile(BigDecimal idValue)

setFile

public void setFile(StreamData file)

getFileId

@Column(order=2)
public Id getFileId()

getFile

public StreamData getFile()

getStreamData

public StreamData getStreamData()

Description copied from interface: HasStreamData

Retrieves an instance of StreamData.

Specified by:

getStreamData in interface HasStreamData

Returns:

a StreamData object, representing the stream data associated with the implementing entity.

isEmpty

public boolean isEmpty()

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.

validName

public static boolean validName(String name)

Check the given name is a valida file name or not.

Parameters:

name - Name to check.

Returns:

True/false.

restore

public FileData restore(Transaction transaction)
                 throws Exception

Restore the previous version of this.

Parameters:

transaction - Transaction.

Returns:

Previous version of this file.

Throws:

Exception - Raises if transaction fails or if no previous version exists..

getPreviousVersion

public FileData getPreviousVersion()

replaceWith

public void replaceWith(Transaction transaction,
 FileData file)
                 throws Exception

Replace this version with another version.

Parameters:

transaction - Transaction.

file - New version of the document.

Throws:

Exception - Raises if transaction fails.

unlinkFrom

public void unlinkFrom(Transaction transaction,
 FileFolder folder)
                throws Exception

Throws:

Exception

validateParentDetach

public void validateParentDetach(StoredObject parent,
 int linkType)
                          throws Exception

Description copied from class: StoredObject

Do validation when this gets detached from a parent object.

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

Overrides:

validateParentDetach in class StoredObject

Parameters:

parent - Parent to validate.

linkType - Link type.

Throws:

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

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/undeleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating the state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc. are used to check the specific states, but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate-methods is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

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

Overrides:

validate in class StoredObject

Throws:

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

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.

isLink

public boolean isLink()

Specified by:

isLink in interface ContentType

getContentType

public String getContentType()

Specified by:

getContentType in interface ContentType

Specified by:

getContentType in interface HasStreamData

getFileExtension

public String getFileExtension()

isImage

public boolean isImage()

Specified by:

isImage in interface ContentType

isVideo

public boolean isVideo()

Specified by:

isVideo in interface ContentType

isAudio

public boolean isAudio()

Specified by:

isAudio in interface ContentType

isPDF

public boolean isPDF()

Specified by:

isPDF in interface ContentType

saveInFolder

public void saveInFolder(Transaction transaction,
 String folderPath)
                  throws Exception

Throws:

Exception

get

public static FileData get(String path)

create

public static FileData create(String path,
 StreamData streamData,
 Transaction transaction)
                       throws Exception

Throws:

Exception

circulate

public void circulate(Transaction transaction)
               throws Exception

Throws:

Exception

getFolder

public FileFolder getFolder()

getRootFolder

public FileFolder getRootFolder()

getCirculation

public FileCirculation getCirculation(Person person)

getCirculation

public FileCirculation getCirculation(Id personId)

getReadStamp

public String getReadStamp()

getExpiryDate

public ComputedDate getExpiryDate()

getReadBefore

public ComputedDate getReadBefore()

getReadBeforeTime

public ComputedMinute getReadBeforeTime()

getDetails

public String getDetails()

view

public void view(Device device)

linkTo

public void linkTo(Transaction transaction,
 StoredObject object,
 String attribute)
            throws Exception

Throws:

Exception

linkTo

public void linkTo(Transaction transaction,
 String link)
            throws Exception

Throws:

Exception