de.innovationgate.webgate.api

Class WGFileMetaData

java.lang.Object

de.innovationgate.webgate.api.WGFileMetaData

All Implemented Interfaces:

MetaInfoProvider, WGExtensionDataContainer, WGFileAnnotations

public class WGFileMetaData
extends java.lang.Object
implements WGExtensionDataContainer, WGFileAnnotations, MetaInfoProvider

Data bean for file meta informations, available since content store version 4.1. All data in regular fields is immutable. Only cached extension data fields on field _extData are mutable and stored back.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WGFileMetaData.ManualDerivate A file derivate that was created manually

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTDATA_COPYRIGHT
static java.lang.String	EXTDATA_CUSTOM_FIELD_PREFIX
static java.lang.String	EXTDATA_DESCRIPTION
static java.lang.String	EXTDATA_DISPLAY_HEIGHT
static java.lang.String	EXTDATA_DISPLAY_WIDTH
static java.lang.String	EXTDATA_MANUAL_DERIVATE_DATA_PREFIX
static java.lang.String	EXTDATA_MANUAL_DERIVATE_DEFINITION_PREFIX
static java.lang.String	EXTDATA_MIMETYPE
static java.lang.String	EXTDATA_PLAINTEXT
static java.lang.String	EXTDATA_TITLE
static java.lang.String	EXTDATA_UPDATE_REVISION
static java.lang.String	META_COPYRIGHT
static java.lang.String	META_CREATED
static java.lang.String	META_DESCRIPTION
static java.lang.String	META_LASTMODIFIED
static java.lang.String	META_MD5CHECKSUM
static java.lang.String	META_MIMETYPE
static java.lang.String	META_NAME
static java.lang.String	META_SHA512CHECKSUM
static java.lang.String	META_SIZE
static java.lang.String	META_TITLE
static MetaInfo	METAINFO_COPYRIGHT
static MetaInfo	METAINFO_CREATED
static MetaInfo	METAINFO_DESCRIPTION
static MetaInfo	METAINFO_LASTMODIFIED
static MetaInfo	METAINFO_MD5CHECKSUM
static MetaInfo	METAINFO_MIMETYPE
static MetaInfo	METAINFO_NAME
static MetaInfo	METAINFO_SHA512CHECKSUM
static MetaInfo	METAINFO_SIZE
static MetaInfo	METAINFO_TITLE

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

USAGE_ICON, USAGE_POSTER

Constructor Summary

Constructors

Constructor and Description
WGFileMetaData(WGFileMetaDataContext context, java.lang.String name, long size, java.util.Date created, java.util.Date lastModified, java.lang.String md5Checksum, java.lang.String sha512Checksum, java.util.Map<java.lang.String,java.lang.Object> extData)

Method Summary

Methods

Modifier and Type	Method and Description
WGFileMetaData	createClone() Creates an identical clone of this metadata object
WGFileMetaDataContext	getContext() Returns the file metadata context
java.lang.String	getCopyright() Returns the copyright of this image
java.util.Date	getCreated() returns the date the file was attached on the document
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
java.lang.String	getDescription() Returns the description of this image
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.util.Date	getLastmodified() returns the date the file was last modified for e.g. renamed
WGFileMetaData.ManualDerivate	getManualDerivate(java.lang.String name) Retrieves a manual derivate defined for this file
java.util.List<java.lang.String>	getManualDerivateNames() Returns the names of all manual derivates registered for this file
java.lang.String	getMd5Checksum() returns an md5 checksum of the file binary data
java.lang.Object	getMetaData(java.lang.String name) Returns a file metadata value by its field name
java.lang.String	getMimeType() Returns the mime type
java.lang.String	getName() returns the name of the file
WGDocument	getParentDocument() Returns the parent document to which the file, described by these file annotations, belong
BinaryFieldData	getPlainText() returns a plain text representation of the file
java.lang.String	getSha512Checksum() returns an SHA-512 checksum of the file binary data, available only since content store version 5 patch level 4
long	getSize() returns the file size in bytes
java.lang.String	getTitle() Returns the title of this file
WGDatabaseRevision	getUpdateRevision() Returns the revision when the contents of this file was updated the last time
java.lang.String	getUsage() Returns the usage of a file derivate, using constants #USAGE_...
void	pushData(WGFileMetaData clone) Pushes all data from this file metadata object to the parameter object
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	removeManualDerivate(java.lang.String name) Removes a manual derivate
void	setContext(WGFileMetaDataContext parent) Sets the file metadata context
void	setCopyright(java.lang.String copyright) Sets the copyright for this image
void	setCustomFieldValue(java.lang.String fieldName, java.lang.Object value) Sets the value of a custom field annotated for this file
void	setDescription(java.lang.String desc) Sets the description of this image
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	setManualDerivate(java.lang.String name, java.lang.String usage, java.io.InputStream data) Defines a manual derivate for this file
void	setMimeType(java.lang.String mimeType) Sets the mime type
void	setPlainText(BinaryFieldData plaintext) sets the plain text representation of this file
void	setTitle(java.lang.String title) Sets the title of this file
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_MIMETYPE

public static final java.lang.String EXTDATA_MIMETYPE

See Also:

Constant Field Values

EXTDATA_DISPLAY_WIDTH

public static final java.lang.String EXTDATA_DISPLAY_WIDTH

See Also:

Constant Field Values

EXTDATA_DISPLAY_HEIGHT

public static final java.lang.String EXTDATA_DISPLAY_HEIGHT

See Also:

Constant Field Values

EXTDATA_TITLE

public static final java.lang.String EXTDATA_TITLE

See Also:

Constant Field Values

EXTDATA_DESCRIPTION

public static final java.lang.String EXTDATA_DESCRIPTION

See Also:

Constant Field Values

EXTDATA_COPYRIGHT

public static final java.lang.String EXTDATA_COPYRIGHT

See Also:

Constant Field Values

EXTDATA_CUSTOM_FIELD_PREFIX

public static final java.lang.String EXTDATA_CUSTOM_FIELD_PREFIX

See Also:

Constant Field Values

EXTDATA_MANUAL_DERIVATE_DEFINITION_PREFIX

public static final java.lang.String EXTDATA_MANUAL_DERIVATE_DEFINITION_PREFIX

See Also:

Constant Field Values

EXTDATA_MANUAL_DERIVATE_DATA_PREFIX

public static final java.lang.String EXTDATA_MANUAL_DERIVATE_DATA_PREFIX

See Also:

Constant Field Values

EXTDATA_UPDATE_REVISION

public static final java.lang.String EXTDATA_UPDATE_REVISION

See Also:

Constant Field Values

EXTDATA_PLAINTEXT

public static final java.lang.String EXTDATA_PLAINTEXT

See Also:

Constant Field Values

META_NAME

public static final java.lang.String META_NAME

See Also:

Constant Field Values

METAINFO_NAME

public static final MetaInfo METAINFO_NAME

META_TITLE

public static final java.lang.String META_TITLE

See Also:

Constant Field Values

METAINFO_TITLE

public static final MetaInfo METAINFO_TITLE

META_DESCRIPTION

public static final java.lang.String META_DESCRIPTION

See Also:

Constant Field Values

METAINFO_DESCRIPTION

public static final MetaInfo METAINFO_DESCRIPTION

META_COPYRIGHT

public static final java.lang.String META_COPYRIGHT

See Also:

Constant Field Values

METAINFO_COPYRIGHT

public static final MetaInfo METAINFO_COPYRIGHT

META_CREATED

public static final java.lang.String META_CREATED

See Also:

Constant Field Values

METAINFO_CREATED

public static final MetaInfo METAINFO_CREATED

META_LASTMODIFIED

public static final java.lang.String META_LASTMODIFIED

See Also:

Constant Field Values

METAINFO_LASTMODIFIED

public static final MetaInfo METAINFO_LASTMODIFIED

META_SIZE

public static final java.lang.String META_SIZE

See Also:

Constant Field Values

METAINFO_SIZE

public static final MetaInfo METAINFO_SIZE

META_MD5CHECKSUM

public static final java.lang.String META_MD5CHECKSUM

See Also:

Constant Field Values

METAINFO_MD5CHECKSUM

public static final MetaInfo METAINFO_MD5CHECKSUM

META_SHA512CHECKSUM

public static final java.lang.String META_SHA512CHECKSUM

See Also:

Constant Field Values

METAINFO_SHA512CHECKSUM

public static final MetaInfo METAINFO_SHA512CHECKSUM

META_MIMETYPE

public static final java.lang.String META_MIMETYPE

See Also:

Constant Field Values

METAINFO_MIMETYPE

public static final MetaInfo METAINFO_MIMETYPE

Constructor Detail

WGFileMetaData

public WGFileMetaData(WGFileMetaDataContext context,
              java.lang.String name,
              long size,
              java.util.Date created,
              java.util.Date lastModified,
              java.lang.String md5Checksum,
              java.lang.String sha512Checksum,
              java.util.Map<java.lang.String,java.lang.Object> extData)

Method Detail

getName

public java.lang.String getName()

returns the name of the file

getSize

public long getSize()

returns the file size in bytes

Specified by:

getSize in interface WGFileAnnotations

getCreated

public java.util.Date getCreated()

returns the date the file was attached on the document

getLastmodified

public java.util.Date getLastmodified()

returns the date the file was last modified for e.g. renamed

getMd5Checksum

public java.lang.String getMd5Checksum()

returns an md5 checksum of the file binary data

getSha512Checksum

public java.lang.String getSha512Checksum()

returns an SHA-512 checksum of the file binary data, available only since content store version 5 patch level 4

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)
                         throws WGAPIException

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.

Throws:

WGAPIException

writeExtensionData

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

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

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

getContext

public WGFileMetaDataContext getContext()

Returns the file metadata context

setContext

public void setContext(WGFileMetaDataContext parent)

Sets the file metadata context

Parameters:

parent - The context

createClone

public WGFileMetaData createClone()
                           throws WGAPIException

Creates an identical clone of this metadata object

Throws:

WGAPIException

pushData

public void pushData(WGFileMetaData clone)
              throws WGAPIException

Pushes all data from this file metadata object to the parameter object

Parameters:

clone - The target object

Throws:

WGAPIException

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

getTitle

public java.lang.String getTitle()

Returns the title of this file

setTitle

public void setTitle(java.lang.String title)
              throws WGAPIException

Sets the title of this file

Parameters:

title - The title

Throws:

WGAPIException

getDescription

public java.lang.String getDescription()

Returns the description of this image

setDescription

public void setDescription(java.lang.String desc)
                    throws WGAPIException

Sets the description of this image

Parameters:

desc - The description

Throws:

WGAPIException

getCopyright

public java.lang.String getCopyright()

Returns the copyright of this image

setCopyright

public void setCopyright(java.lang.String copyright)
                  throws WGAPIException

Sets the copyright for this image

Parameters:

copyright - The copyright

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

getUpdateRevision

public WGDatabaseRevision getUpdateRevision()
                                     throws WGAPIException

Returns the revision when the contents of this file was updated the last time

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 plaintext)
                  throws WGAPIException

Description copied from interface: WGFileAnnotations

sets the plain text representation of this file

Specified by:

setPlainText in interface WGFileAnnotations

Parameters:

plaintext - plain text data

Throws:

WGAPIException

getMetaData

public java.lang.Object getMetaData(java.lang.String name)

Returns a file metadata value by its field name

Parameters:

name - The field name

Returns:

The value

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

getManualDerivateNames

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

Returns the names of all manual derivates registered for this file

Throws:

WGAPIException

getManualDerivate

public WGFileMetaData.ManualDerivate getManualDerivate(java.lang.String name)
                                                throws WGAPIException

Retrieves a manual derivate defined for this file

Parameters:

name - Name of the derivate

Throws:

WGAPIException

setManualDerivate

public void setManualDerivate(java.lang.String name,
                     java.lang.String usage,
                     java.io.InputStream data)
                       throws WGAPIException

Defines a manual derivate for this file

Parameters:

name - Name of the derivate

usage - Usage of the derivate. Use WGFileAnnotations.USAGE_* constants.

data - The data for the derivate

Throws:

WGAPIException

removeManualDerivate

public void removeManualDerivate(java.lang.String name)
                          throws WGAPIException

Removes a manual derivate

Parameters:

name - Name of the derivate

Throws:

WGAPIException