Package com.storedobject.core

Class MediaFile

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Name

com.storedobject.core.MediaFile

All Implemented Interfaces:

Displayable, HasName, StringFiller, ContentType, HasId, HasStreamData

public final class MediaFile
extends Name
implements ContentType, HasStreamData

Field Summary

Fields inherited from class com.storedobject.core.Name

name

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
MediaFile()

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
static void	columns(Columns columns)
static String[]	displayColumns()
static MediaFile	get(String name)
String	getContentType()
StreamData	getFile()
Id	getFileId()
String	getFileName()	Determines the file name based on the name provided by the implementing entity and the file extension associated with its StreamData.
String	getMimeType()
StreamData	getStreamData()	Retrieves an instance of StreamData.
long	getTimeKey()
String	getUniqueCondition()	Gets the unique index condition of this object.
static void	indices(Indices indices)
boolean	isAudio()
boolean	isImage()
boolean	isPDF()
boolean	isVideo()
static ObjectIterator<MediaFile>	list(String name)
static MediaFile	noImage()
static String[]	protectedColumns()
void	setFile(Id fileId)
void	setFile(StreamData file)
void	setFile(BigDecimal idValue)
void	setTimeKey(long timeKey)
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.Name

getName, setName, toString

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, getActor, 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, 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, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, 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.ContentType

getLink, isHTML, isLink, isMedia, isText

Methods inherited from interface com.storedobject.core.HasStreamData

getName

Constructor Details

MediaFile

public MediaFile()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class Name

Returns:

Unique index condition.

displayColumns

public static String[] displayColumns()

browseColumns

public static String[] browseColumns()

protectedColumns

public static String[] protectedColumns()

setFile

public void setFile(Id fileId)

setFile

public void setFile(BigDecimal idValue)

setFile

public void setFile(StreamData file)

getFileId

@Column(order=200)
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.

getTimeKey

@SetNotAllowed
public long getTimeKey()

setTimeKey

public void setTimeKey(long timeKey)

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 Name

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getContentType

public String getContentType()

Specified by:

getContentType in interface ContentType

Specified by:

getContentType in interface HasStreamData

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface ContentType

getFileName

public String getFileName()

Description copied from interface: HasStreamData

Determines the file name based on the name provided by the implementing entity and the file extension associated with its StreamData. If no name is available, a unique name is generated using UniqueLong.get() combined with the file extension.

Specified by:

getFileName in interface HasStreamData

Returns:

the generated or determined file name as a String. If the name is available and already ends with the correct file extension, it is returned as is; otherwise, the correct extension is appended to the name. If no name is available, a unique file name with the correct extension is returned.

isImage

public boolean isImage()

Specified by:

isImage in interface ContentType

isAudio

public boolean isAudio()

Specified by:

isAudio in interface ContentType

isVideo

public boolean isVideo()

Specified by:

isVideo in interface ContentType

isPDF

public boolean isPDF()

Specified by:

isPDF in interface ContentType

get

public static MediaFile get(String name)

list

public static ObjectIterator<MediaFile> list(String name)

noImage

public static MediaFile noImage()