de.innovationgate.webgate.api.query.rss

Class WGDocumentImplRSS1

java.lang.Object

de.innovationgate.webgate.api.fake.WGFakeDocument

de.innovationgate.webgate.api.query.rss.WGDocumentImplRSS1

All Implemented Interfaces:

WGDocumentCore, WGExtensionDataContainer

public class WGDocumentImplRSS1
extends WGFakeDocument

Constructor Summary

Constructors

Constructor and Description
WGDocumentImplRSS1(WGDatabase db, java.lang.String key, org.dom4j.Element channel, org.dom4j.Element item)

Method Summary

Methods

Modifier and Type	Method and Description
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.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.lang.Object	getMetaData(java.lang.String type) Retrieves various meta data for the document core.
int	getType() Returns the type of this document.
boolean	hasItem(java.lang.String strName) Tests, if the content contains an item of the given name.
boolean	isDeleted() Tests, if this document is marked as deleted.
boolean	isTemporary() Should return true, if this document core cannot be re-retrieved by it's individual key.
boolean	removeItem(java.lang.String Name) Removes an item from the document
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 strName, java.lang.Object value) Modifies various meta data for the document core.
void	setWGDocument(WGDocument doc) Called by the WGAPI after instantiation of this document core to provide a reference to the wrapping WGDocument object.

Methods inherited from class de.innovationgate.webgate.api.fake.WGFakeDocument

attachFile, createFileDerivate, dispose, getExtensionData, getExtensionDataNames, getFileDerivateData, getFileDerivateMetaData, getFileDerivates, getFileMetaData, getLastUpdates, getMetaDataDefault, getNativeObject, getOriginDatabase, getRelation, getRelationData, getRelationNames, getRelationNamesOfGroup, hasFile, hasFileMetadata, isDataCacheable, isFake, isSaved, markFileMetaDataModified, remove, removeExtensionData, removeFile, removeFileDerivate, removeRelation, renameFile, retrieveFileExtensionDataHandler, setCacheable, setDeleted, setRelation, setRelation, writeExtensionData, writeFileDerivateMetaData

Methods inherited from class java.lang.Object

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

Constructor Detail

WGDocumentImplRSS1

public WGDocumentImplRSS1(WGDatabase db,
                  java.lang.String key,
                  org.dom4j.Element channel,
                  org.dom4j.Element item)

Method Detail

getType

public int getType()

Description copied from interface: WGDocumentCore

Returns the type of this document.

Specified by:

getType in interface WGDocumentCore

Overrides:

getType in class WGFakeDocument

Returns:

The type. Use Constants WGDocument.TYPE_...

getFastAccessKey

public java.lang.Object getFastAccessKey()

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

Overrides:

getFastAccessKey in class WGFakeDocument

Returns:

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

isDeleted

public boolean isDeleted()

Description copied from interface: WGDocumentCore

Tests, if this document is marked as deleted.

Specified by:

isDeleted in interface WGDocumentCore

Overrides:

isDeleted in class WGFakeDocument

Returns:

boolean

isTemporary

public boolean isTemporary()

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

Overrides:

isTemporary in class WGFakeDocument

Returns:

boolean

hasItem

public boolean hasItem(java.lang.String strName)

Description copied from interface: WGDocumentCore

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

Specified by:

hasItem in interface WGDocumentCore

Overrides:

hasItem in class WGFakeDocument

Returns:

boolean

getItemValue

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

Description copied from interface: WGDocumentCore

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

Specified by:

getItemValue in interface WGDocumentCore

Overrides:

getItemValue in class WGFakeDocument

Parameters:

strName - Name of the requested content item.

Returns:

Object

getMetaData

public java.lang.Object getMetaData(java.lang.String type)
                             throws WGSystemException,
                                    WGIllegalArgumentException,
                                    WGBackendException

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

Overrides:

getMetaData in class WGFakeDocument

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:

WGSystemException

WGIllegalArgumentException

WGBackendException

getFileNames

public java.util.List getFileNames()

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

Overrides:

getFileNames in class WGFakeDocument

Returns:

ArrayList

getFileData

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

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

Overrides:

getFileData in class WGFakeDocument

Parameters:

strFile - The name of the file

Returns:

InputStream

getFileSize

public int getFileSize(java.lang.String strFile)

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

Overrides:

getFileSize in class WGFakeDocument

Parameters:

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

Returns:

int

getCreated

public java.util.Date getCreated()

Description copied from interface: WGDocumentCore

Retrieves the creation date of this document.

Specified by:

getCreated in interface WGDocumentCore

Overrides:

getCreated in class WGFakeDocument

Returns:

Date

getLastModified

public java.util.Date getLastModified()

Description copied from interface: WGDocumentCore

Returns the date of the last modification of this document.

Specified by:

getLastModified in interface WGDocumentCore

Overrides:

getLastModified in class WGFakeDocument

Returns:

Date

setItemValue

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

Description copied from interface: WGDocumentCore

Sets a new value for a content item.

Specified by:

setItemValue in interface WGDocumentCore

Overrides:

setItemValue in class WGFakeDocument

Parameters:

strName - Name of the item to be modified.

value - New value of the item

Returns:

true, if the modification succeeded

setMetaData

public boolean setMetaData(java.lang.String strName,
                  java.lang.Object value)

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

Overrides:

setMetaData in class WGFakeDocument

Parameters:

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

Returns:

true, if the modification succeeded

save

public WGDatabaseRevision save(java.util.Date lastModified)

Description copied from interface: WGDocumentCore

Called to save modifications to this document core.

Specified by:

save in interface WGDocumentCore

Overrides:

save in class WGFakeDocument

Returns:

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

evaluateExpression

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

Description copied from interface: WGDocumentCore

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

Specified by:

evaluateExpression in interface WGDocumentCore

Overrides:

evaluateExpression in class WGFakeDocument

Parameters:

expression - The expression to be evaluated

Returns:

Object The expression result.

Throws:

WGExpressionException

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

Overrides:

setWGDocument in class WGFakeDocument

Parameters:

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

getItemNames

public java.util.List getItemNames()

Description copied from interface: WGDocumentCore

Returns the names of all items in this document

Specified by:

getItemNames in interface WGDocumentCore

Overrides:

getItemNames in class WGFakeDocument

removeItem

public boolean removeItem(java.lang.String Name)

Description copied from interface: WGDocumentCore

Removes an item from the document

Specified by:

removeItem in interface WGDocumentCore

Overrides:

removeItem in class WGFakeDocument

Parameters:

Name - Name of the item to remove