de.innovationgate.wgpublisher.design.fs

Class DesignFileDocument

java.lang.Object

de.innovationgate.wgpublisher.design.fs.AbstractDesignFile

de.innovationgate.wgpublisher.design.fs.DesignFileDocument

All Implemented Interfaces:

de.innovationgate.webgate.api.WGDocumentCore, de.innovationgate.webgate.api.WGExtensionDataContainer

public class DesignFileDocument
extends AbstractDesignFile
implements de.innovationgate.webgate.api.WGDocumentCore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DesignFileDocument.Data

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTDATA_POSTPROCESSOR

Fields inherited from class de.innovationgate.wgpublisher.design.fs.AbstractDesignFile

FILECONTAINER_METADATA_FILENAME, LOG

Constructor Summary

Constructors

Constructor and Description
DesignFileDocument(FileSystemDesignProvider fileSystemDesignProvider, DesignFileDocument.Data cacheData)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	attachFile(java.io.File file)
de.innovationgate.webgate.api.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)
void	dispose()
java.lang.Object	evaluateExpression(java.lang.String expression)
java.util.Date	getCreated()
java.lang.Object	getExtensionData(java.lang.String strName)
java.util.List	getExtensionDataNames()
java.lang.Object	getFastAccessKey()
java.io.InputStream	getFileData(java.lang.String strFile)
java.io.InputStream	getFileDerivateData(java.lang.String id)
de.innovationgate.webgate.api.WGFileDerivateMetaData	getFileDerivateMetaData(java.lang.String id)
java.util.List<de.innovationgate.webgate.api.WGFileDerivateMetaData>	getFileDerivates(java.lang.String strFile)
de.innovationgate.webgate.api.WGFileMetaData	getFileMetaData(java.lang.String strFile)
java.util.List	getFileNames()
int	getFileSize(java.lang.String strFile)
java.util.List	getItemNames()
java.lang.Object	getItemValue(java.lang.String strName)
java.util.Date	getLastModified()
java.util.Iterator<de.innovationgate.webgate.api.WGUpdateLog>	getLastUpdates()
java.lang.Object	getMetaData(java.lang.String type)
java.lang.Object	getNativeObject()
java.lang.String	getOriginDatabase()
de.innovationgate.webgate.api.WGDocumentCore	getRelation(java.lang.String name)
de.innovationgate.webgate.api.WGRelationData	getRelationData(java.lang.String name)
java.util.List	getRelationNames()
java.util.List<java.lang.String>	getRelationNamesOfGroup(java.lang.String group, de.innovationgate.webgate.api.WGColumnSet order)
boolean	hasFile(java.lang.String file)
boolean	hasFileMetadata()
boolean	hasItem(java.lang.String strName)
boolean	isDataCacheable()
boolean	isDeleted()
boolean	isSaved()
boolean	isTemporary()
void	markFileMetaDataModified(de.innovationgate.webgate.api.WGFileMetaData md)
java.lang.String	performDesignConversionPreProcessing(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> extData)
de.innovationgate.webgate.api.WGDatabaseRevision	remove()
void	removeExtensionData(java.lang.String strName)
boolean	removeFile(java.lang.String name)
void	removeFileDerivate(java.lang.String id)
boolean	removeItem(java.lang.String Name)
de.innovationgate.webgate.api.WGDocumentCore	removeRelation(java.lang.String name)
void	renameFile(java.lang.String oldFileName, java.lang.String newFileName)
de.innovationgate.webgate.api.WGExtensionDataContainer	retrieveFileExtensionDataHandler(java.lang.String strFile)
de.innovationgate.webgate.api.WGDatabaseRevision	save(java.util.Date lastModified)
boolean	setItemValue(java.lang.String strName, java.lang.Object value)
boolean	setMetaData(java.lang.String name, java.lang.Object value)
de.innovationgate.webgate.api.WGDocumentCore	setRelation(java.lang.String name, de.innovationgate.webgate.api.WGDocumentCore target)
de.innovationgate.webgate.api.WGDocumentCore	setRelation(de.innovationgate.webgate.api.WGRelationData relAddress)
void	setWGDocument(de.innovationgate.webgate.api.WGDocument doc)
void	writeExtensionData(java.lang.String strName, java.lang.Object value)
void	writeFileDerivateMetaData(de.innovationgate.webgate.api.WGFileDerivateMetaData md)

Methods inherited from class de.innovationgate.wgpublisher.design.fs.AbstractDesignFile

getCodeFile, getCodeFilePath, getMetadataFile, getSuffix, getType, processDesignHeader

Methods inherited from class java.lang.Object

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

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

getType

Field Detail

EXTDATA_POSTPROCESSOR

public static final java.lang.String EXTDATA_POSTPROCESSOR

See Also:

Constant Field Values

Constructor Detail

DesignFileDocument

public DesignFileDocument(FileSystemDesignProvider fileSystemDesignProvider,
                  DesignFileDocument.Data cacheData)
                   throws org.apache.commons.vfs2.FileSystemException,
                          WGDesignSyncException

Throws:

org.apache.commons.vfs2.FileSystemException

WGDesignSyncException

Method Detail

attachFile

public boolean attachFile(java.io.File file)
                   throws de.innovationgate.webgate.api.WGAPIException

Specified by:

attachFile in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

dispose

public void dispose()

Specified by:

dispose in interface de.innovationgate.webgate.api.WGDocumentCore

evaluateExpression

public java.lang.Object evaluateExpression(java.lang.String expression)
                                    throws de.innovationgate.webgate.api.WGExpressionException,
                                           de.innovationgate.webgate.api.WGBackendException

Specified by:

evaluateExpression in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGExpressionException

de.innovationgate.webgate.api.WGBackendException

getCreated

public java.util.Date getCreated()
                          throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getCreated in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getFastAccessKey

public java.lang.Object getFastAccessKey()
                                  throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getFastAccessKey in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

getFileData

public java.io.InputStream getFileData(java.lang.String strFile)
                                throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getFileData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getFileMetaData

public de.innovationgate.webgate.api.WGFileMetaData getFileMetaData(java.lang.String strFile)
                                                             throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getFileMetaData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getFileNames

public java.util.List getFileNames()
                            throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getFileNames in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

getFileSize

public int getFileSize(java.lang.String strFile)
                throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getFileSize in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getItemNames

public java.util.List getItemNames()
                            throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getItemNames in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

getItemValue

public java.lang.Object getItemValue(java.lang.String strName)
                              throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getItemValue in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getLastModified

public java.util.Date getLastModified()
                               throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getLastModified in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getMetaData

public java.lang.Object getMetaData(java.lang.String type)
                             throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getMetaData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

performDesignConversionPreProcessing

public java.lang.String performDesignConversionPreProcessing(java.lang.String code,
                                                    java.util.Map<java.lang.String,java.lang.Object> extData)
                                                      throws de.innovationgate.wga.modules.ModuleDependencyException,
                                                             de.innovationgate.wga.modules.ModuleInstantiationException,
                                                             de.innovationgate.webgate.api.WGException,
                                                             org.apache.commons.vfs2.FileSystemException

Throws:

de.innovationgate.wga.modules.ModuleDependencyException

de.innovationgate.wga.modules.ModuleInstantiationException

de.innovationgate.webgate.api.WGException

org.apache.commons.vfs2.FileSystemException

getNativeObject

public java.lang.Object getNativeObject()
                                 throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getNativeObject in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

getOriginDatabase

public java.lang.String getOriginDatabase()

Specified by:

getOriginDatabase in interface de.innovationgate.webgate.api.WGDocumentCore

getRelation

public de.innovationgate.webgate.api.WGDocumentCore getRelation(java.lang.String name)
                                                         throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getRelation in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getRelationNames

public java.util.List getRelationNames()
                                throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getRelationNames in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

hasItem

public boolean hasItem(java.lang.String strName)
                throws de.innovationgate.webgate.api.WGBackendException

Specified by:

hasItem in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

isDataCacheable

public boolean isDataCacheable()

Specified by:

isDataCacheable in interface de.innovationgate.webgate.api.WGDocumentCore

isDeleted

public boolean isDeleted()
                  throws de.innovationgate.webgate.api.WGAPIException

Specified by:

isDeleted in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

isSaved

public boolean isSaved()
                throws de.innovationgate.webgate.api.WGAPIException

Specified by:

isSaved in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

isTemporary

public boolean isTemporary()
                    throws de.innovationgate.webgate.api.WGAPIException

Specified by:

isTemporary in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

remove

public de.innovationgate.webgate.api.WGDatabaseRevision remove()
                                                        throws de.innovationgate.webgate.api.WGAPIException

Specified by:

remove in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

removeFile

public boolean removeFile(java.lang.String name)
                   throws de.innovationgate.webgate.api.WGAPIException

Specified by:

removeFile in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

removeItem

public boolean removeItem(java.lang.String Name)
                   throws de.innovationgate.webgate.api.WGAPIException

Specified by:

removeItem in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

removeRelation

public de.innovationgate.webgate.api.WGDocumentCore removeRelation(java.lang.String name)
                                                            throws de.innovationgate.webgate.api.WGAPIException

Specified by:

removeRelation in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

renameFile

public void renameFile(java.lang.String oldFileName,
              java.lang.String newFileName)
                throws de.innovationgate.webgate.api.WGAPIException

Specified by:

renameFile in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

save

public de.innovationgate.webgate.api.WGDatabaseRevision save(java.util.Date lastModified)
                                                      throws de.innovationgate.webgate.api.WGAPIException

Specified by:

save in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

setItemValue

public boolean setItemValue(java.lang.String strName,
                   java.lang.Object value)
                     throws de.innovationgate.webgate.api.WGAPIException

Specified by:

setItemValue in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

setMetaData

public boolean setMetaData(java.lang.String name,
                  java.lang.Object value)
                    throws de.innovationgate.webgate.api.WGAPIException

Specified by:

setMetaData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

setRelation

public de.innovationgate.webgate.api.WGDocumentCore setRelation(java.lang.String name,
                                                       de.innovationgate.webgate.api.WGDocumentCore target)
                                                         throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

setWGDocument

public void setWGDocument(de.innovationgate.webgate.api.WGDocument doc)

Specified by:

setWGDocument in interface de.innovationgate.webgate.api.WGDocumentCore

hasFileMetadata

public boolean hasFileMetadata()
                        throws de.innovationgate.webgate.api.WGAPIException

Specified by:

hasFileMetadata in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

hasFile

public boolean hasFile(java.lang.String file)
                throws de.innovationgate.webgate.api.WGBackendException

Specified by:

hasFile in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

getRelationData

public de.innovationgate.webgate.api.WGRelationData getRelationData(java.lang.String name)
                                                             throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getRelationData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

setRelation

public de.innovationgate.webgate.api.WGDocumentCore setRelation(de.innovationgate.webgate.api.WGRelationData relAddress)
                                                         throws de.innovationgate.webgate.api.WGAPIException

Specified by:

setRelation in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getExtensionData

public java.lang.Object getExtensionData(java.lang.String strName)
                                  throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getExtensionData in interface de.innovationgate.webgate.api.WGExtensionDataContainer

Throws:

de.innovationgate.webgate.api.WGAPIException

getExtensionDataNames

public java.util.List getExtensionDataNames()
                                     throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getExtensionDataNames in interface de.innovationgate.webgate.api.WGExtensionDataContainer

Throws:

de.innovationgate.webgate.api.WGAPIException

removeExtensionData

public void removeExtensionData(java.lang.String strName)
                         throws de.innovationgate.webgate.api.WGAPIException

Specified by:

removeExtensionData in interface de.innovationgate.webgate.api.WGExtensionDataContainer

Throws:

de.innovationgate.webgate.api.WGAPIException

writeExtensionData

public void writeExtensionData(java.lang.String strName,
                      java.lang.Object value)
                        throws de.innovationgate.webgate.api.WGAPIException

Specified by:

writeExtensionData in interface de.innovationgate.webgate.api.WGExtensionDataContainer

Throws:

de.innovationgate.webgate.api.WGAPIException

getRelationNamesOfGroup

public java.util.List<java.lang.String> getRelationNamesOfGroup(java.lang.String group,
                                                       de.innovationgate.webgate.api.WGColumnSet order)
                                                         throws de.innovationgate.webgate.api.WGBackendException

Specified by:

getRelationNamesOfGroup in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGBackendException

retrieveFileExtensionDataHandler

public de.innovationgate.webgate.api.WGExtensionDataContainer retrieveFileExtensionDataHandler(java.lang.String strFile)
                                                                                        throws de.innovationgate.webgate.api.WGAPIException

Specified by:

retrieveFileExtensionDataHandler in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getFileDerivates

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

Specified by:

getFileDerivates in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

markFileMetaDataModified

public void markFileMetaDataModified(de.innovationgate.webgate.api.WGFileMetaData md)
                              throws de.innovationgate.webgate.api.WGAPIException

Specified by:

markFileMetaDataModified in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

createFileDerivate

public de.innovationgate.webgate.api.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 de.innovationgate.webgate.api.WGAPIException,
                                                                               de.innovationgate.webgate.api.WGNotSupportedException

Specified by:

createFileDerivate in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGNotSupportedException

removeFileDerivate

public void removeFileDerivate(java.lang.String id)
                        throws de.innovationgate.webgate.api.WGAPIException

Specified by:

removeFileDerivate in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getFileDerivateMetaData

public de.innovationgate.webgate.api.WGFileDerivateMetaData getFileDerivateMetaData(java.lang.String id)
                                                                             throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getFileDerivateMetaData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

writeFileDerivateMetaData

public void writeFileDerivateMetaData(de.innovationgate.webgate.api.WGFileDerivateMetaData md)
                               throws de.innovationgate.webgate.api.WGAPIException,
                                      de.innovationgate.webgate.api.WGNotSupportedException

Specified by:

writeFileDerivateMetaData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGNotSupportedException

getFileDerivateData

public java.io.InputStream getFileDerivateData(java.lang.String id)
                                        throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getFileDerivateData in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException

getLastUpdates

public java.util.Iterator<de.innovationgate.webgate.api.WGUpdateLog> getLastUpdates()
                                                                             throws de.innovationgate.webgate.api.WGAPIException

Specified by:

getLastUpdates in interface de.innovationgate.webgate.api.WGDocumentCore

Throws:

de.innovationgate.webgate.api.WGAPIException