de.innovationgate.webgate.api

Interface WGDocumentCore

All Superinterfaces:

WGExtensionDataContainer

All Known Implementing Classes:

BeanFolder, BeanWrapper, MapWrapper, WGDocumentCoreWrapper, WGDocumentImpl, WGDocumentImplRSS1, WGDummyContent, WGFakeArea, WGFakeContentType, WGFakeDocument, WGFakeLanguage, WGFakeStructEntry, WGFakeTML, WGFakeUserProfile, WrappedKey

public interface WGDocumentCore
extends WGExtensionDataContainer

Represents the core of a WGA document. WGA Documents can be contents, struct entries, areas, doctypes, WebTML-Layouts, CSS/JS-Resources, language definitions, file containers and user profiles. All these diferent document classes are accessed via this single interface, though the implementing classes can be different for each doc class.

A WGDocumentCore "lives" inside a WGDocument-Object and is directly accessed only by this object. While many threads access the same WGDocument object, each WGDocument object holds multiple WGDocumentCore objects, one for each thread, all representing the same background data. Background resources held by the core implementation should be managed with that fact in mind. After each closed session, all document cores are dropped and will be re-retrieved by their next calling. Therefor WGDocumentCores themselves need not to be thread safe, cause they are specific to one thread and one user session.

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	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<java.lang.String>	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<java.lang.String>	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
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	writeFileDerivateMetaData(WGFileDerivateMetaData md) Writes the modified metadata of a file derivate to the database.

Methods inherited from interface de.innovationgate.webgate.api.WGExtensionDataContainer

getExtensionData, getExtensionDataNames, removeExtensionData, writeExtensionData

Method Detail

getType

int getType()

Returns the type of this document.

Returns:

The type. Use Constants WGDocument.TYPE_...

getFastAccessKey

java.lang.Object getFastAccessKey()
                                  throws WGBackendException

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.

Returns:

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

Throws:

WGBackendException

isDeleted

boolean isDeleted()
                  throws WGAPIException

Tests, if this document is marked as deleted.

Returns:

boolean

Throws:

WGAPIException

isTemporary

boolean isTemporary()
                    throws WGAPIException

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.

Returns:

boolean

Throws:

WGAPIException

hasItem

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

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

Parameters:

strName -

Returns:

boolean

Throws:

WGBackendException

WGAPIException

getItemValue

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

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

Parameters:

strName - Name of the requested content item.

Returns:

Object

Throws:

WGAPIException

getMetaData

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

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.

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

getFileNames

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

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

Returns:

ArrayList

Throws:

WGBackendException

WGAPIException

hasFile

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

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

Throws:

WGBackendException

WGAPIException

getFileData

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

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

Parameters:

strFile - The name of the file

Returns:

InputStream

Throws:

WGAPIException

getFileDerivates

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

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

Parameters:

strFile - The file name

Returns:

List of derivate metadata

Throws:

WGAPIException

getFileSize

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

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

Parameters:

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

Returns:

int

Throws:

WGAPIException

getCreated

java.util.Date getCreated()
                          throws WGAPIException

Retrieves the creation date of this document.

Returns:

Date

Throws:

WGAPIException

getLastModified

java.util.Date getLastModified()
                               throws WGAPIException

Returns the date of the last modification of this document.

Returns:

Date

Throws:

WGAPIException

setItemValue

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

Sets a new value for a content item.

Parameters:

strName - Name of the item to be modified.

value - New value of the item

Returns:

true, if the modification succeeded

Throws:

WGAPIException

setMetaData

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

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.

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

save

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

Called to save modifications to this document core.

Returns:

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

Throws:

WGAPIException

evaluateExpression

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

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

Parameters:

expression - The expression to be evaluated

Returns:

Object The expression result.

Throws:

WGExpressionException

WGBackendException

WGAPIException

setWGDocument

void setWGDocument(WGDocument doc)

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.

Parameters:

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

dispose

void dispose()
             throws WGAPIException

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

Throws:

WGAPIException

getItemNames

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

Returns the names of all items in this document

Throws:

WGBackendException

WGAPIException

removeItem

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

Removes an item from the document

Parameters:

Name - Name of the item to remove

Throws:

WGIllegalArgumentException

WGAPIException

isDataCacheable

boolean isDataCacheable()

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

attachFile

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

Attach a file from disk to the document

Parameters:

file -

Throws:

WGAPIException

removeFile

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

Removes a file attachment from this document

Parameters:

name - Name of the file to remove

Throws:

WGAPIException

remove

WGDatabaseRevision remove()
                          throws WGAPIException

Removes this document from the database

Returns:

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

Throws:

WGAPIException

isSaved

boolean isSaved()
                throws WGAPIException

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

Throws:

WGAPIException

getNativeObject

java.lang.Object getNativeObject()
                                 throws WGAPIException

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

Throws:

WGBackendException

WGAPIException

getOriginDatabase

java.lang.String getOriginDatabase()

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

renameFile

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

Renames an attached file

Parameters:

oldFileName - - file to rename

newFileName - - new name for the file

Throws:

WGAPIException

getFileMetaData

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

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 hasFileMetadata() to determine if metadata is present.

Parameters:

strFile - - the filename

Returns:

WGFileMetaData

Throws:

WGAPIException

retrieveFileExtensionDataHandler

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

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

Parameters:

strFile - - the filename

Returns:

WGExtensionDataContainer

Throws:

WGAPIException

setRelation

WGDocumentCore setRelation(WGRelationData data)
                           throws WGAPIException

Sets a content relation to the designated target

Parameters:

data - All data of the relation

Returns:

The previously mapped document for this relation

Throws:

WGAPIException

getRelation

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

Retrieves the target content document of the given content relation

Parameters:

name - Name of the relation

Returns:

The content behind this relation

Throws:

WGAPIException

getRelationData

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

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

Parameters:

name - The name of the relation

Returns:

The data of the relation

Throws:

WGAPIException

removeRelation

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

Removes a content relation

Parameters:

name - Name of the relation

Returns:

The content document previously mapped to this relation

Throws:

WGAPIException

getRelationNames

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

Returns the names of all relations that this content document holds

Returns:

List of Strings, representing relation names

Throws:

WGAPIException

hasFileMetadata

boolean hasFileMetadata()
                        throws WGAPIException

Determines if this document serves metadata for file attachments

Returns:

true, if file metadata is available

Throws:

WGAPIException

getRelationNamesOfGroup

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

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

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

createFileDerivate

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

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

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

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

Deletes an existing file derivate

Parameters:

id - The ID of the derivate

Throws:

WGAPIException

getFileDerivateMetaData

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

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

Parameters:

id - The ID of the derivate

Throws:

WGAPIException

writeFileDerivateMetaData

void writeFileDerivateMetaData(WGFileDerivateMetaData md)
                               throws WGAPIException,
                                      WGNotSupportedException

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

Parameters:

md - The metadata

Throws:

WGAPIException

WGNotSupportedException - if derivates are not supported on this database

getFileDerivateData

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

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

Parameters:

id - The ID of the derivate

Throws:

WGAPIException

getLastUpdates

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

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

Throws:

WGAPIException

markFileMetaDataModified

void markFileMetaDataModified(WGFileMetaData md)
                              throws WGAPIException

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

Throws:

WGAPIException