de.innovationgate.webgate.api

Class WGFileDerivateMetaData

java.lang.Object

de.innovationgate.webgate.api.WGFileDerivateMetaData

All Implemented Interfaces:

WGExtensionDataContainer, WGFileAnnotations

public class WGFileDerivateMetaData
extends java.lang.Object
implements WGExtensionDataContainer, WGFileAnnotations

Data bean for file derivate meta informations. Also provides methods to directly modify extdata fields of the contents object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTDATA_ORIGINALREVISION
static java.lang.String	EXTDATA_USAGE

Fields inherited from interface de.innovationgate.webgate.api.WGFileAnnotations

USAGE_ICON, USAGE_POSTER

Constructor Summary

Constructors

Constructor and Description
WGFileDerivateMetaData(WGDatabase db, WGDocumentKey relatedDoc, java.lang.String id, java.lang.String creator, java.lang.String name, java.util.Date created, java.util.Date modified, long size, java.lang.String sha512Checksum, java.lang.String parentSha512Checksum)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreated() Returns the date of creation
java.lang.String	getCreator() Returns a hash identifying the derivate creator
java.util.List<java.lang.String>	getCustomFieldNames() Returns the names of custom fields annotated for this file
java.lang.Object	getCustomFieldValue(java.lang.String fieldName) Returns the value of a custom field annotated for this file
int	getDisplayHeight() Returns the display height in pixels for images or videos
int	getDisplayWidth() Returns the display width in pixels for images or videos
java.lang.Object	getExtensionData(java.lang.String strName) Returns the value of an extension data field.
java.util.List<java.lang.String>	getExtensionDataNames() Returns the names of all extension data fields on this entity
java.lang.String	getId() Returns the derivate id
java.util.Date	getLastModified() Returns the date of last modification
java.lang.String	getMimeType() Returns the mime type
java.lang.String	getName() Returns the name of this derivate
WGDatabaseRevision	getOriginalRevision() Returns the revision of the original file for which this derivate was created
WGDocument	getParentDocument() Returns the parent document to which the file, described by these file annotations, belong
java.lang.String	getParentSha512Checksum() Returns the checksum of the original files data for which this derivate was created
BinaryFieldData	getPlainText() returns a plain text representation of the file
java.lang.String	getSha512Checksum() Returns the SHA-512 checksum of this files data
long	getSize() Returns the size of this file in bytes
java.lang.String	getUsage() Returns the usage of a file derivate, using constants #USAGE_...
void	removeCustomField(java.lang.String fieldName) Removes a custom field annotated for this file
void	removeExtensionData(java.lang.String strName) Removes an extension data field from this entity
void	setCustomFieldValue(java.lang.String fieldName, java.lang.Object value) Sets the value of a custom field annotated for this file
void	setDisplayHeight(int displayHeight) Sets the display height in pixels for images or videos
void	setDisplayWidth(int displayWidth) Sets the display width in pixels for images or videos
void	setMimeType(java.lang.String mimeType) Sets the mime type
void	setOriginalRevision(WGDatabaseRevision rev) Sets the revision of the original file for which this derivate was created
void	setPlainText(BinaryFieldData data) sets the plain text representation of this file
void	setUsage(java.lang.String usage) Sets the usage of this derivate as constant WGFileAnnotations.USAGE_...
void	writeExtensionData(java.lang.String strName, java.lang.Object value) Sets the value of an extension data field.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTDATA_USAGE

public static final java.lang.String EXTDATA_USAGE

See Also:

Constant Field Values

EXTDATA_ORIGINALREVISION

public static final java.lang.String EXTDATA_ORIGINALREVISION

See Also:

Constant Field Values

Constructor Detail

WGFileDerivateMetaData

public WGFileDerivateMetaData(WGDatabase db,
                      WGDocumentKey relatedDoc,
                      java.lang.String id,
                      java.lang.String creator,
                      java.lang.String name,
                      java.util.Date created,
                      java.util.Date modified,
                      long size,
                      java.lang.String sha512Checksum,
                      java.lang.String parentSha512Checksum)

Method Detail

getSize

public long getSize()

Returns the size of this file in bytes

Specified by:

getSize in interface WGFileAnnotations

getSha512Checksum

public java.lang.String getSha512Checksum()

Returns the SHA-512 checksum of this files data

getExtensionData

public java.lang.Object getExtensionData(java.lang.String strName)

Description copied from interface: WGExtensionDataContainer

Returns the value of an extension data field.

Specified by:

getExtensionData in interface WGExtensionDataContainer

Parameters:

strName - Name of the requested field.

Returns:

Object

getExtensionDataNames

public java.util.List<java.lang.String> getExtensionDataNames()
                                                       throws WGAPIException

Description copied from interface: WGExtensionDataContainer

Returns the names of all extension data fields on this entity

Specified by:

getExtensionDataNames in interface WGExtensionDataContainer

Throws:

WGBackendException

WGAPIException

removeExtensionData

public void removeExtensionData(java.lang.String strName)

Description copied from interface: WGExtensionDataContainer

Removes an extension data field from this entity

Specified by:

removeExtensionData in interface WGExtensionDataContainer

Parameters:

strName - Name of the field to remove.

writeExtensionData

public void writeExtensionData(java.lang.String strName,
                      java.lang.Object value)

Description copied from interface: WGExtensionDataContainer

Sets the value of an extension data field.

Specified by:

writeExtensionData in interface WGExtensionDataContainer

Parameters:

strName - Name of the requested field.

value - The value of the field

getMimeType

public java.lang.String getMimeType()

Description copied from interface: WGFileAnnotations

Returns the mime type

Specified by:

getMimeType in interface WGFileAnnotations

setMimeType

public void setMimeType(java.lang.String mimeType)
                 throws WGAPIException

Description copied from interface: WGFileAnnotations

Sets the mime type

Specified by:

setMimeType in interface WGFileAnnotations

Throws:

WGAPIException

getDisplayHeight

public int getDisplayHeight()

Description copied from interface: WGFileAnnotations

Returns the display height in pixels for images or videos

Specified by:

getDisplayHeight in interface WGFileAnnotations

setDisplayHeight

public void setDisplayHeight(int displayHeight)
                      throws WGAPIException

Description copied from interface: WGFileAnnotations

Sets the display height in pixels for images or videos

Specified by:

setDisplayHeight in interface WGFileAnnotations

Throws:

WGAPIException

getDisplayWidth

public int getDisplayWidth()

Description copied from interface: WGFileAnnotations

Returns the display width in pixels for images or videos

Specified by:

getDisplayWidth in interface WGFileAnnotations

setDisplayWidth

public void setDisplayWidth(int displayWidth)
                     throws WGAPIException

Description copied from interface: WGFileAnnotations

Sets the display width in pixels for images or videos

Specified by:

setDisplayWidth in interface WGFileAnnotations

Throws:

WGAPIException

getUsage

public java.lang.String getUsage()
                          throws WGAPIException

Description copied from interface: WGFileAnnotations

Returns the usage of a file derivate, using constants #USAGE_... This is readonly and determined by the derivate creator.

Specified by:

getUsage in interface WGFileAnnotations

Throws:

WGAPIException

setUsage

public void setUsage(java.lang.String usage)
              throws WGAPIException

Sets the usage of this derivate as constant WGFileAnnotations.USAGE_...

Parameters:

usage - The usage

Throws:

WGAPIException

getCustomFieldNames

public java.util.List<java.lang.String> getCustomFieldNames()

Description copied from interface: WGFileAnnotations

Returns the names of custom fields annotated for this file

Specified by:

getCustomFieldNames in interface WGFileAnnotations

getCustomFieldValue

public java.lang.Object getCustomFieldValue(java.lang.String fieldName)

Description copied from interface: WGFileAnnotations

Returns the value of a custom field annotated for this file

Specified by:

getCustomFieldValue in interface WGFileAnnotations

Parameters:

fieldName - Name of the field

Returns:

Value of the field

setCustomFieldValue

public void setCustomFieldValue(java.lang.String fieldName,
                       java.lang.Object value)
                         throws WGAPIException

Description copied from interface: WGFileAnnotations

Sets the value of a custom field annotated for this file

Specified by:

setCustomFieldValue in interface WGFileAnnotations

Parameters:

fieldName - Name of the field

value - Value of the field

Throws:

WGAPIException

removeCustomField

public void removeCustomField(java.lang.String fieldName)
                       throws WGAPIException

Description copied from interface: WGFileAnnotations

Removes a custom field annotated for this file

Specified by:

removeCustomField in interface WGFileAnnotations

Parameters:

fieldName - Name of the field

Throws:

WGAPIException

getCreator

public java.lang.String getCreator()

Returns a hash identifying the derivate creator

getName

public java.lang.String getName()

Returns the name of this derivate

getId

public java.lang.String getId()

Returns the derivate id

getCreated

public java.util.Date getCreated()

Returns the date of creation

getLastModified

public java.util.Date getLastModified()

Returns the date of last modification

getParentSha512Checksum

public java.lang.String getParentSha512Checksum()

Returns the checksum of the original files data for which this derivate was created

getOriginalRevision

public WGDatabaseRevision getOriginalRevision()

Returns the revision of the original file for which this derivate was created

setOriginalRevision

public void setOriginalRevision(WGDatabaseRevision rev)

Sets the revision of the original file for which this derivate was created

getParentDocument

public WGDocument getParentDocument()
                             throws WGAPIException

Description copied from interface: WGFileAnnotations

Returns the parent document to which the file, described by these file annotations, belong

Specified by:

getParentDocument in interface WGFileAnnotations

Throws:

WGAPIException

getPlainText

public BinaryFieldData getPlainText()
                             throws WGAPIException

Description copied from interface: WGFileAnnotations

returns a plain text representation of the file

Specified by:

getPlainText in interface WGFileAnnotations

Throws:

WGAPIException

setPlainText

public void setPlainText(BinaryFieldData data)
                  throws WGAPIException

Description copied from interface: WGFileAnnotations

sets the plain text representation of this file

Specified by:

setPlainText in interface WGFileAnnotations

Parameters:

data - plain text data

Throws:

WGAPIException