de.espirit.firstspirit.access.store.mediastore

Interface File

All Superinterfaces:

Comparable<StoreElement>, MediaElement, StoreElement, Workflowable

public interface File
extends MediaElement

This interface provides methods to handle a media object of type FILE from the MediaStore

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
long	getCrc() Get the crc of the file or -1 if crc isn't set
String	getDescription() Get the description of the current media
String	getEncoding() Get the encoding of the current file-media
String	getExtension() Get the extension
Revision	getFileRevision() Return file content revision or null if no content exits.
InputStream	getInputStream() Returns the file content as inputstream.
Language	getLanguage() Get the language of the current file-media
MimeType	getMimeType() Get the mime-type.
TemplateDocument	getParsedFile() Returns the parsed file content, if Media.getParseFile() == true, else null.
byte[]	getPreviewImage() Get a small preview/thumbnail image of this picture
long	getSize() Get the size of the file or -1 if size isn't set
void	setDescription(String description) Set the description of the current media
void	setEncoding(String encoding) Set the encoding of the current file-media
void	setExtension(String extension) Set the Extension
void	setFile(long length, InputStream file, String extension)
void	setPreviewImage(byte[] bytes) Set a the image data source to create a preview-thumbnail from.

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getParent, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLanguage

Language getLanguage()

Get the language of the current file-media

Returns:

language of the file-media as object

Since:

3.0

getInputStream

InputStream getInputStream()
                           throws IOException

Returns the file content as inputstream.

Throws:

IOException

Since:

4.0

setFile

void setFile(long length,
           InputStream file,
           String extension)
             throws IOException

Parameters:

length - in bytes

file - InputStream

extension - the filename extension

Throws:

IOException

Since:

4.1.10

getPreviewImage

@Nullable
byte[] getPreviewImage()
                       throws IOException

Get a small preview/thumbnail image of this picture

Returns:

preview the picture-media preview image or null

Throws:

IOException - if any error occurs while obtaining the preview image stream

Since:

5.0

setPreviewImage

void setPreviewImage(@Nullable
                   byte[] bytes)

Set a the image data source to create a preview-thumbnail from. This should be the original, non-scaled instance. The scaling is done one the server-side, automatically.

Parameters:

bytes - the preview image data or null to unset the preview image

Since:

5.0

getEncoding

String getEncoding()

Get the encoding of the current file-media

Returns:

encoding of the file-media e.g. "ISO-8859-1"

Since:

3.0

setEncoding

void setEncoding(String encoding)

Set the encoding of the current file-media

Parameters:

encoding - new encoding of the file-media e.g. "ISO-8859-1"

Since:

3.0

getDescription

String getDescription()

Get the description of the current media

Returns:

description of the media

Since:

3.0

setDescription

void setDescription(String description)

Set the description of the current media

Parameters:

description - new description of the media

Since:

3.0

getExtension

String getExtension()

Get the extension

Returns:

the extension

Since:

3.0

getMimeType

@Nullable
MimeType getMimeType()

Get the mime-type.

Returns:

the mime-type

Since:

5.0

setExtension

void setExtension(String extension)

Set the Extension

Parameters:

extension - the extension

Since:

3.0

getFileRevision

@Nullable
Revision getFileRevision()

Return file content revision or null if no content exits.

Returns:

the file revision

Since:

4.0

getSize

long getSize()

Get the size of the file or -1 if size isn't set

Returns:

the size in bytes

Since:

3.0

getCrc

long getCrc()

Get the crc of the file or -1 if crc isn't set

Returns:

the crc or -1 for unkonwn

Since:

4.0

getParsedFile

TemplateDocument getParsedFile()
                               throws ParsingError,
                                      IOException

Returns the parsed file content, if Media.getParseFile() == true, else null.

Returns:

the parsed file content or null

Throws:

ParsingError

IOException

Since:

4.0