de.innovationgate.webgate.api

Class WGDocumentCoreWrapper

java.lang.Object

de.innovationgate.webgate.api.WGDocumentCoreWrapper

All Implemented Interfaces:

WGDocumentCore, WGExtensionDataContainer

public class WGDocumentCoreWrapper
extends java.lang.Object
implements WGDocumentCore

A multi-use wrapper for document cores to enhance them with some specialized functionality

Constructor Summary

Constructors

Constructor and Description
WGDocumentCoreWrapper(WGDocumentCore core)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	attachFile(java.io.File file) Attach a file from disk to the document
WGFileDerivateMetaData	createFileDerivate(java.lang.String originalFileName, java.lang.String creator, java.lang.String derivateName, java.io.InputStream in, java.util.Map<java.lang.String,java.lang.Object> customMdFields) Creates a derivate for the addressed file.
void	dispose() Called when this core is disposed "untimely", i.e. before the current session is closed
java.lang.Object	evaluateExpression(java.lang.String expression) Evaluates an expression in a database-native expression language on this document core.
java.util.Date	getCreated() Retrieves the creation date of this document.
java.lang.Object	getExtensionData(java.lang.String strName) Returns the value of an extension data field.
java.util.List	getExtensionDataNames() Returns the names of all extension data fields on this entity
java.lang.Object	getFastAccessKey() Can provide an fast access key, that the corresponding database core implementation can use to re-retrieve an instance of this core.
java.io.InputStream	getFileData(java.lang.String strFile) Retrieves an input stream to the data of an embedded file.
java.io.InputStream	getFileDerivateData(java.lang.String id) Returns the data of a file derivate.
WGFileDerivateMetaData	getFileDerivateMetaData(java.lang.String id) Returns the metadata of a file derivate.
java.util.List<WGFileDerivateMetaData>	getFileDerivates(java.lang.String strFile) Returns metadata about the created derivates for the given file.
WGFileMetaData	getFileMetaData(java.lang.String strFile) retrieves meta informations for the given file May throw an exception if method is used on a document that does not serve file metadata.
java.util.List	getFileNames() Returns a list of the names of embedded files.
int	getFileSize(java.lang.String strFile) Returns the size of an embedded file in bytes.
java.util.List	getItemNames() Returns the names of all items in this document
java.lang.Object	getItemValue(java.lang.String strName) Returns the value of an content item.
java.util.Date	getLastModified() Returns the date of the last modification of this document.
java.util.Iterator<WGUpdateLog>	getLastUpdates() Returns update logs for the last updates done on this document, in descending chronological order
java.lang.Object	getMetaData(java.lang.String type) Retrieves various meta data for the document core.
java.lang.Object	getNativeObject() Returns the native backend object of this doc core if there is any
java.lang.String	getOriginDatabase() Returns the dbReference of the database that this document core was created from
WGDocumentCore	getRelation(java.lang.String name) Retrieves the target content document of the given content relation
WGRelationData	getRelationData(java.lang.String name) Retrieves data for the given content relation.
java.util.List<java.lang.String>	getRelationNames() Returns the names of all relations that this content document holds
java.util.List<java.lang.String>	getRelationNamesOfGroup(java.lang.String group, WGColumnSet order) Returns the names of all relations on this content document that belong to the given relation group.
int	getType() Returns the type of this document.
boolean	hasFile(java.lang.String file) Tests if a file of the given name is attached to the document
boolean	hasFileMetadata() Determines if this document serves metadata for file attachments
boolean	hasItem(java.lang.String strName) Tests, if the content contains an item of the given name.
boolean	isDataCacheable() Should return, if the data retrieved as items and metas of this document can be cached while the document doesn't change
boolean	isDeleted() Tests, if this document is marked as deleted.
boolean	isSaved() Should return if the document has been saved.
boolean	isTemporary() Should return true, if this document core cannot be re-retrieved by it's individual key.
void	markFileMetaDataModified(WGFileMetaData md) Marks a file metadata object as being modified, so the core knows that it must be saved
WGDatabaseRevision	remove() Removes this document from the database
void	removeExtensionData(java.lang.String strName) Removes an extension data field from this entity
boolean	removeFile(java.lang.String name) Removes a file attachment from this document
void	removeFileDerivate(java.lang.String id) Deletes an existing file derivate
boolean	removeItem(java.lang.String Name) Removes an item from the document
WGDocumentCore	removeRelation(java.lang.String name) Removes a content relation
void	renameFile(java.lang.String oldFileName, java.lang.String newFileName) Renames an attached file
WGExtensionDataContainer	retrieveFileExtensionDataHandler(java.lang.String strFile) retrieves the extension data handler for the given file or null if extension data is not supported
WGDatabaseRevision	save(java.util.Date lastModified) Called to save modifications to this document core.
boolean	setItemValue(java.lang.String strName, java.lang.Object value) Sets a new value for a content item.
boolean	setMetaData(java.lang.String name, java.lang.Object value) Modifies various meta data for the document core.
WGDocumentCore	setRelation(WGRelationData data) Sets a content relation to the designated target
void	setWGDocument(WGDocument doc) Called by the WGAPI after instantiation of this document core to provide a reference to the wrapping WGDocument object.
void	writeExtensionData(java.lang.String strName, java.lang.Object value) Sets the value of an extension data field.
void	writeFileDerivateMetaData(WGFileDerivateMetaData md) Writes the modified metadata of a file derivate to the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

WGDocumentCoreWrapper

public WGDocumentCoreWrapper(WGDocumentCore core)

Method Detail

attachFile

public boolean attachFile(java.io.File file)
                   throws WGAPIException

Description copied from interface: WGDocumentCore

Attach a file from disk to the document

Specified by:

attachFile in interface WGDocumentCore

Throws:

WGAPIException

dispose

public void dispose()
             throws WGAPIException

Description copied from interface: WGDocumentCore

Called when this core is disposed "untimely", i.e. before the current session is closed

Specified by:

dispose in interface WGDocumentCore

Throws:

WGAPIException

evaluateExpression

public java.lang.Object evaluateExpression(java.lang.String expression)
                                    throws WGAPIException

Description copied from interface: WGDocumentCore

Evaluates an expression in a database-native expression language on this document core.

Specified by:

evaluateExpression in interface WGDocumentCore

Parameters:

expression - The expression to be evaluated

Returns:

Object The expression result.

Throws:

WGExpressionException

WGBackendException

WGAPIException

getCreated

public java.util.Date getCreated()
                          throws WGAPIException

Description copied from interface: WGDocumentCore

Retrieves the creation date of this document.

Specified by:

getCreated in interface WGDocumentCore

Returns:

Date

Throws:

WGAPIException

getFastAccessKey

public java.lang.Object getFastAccessKey()
                                  throws WGBackendException

Description copied from interface: WGDocumentCore

Can provide an fast access key, that the corresponding database core implementation can use to re-retrieve an instance of this core. Provide null, if this feature is not implemented for this core.

Specified by:

getFastAccessKey in interface WGDocumentCore

Returns:

Object The fast access key, that will be used in the method fastAccess of the corresponding database core implementation.

Throws:

WGBackendException

getFileData

public java.io.InputStream getFileData(java.lang.String strFile)
                                throws WGAPIException

Description copied from interface: WGDocumentCore

Retrieves an input stream to the data of an embedded file. Applies only to content and file containers.

Specified by:

getFileData in interface WGDocumentCore

Parameters:

strFile - The name of the file

Returns:

InputStream

Throws:

WGAPIException

getFileNames

public java.util.List getFileNames()
                            throws WGAPIException

Description copied from interface: WGDocumentCore

Returns a list of the names of embedded files. Applies only to contents and file containers.

Specified by:

getFileNames in interface WGDocumentCore

Returns:

ArrayList

Throws:

WGBackendException

WGAPIException

getFileSize

public int getFileSize(java.lang.String strFile)
                throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the size of an embedded file in bytes. Applies only to contents and file containers.

Specified by:

getFileSize in interface WGDocumentCore

Parameters:

strFile - The name of the file, whose size is requested.

Returns:

int

Throws:

WGAPIException

getItemNames

public java.util.List getItemNames()
                            throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the names of all items in this document

Specified by:

getItemNames in interface WGDocumentCore

Throws:

WGBackendException

WGAPIException

getItemValue

public java.lang.Object getItemValue(java.lang.String strName)
                              throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the value of an content item. Applies only to contents.

Specified by:

getItemValue in interface WGDocumentCore

Parameters:

strName - Name of the requested content item.

Returns:

Object

Throws:

WGAPIException

getLastModified

public java.util.Date getLastModified()
                               throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the date of the last modification of this document.

Specified by:

getLastModified in interface WGDocumentCore

Returns:

Date

Throws:

WGAPIException

getMetaData

public java.lang.Object getMetaData(java.lang.String type)
                             throws WGAPIException

Description copied from interface: WGDocumentCore

Retrieves various meta data for the document core. The method should answer all meta data names, that are provided as constants META_... for the specific WGDocument subclass. Further documentation of the specific data expected for each meta data name will be provided in the wgapi implementation handbook.

Specified by:

getMetaData in interface WGDocumentCore

Parameters:

type - The type of the meta data. See constants META_ of the specific WGDocument subclass for this doc class.

Returns:

The value of the requested meta data for this document core.

Throws:

WGAPIException

getNativeObject

public java.lang.Object getNativeObject()
                                 throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the native backend object of this doc core if there is any

Specified by:

getNativeObject in interface WGDocumentCore

Throws:

WGBackendException

WGAPIException

getType

public int getType()

Description copied from interface: WGDocumentCore

Returns the type of this document.

Specified by:

getType in interface WGDocumentCore

Returns:

The type. Use Constants WGDocument.TYPE_...

hasItem

public boolean hasItem(java.lang.String strName)
                throws WGAPIException

Description copied from interface: WGDocumentCore

Tests, if the content contains an item of the given name.

Specified by:

hasItem in interface WGDocumentCore

Returns:

boolean

Throws:

WGBackendException

WGAPIException

isDataCacheable

public boolean isDataCacheable()

Description copied from interface: WGDocumentCore

Should return, if the data retrieved as items and metas of this document can be cached while the document doesn't change

Specified by:

isDataCacheable in interface WGDocumentCore

isDeleted

public boolean isDeleted()
                  throws WGAPIException

Description copied from interface: WGDocumentCore

Tests, if this document is marked as deleted.

Specified by:

isDeleted in interface WGDocumentCore

Returns:

boolean

Throws:

WGAPIException

isSaved

public boolean isSaved()
                throws WGAPIException

Description copied from interface: WGDocumentCore

Should return if the document has been saved. False means that it is a new document not yet persisted.

Specified by:

isSaved in interface WGDocumentCore

Throws:

WGAPIException

isTemporary

public boolean isTemporary()
                    throws WGAPIException

Description copied from interface: WGDocumentCore

Should return true, if this document core cannot be re-retrieved by it's individual key. In result, the WGAPI won't cache the wrapper object of this document core.

Specified by:

isTemporary in interface WGDocumentCore

Returns:

boolean

Throws:

WGAPIException

remove

public WGDatabaseRevision remove()
                          throws WGAPIException

Description copied from interface: WGDocumentCore

Removes this document from the database

Specified by:

remove in interface WGDocumentCore

Returns:

The revision that was the result of this remove operation. null if this database does not support revisions.

Throws:

WGAPIException

removeFile

public boolean removeFile(java.lang.String name)
                   throws WGAPIException

Description copied from interface: WGDocumentCore

Removes a file attachment from this document

Specified by:

removeFile in interface WGDocumentCore

Parameters:

name - Name of the file to remove

Throws:

WGAPIException

removeItem

public boolean removeItem(java.lang.String Name)
                   throws WGAPIException

Description copied from interface: WGDocumentCore

Removes an item from the document

Specified by:

removeItem in interface WGDocumentCore

Parameters:

Name - Name of the item to remove

Throws:

WGIllegalArgumentException

WGAPIException

save

public WGDatabaseRevision save(java.util.Date lastModified)
                        throws WGAPIException

Description copied from interface: WGDocumentCore

Called to save modifications to this document core.

Specified by:

save in interface WGDocumentCore

Returns:

The revision that was the result of this save operation. null if this database does not support revisions.

Throws:

WGAPIException

setItemValue

public boolean setItemValue(java.lang.String strName,
                   java.lang.Object value)
                     throws WGAPIException

Description copied from interface: WGDocumentCore

Sets a new value for a content item.

Specified by:

setItemValue in interface WGDocumentCore

Parameters:

strName - Name of the item to be modified.

value - New value of the item

Returns:

true, if the modification succeeded

Throws:

WGAPIException

setMetaData

public boolean setMetaData(java.lang.String name,
                  java.lang.Object value)
                    throws WGAPIException

Description copied from interface: WGDocumentCore

Modifies various meta data for the document core. The method should answer all meta data names, that are provided as constants META_... for the specific WGDocument subclass. Further documentation of the specific data expected for each meta data name will be provided in the wgapi implementation handbook.

Specified by:

setMetaData in interface WGDocumentCore

Parameters:

name - The name of the meta data. See constants META_ of the specific WGDocument subclass for this doc class.

Returns:

true, if the modification succeeded

Throws:

WGAPIException

setWGDocument

public void setWGDocument(WGDocument doc)

Description copied from interface: WGDocumentCore

Called by the WGAPI after instantiation of this document core to provide a reference to the wrapping WGDocument object. The implementation can store this reference in a member variable.

Specified by:

setWGDocument in interface WGDocumentCore

Parameters:

doc - The WGDocument object, that wraps this document core.

getOriginDatabase

public java.lang.String getOriginDatabase()

Description copied from interface: WGDocumentCore

Returns the dbReference of the database that this document core was created from

Specified by:

getOriginDatabase in interface WGDocumentCore

renameFile

public void renameFile(java.lang.String oldFileName,
              java.lang.String newFileName)
                throws WGAPIException

Description copied from interface: WGDocumentCore

Renames an attached file

Specified by:

renameFile in interface WGDocumentCore

Parameters:

oldFileName - - file to rename

newFileName - - new name for the file

Throws:

WGAPIException

getFileMetaData

public WGFileMetaData getFileMetaData(java.lang.String strFile)
                               throws WGAPIException

Description copied from interface: WGDocumentCore

retrieves meta informations for the given file May throw an exception if method is used on a document that does not serve file metadata. Use WGDocumentCore.hasFileMetadata() to determine if metadata is present.

Specified by:

getFileMetaData in interface WGDocumentCore

Parameters:

strFile - - the filename

Returns:

WGFileMetaData

Throws:

WGAPIException

getRelation

public WGDocumentCore getRelation(java.lang.String name)
                           throws WGAPIException

Description copied from interface: WGDocumentCore

Retrieves the target content document of the given content relation

Specified by:

getRelation in interface WGDocumentCore

Parameters:

name - Name of the relation

Returns:

The content behind this relation

Throws:

WGAPIException

getRelationNames

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

Description copied from interface: WGDocumentCore

Returns the names of all relations that this content document holds

Specified by:

getRelationNames in interface WGDocumentCore

Returns:

List of Strings, representing relation names

Throws:

WGAPIException

removeRelation

public WGDocumentCore removeRelation(java.lang.String name)
                              throws WGAPIException

Description copied from interface: WGDocumentCore

Removes a content relation

Specified by:

removeRelation in interface WGDocumentCore

Parameters:

name - Name of the relation

Returns:

The content document previously mapped to this relation

Throws:

WGAPIException

hasFileMetadata

public boolean hasFileMetadata()
                        throws WGAPIException

Description copied from interface: WGDocumentCore

Determines if this document serves metadata for file attachments

Specified by:

hasFileMetadata in interface WGDocumentCore

Returns:

true, if file metadata is available

Throws:

WGAPIException

hasFile

public boolean hasFile(java.lang.String file)
                throws WGAPIException

Description copied from interface: WGDocumentCore

Tests if a file of the given name is attached to the document

Specified by:

hasFile in interface WGDocumentCore

Throws:

WGBackendException

WGAPIException

getExtensionData

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

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

Throws:

WGAPIException

getExtensionDataNames

public java.util.List 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

getRelationData

public WGRelationData getRelationData(java.lang.String name)
                               throws WGAPIException

Description copied from interface: WGDocumentCore

Retrieves data for the given content relation. This should work even if the relation does currently not point to a published content.

Specified by:

getRelationData in interface WGDocumentCore

Parameters:

name - The name of the relation

Returns:

The data of the relation

Throws:

WGAPIException

setRelation

public WGDocumentCore setRelation(WGRelationData data)
                           throws WGAPIException

Description copied from interface: WGDocumentCore

Sets a content relation to the designated target

Specified by:

setRelation in interface WGDocumentCore

Parameters:

data - All data of the relation

Returns:

The previously mapped document for this relation

Throws:

WGAPIException

getRelationNamesOfGroup

public java.util.List<java.lang.String> getRelationNamesOfGroup(java.lang.String group,
                                                       WGColumnSet order)
                                                         throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the names of all relations on this content document that belong to the given relation group.

Specified by:

getRelationNamesOfGroup in interface WGDocumentCore

Parameters:

group - The group name

order - Optional order in which to return relations, evaluated against the relation targets, null for no order

Returns:

List of Strings, representing relation names

Throws:

WGBackendException

WGAPIException

retrieveFileExtensionDataHandler

public WGExtensionDataContainer retrieveFileExtensionDataHandler(java.lang.String strFile)
                                                          throws WGAPIException

Description copied from interface: WGDocumentCore

retrieves the extension data handler for the given file or null if extension data is not supported

Specified by:

retrieveFileExtensionDataHandler in interface WGDocumentCore

Parameters:

strFile - - the filename

Returns:

WGExtensionDataContainer

Throws:

WGAPIException

getFileDerivates

public java.util.List<WGFileDerivateMetaData> getFileDerivates(java.lang.String strFile)
                                                        throws WGAPIException

Description copied from interface: WGDocumentCore

Returns metadata about the created derivates for the given file. May return null if derivates are not supported.

Specified by:

getFileDerivates in interface WGDocumentCore

Parameters:

strFile - The file name

Returns:

List of derivate metadata

Throws:

WGAPIException

markFileMetaDataModified

public void markFileMetaDataModified(WGFileMetaData md)
                              throws WGAPIException

Description copied from interface: WGDocumentCore

Marks a file metadata object as being modified, so the core knows that it must be saved

Specified by:

markFileMetaDataModified in interface WGDocumentCore

Throws:

WGAPIException

createFileDerivate

public WGFileDerivateMetaData createFileDerivate(java.lang.String originalFileName,
                                        java.lang.String creator,
                                        java.lang.String derivateName,
                                        java.io.InputStream in,
                                        java.util.Map<java.lang.String,java.lang.Object> customMdFields)
                                          throws WGAPIException,
                                                 WGNotSupportedException

Description copied from interface: WGDocumentCore

Creates a derivate for the addressed file. The derivate should be instantly stored.

Specified by:

createFileDerivate in interface WGDocumentCore

Parameters:

originalFileName - The name of the original file

creator - Identifier of the creator class of this derivate

derivateName - Name of the derivate

in - The data of the derivate file

customMdFields - Additional custom file metadata fields to store for the derivate

Returns:

The metadata of the created derivate

Throws:

WGAPIException

WGNotSupportedException - if derivates are not supported on this database

removeFileDerivate

public void removeFileDerivate(java.lang.String id)
                        throws WGAPIException

Description copied from interface: WGDocumentCore

Deletes an existing file derivate

Specified by:

removeFileDerivate in interface WGDocumentCore

Parameters:

id - The ID of the derivate

Throws:

WGAPIException

getFileDerivateMetaData

public WGFileDerivateMetaData getFileDerivateMetaData(java.lang.String id)
                                               throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the metadata of a file derivate. Should return null if derivates are not supported

Specified by:

getFileDerivateMetaData in interface WGDocumentCore

Parameters:

id - The ID of the derivate

Throws:

WGAPIException

writeFileDerivateMetaData

public void writeFileDerivateMetaData(WGFileDerivateMetaData md)
                               throws WGAPIException,
                                      WGNotSupportedException

Description copied from interface: WGDocumentCore

Writes the modified metadata of a file derivate to the database.

Specified by:

writeFileDerivateMetaData in interface WGDocumentCore

Parameters:

md - The metadata

Throws:

WGAPIException

WGNotSupportedException - if derivates are not supported on this database

getFileDerivateData

public java.io.InputStream getFileDerivateData(java.lang.String id)
                                        throws WGAPIException

Description copied from interface: WGDocumentCore

Returns the data of a file derivate. Should return null if derivates are not supported

Specified by:

getFileDerivateData in interface WGDocumentCore

Parameters:

id - The ID of the derivate

Throws:

WGAPIException

getLastUpdates

public java.util.Iterator<WGUpdateLog> getLastUpdates()
                                               throws WGAPIException

Description copied from interface: WGDocumentCore

Returns update logs for the last updates done on this document, in descending chronological order

Specified by:

getLastUpdates in interface WGDocumentCore

Throws:

WGAPIException