de.innovationgate.webgate.api

Class WGTMLModule

java.lang.Object

de.innovationgate.webgate.api.WGDocument

de.innovationgate.webgate.api.WGDesignDocument

de.innovationgate.webgate.api.WGDesignResourceDocument

de.innovationgate.webgate.api.WGTMLModule

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext

public class WGTMLModule
extends WGDesignResourceDocument
implements PageHierarchyNode

A TML module containing WebTML Source code.

Nested Class Summary

Nested classes/interfaces inherited from class de.innovationgate.webgate.api.WGDocument

WGDocument.Cache, WGDocument.FakeMetaDataContext, WGDocument.SaveAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_CACHEABLE
static java.lang.String	META_CODE
static java.lang.String	META_CODEOFFSET
static java.lang.String	META_DIRECTACCESS
static java.lang.String	META_MEDIAKEY
static java.lang.String	META_PREPROCESS
static MetaInfo	METAINFO_CACHEABLE
static MetaInfo	METAINFO_CODE
static MetaInfo	METAINFO_CODEOFFSET
static MetaInfo	METAINFO_DIRECTACCESS
static MetaInfo	METAINFO_MEDIAKEY
static MetaInfo	METAINFO_PREPROCESS

Fields inherited from class de.innovationgate.webgate.api.WGDesignResourceDocument

META_SOURCEFILENAME, METAINFO_SOURCEFILENAME

Fields inherited from class de.innovationgate.webgate.api.WGDesignDocument

META_DESCRIPTION, META_DESIGNREFERENCE, META_NAME, META_VARIANT, METAINFO_DESCRIPTION, METAINFO_DESIGNREFERENCE, METAINFO_NAME, METAINFO_VARIANT

Fields inherited from class de.innovationgate.webgate.api.WGDocument

CSFEATURE_EXTDATA, DERIVATE_NAME_PATTERN, DOCKEY_DIVIDER, EXT_PRIMARY_ATTACHMENT, EXTDATA_META_PREFIX, META_CREATED, META_LASTMODIFIED, META_PASTAUTHORS, META_PASTEDITDATES, META_REVISION, METAINFO_CREATED, METAINFO_LASTMODIFIED, METAINFO_PASTAUTHORS, METAINFO_PASTEDITDATES, METAINFO_REVISION, NOONE_ALLOWED, PAGERESTRICTION_ANY, PAGERESTRICTION_FIXEDTYPES, PAGERESTRICTION_NONE, PAGERESTRICTION_UNSPECIFIED, TYPE_ACLENTRY, TYPE_AREA, TYPE_CONTENT, TYPE_CONTENTTYPE, TYPE_CSSJS, TYPE_DBMETADATA, TYPE_FILECONTAINER, TYPE_FILEDERIVATE, TYPE_LANGUAGE, TYPE_STRUCTENTRY, TYPE_TML, TYPE_USERPROFILE, TYPENAME_ACLENTRY, TYPENAME_AREA, TYPENAME_CONTENT, TYPENAME_CONTENTTYPE, TYPENAME_CSSJS, TYPENAME_DBMETADATA, TYPENAME_FILECONTAINER, TYPENAME_FILEDERIVATE, TYPENAME_LANGUAGE, TYPENAME_STRUCTENTRY, TYPENAME_TML, TYPENAME_USERPROFILE

Constructor Summary

Constructors

Constructor and Description
WGTMLModule(WGDatabase db, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
WGDocument	createClone(WGDatabase db) Creates a clone of this design document in another database
static java.lang.String	createDeploymentKey(java.lang.String dbKey, java.lang.String moduleName, java.lang.String mediaKey) Creates a key, unique for one tml module, to be used when deploying it as JSP
void	dropCache() Drops the cache of this document.
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode>	getChildNodeIterator(int pageSize) Returns an iterator for the child nodes of this hierarchy node
java.util.List<PageHierarchyNode>	getChildNodes() Returns the child nodes of this hierarchy node
java.lang.Class	getChildNodeType() Return the class type of child nodes
java.lang.String	getCode() returns the WebTML-Code
int	getCodeOffset() Returns the line number that the first line of code in this module had in its source medium.
java.lang.String	getMediaKey() Returns the media key of this module.
java.lang.String	getName() Returns the name of this TML module.
java.lang.String	getNodeKey() Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
java.lang.String	getNodeTitle(java.lang.String language) Returns the display title for the node.
PageHierarchyNode	getParentNode() Return the parent of this node in hierarchy.
int	getType() Returns the type of this document as constant WGDocument.TYPE_...
boolean	isCacheable() Returns if this TML modules results should be browser-cacheable
boolean	isDirectAccessAllowed() Returns if this module should be directly accessible via URL
boolean	isPreprocess()
void	performSaveCheck() Performs a validation for saving the document at the current state, just like it actually was saved.
void	pushData(WGDocument doc) Pushed the data of this document to another document of the same type.
boolean	setCacheable(boolean cacheable) Sets if the result of this modules code should be browser-cacheable
boolean	setCode(java.lang.String code) Sets the WebTML-Code for this module
boolean	setDirectAccessAllowed(boolean value) Sets if this module should be directly accessible via URL
boolean	setPreprocess(boolean value)

Methods inherited from class de.innovationgate.webgate.api.WGDesignResourceDocument

getSourceFileName

Methods inherited from class de.innovationgate.webgate.api.WGDesignDocument

buildDesignDocumentKey, createClone, getDescription, getDesignReference, getParentLockable, isVariant, mayEditDocument, rename, rename, retrieveCore, setDescription

Methods inherited from class de.innovationgate.webgate.api.WGDocument

afterSave, attachAllFiles, attachAllFiles, attachFile, attachFile, attachFile, attachFileWithoutAnnotation, attachFileWithoutAnnotation, autoSave, buildDocumentKey, createFileDerivate, createFileDerivate, docTypeClassToNumber, doctypeNameToNumber, doctypeNumberToClass, doctypeNumberToName, dropCore, equals, evaluateExpression, getCore, getCoreRetrieved, getCreated, getDatabase, getDocumentKey, getDocumentKeyObj, getExpectedMetaClass, getExtdataMetaName, getExtensionData, getExtensionDataNames, getFileData, getFileDerivateData, getFileDerivateMetaData, getFileDerivates, getFileLastModified, getFileMetaData, getFileMimeType, getFileMimeTypes, getFileNames, getFileParent, getFileSize, getFileText, getFileText, getItemDate, getItemNames, getItemNumber, getItemText, getItemValue, getItemValueList, getLastModified, getLastUpdates, getLockStatus, getLockStatus, getMetaData, getMetaDataList, getMetaInfo, getMetaInfoByType, getMetaNames, getName, getNativeObject, getObjectCreated, getPastAuthors, getPastEditDates, getPersistentStore, getPrimaryFileName, getRevision, hasFile, hasFileMetadata, hashCode, hasItem, innerAttachFile, isCachingEnabled, isCoreRetrieved, isDeleted, isDeleted, isDummy, isEdited, isListMeta, isSaved, isTemporary, lock, lock, markEdited, markMetaDataModified, mayPushExtData, mayRemove, mayRemove, maySave, performRemoveCheck, performRemoveCheck, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItem, setItems, setItemValue, setMeta, setMetaData, setMetas, setMetaToDefault, setPrimaryFileName, setValues, unlock, unlock, validateMetas, validateMetas, writeExtensionData, writeFileDerivateMetaData

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

META_CODE

public static final java.lang.String META_CODE

See Also:

Constant Field Values

METAINFO_CODE

public static final MetaInfo METAINFO_CODE

META_MEDIAKEY

public static final java.lang.String META_MEDIAKEY

See Also:

Constant Field Values

METAINFO_MEDIAKEY

public static final MetaInfo METAINFO_MEDIAKEY

META_DIRECTACCESS

public static final java.lang.String META_DIRECTACCESS

See Also:

Constant Field Values

METAINFO_DIRECTACCESS

public static final MetaInfo METAINFO_DIRECTACCESS

META_CACHEABLE

public static final java.lang.String META_CACHEABLE

See Also:

Constant Field Values

METAINFO_CACHEABLE

public static final MetaInfo METAINFO_CACHEABLE

META_CODEOFFSET

public static final java.lang.String META_CODEOFFSET

See Also:

Constant Field Values

METAINFO_CODEOFFSET

public static final MetaInfo METAINFO_CODEOFFSET

META_PREPROCESS

public static final java.lang.String META_PREPROCESS

See Also:

Constant Field Values

METAINFO_PREPROCESS

public static final MetaInfo METAINFO_PREPROCESS

Constructor Detail

WGTMLModule

public WGTMLModule(WGDatabase db,
           WGDocumentCore doc,
           de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
            throws WGAPIException

Constructor. Not to be used outside WGAPI

Parameters:

db -

doc -

Throws:

WGAPIException

Method Detail

createDeploymentKey

public static java.lang.String createDeploymentKey(java.lang.String dbKey,
                                   java.lang.String moduleName,
                                   java.lang.String mediaKey)

Creates a key, unique for one tml module, to be used when deploying it as JSP

Parameters:

dbKey - The database of the module

moduleName - The name of the module

mediaKey - The media key of the module

Returns:

The deployment key

getName

public java.lang.String getName()
                         throws WGAPIException

Returns the name of this TML module.

Specified by:

getName in class WGDesignDocument

Throws:

WGAPIException

getCode

public java.lang.String getCode()
                         throws WGAPIException

returns the WebTML-Code

Throws:

WGAPIException

setCode

public boolean setCode(java.lang.String code)
                throws WGAPIException

Sets the WebTML-Code for this module

Parameters:

code -

Throws:

WGAPIException

getMediaKey

public java.lang.String getMediaKey()
                             throws WGAPIException

Returns the media key of this module.

Overrides:

getMediaKey in class WGDesignDocument

Throws:

WGAPIException

isDirectAccessAllowed

public boolean isDirectAccessAllowed()
                              throws WGAPIException

Returns if this module should be directly accessible via URL

Throws:

WGAPIException

setDirectAccessAllowed

public boolean setDirectAccessAllowed(boolean value)
                               throws WGAPIException

Sets if this module should be directly accessible via URL

Parameters:

value -

Throws:

WGAPIException

isPreprocess

public boolean isPreprocess()
                     throws WGAPIException

Throws:

WGAPIException

setPreprocess

public boolean setPreprocess(boolean value)
                      throws WGAPIException

Throws:

WGAPIException

createClone

public WGDocument createClone(WGDatabase db)
                       throws WGAPIException

Description copied from class: WGDesignDocument

Creates a clone of this design document in another database

Specified by:

createClone in class WGDesignDocument

Parameters:

db - Target database

Returns:

The clone

Throws:

WGAPIException

pushData

public void pushData(WGDocument doc)
              throws WGAPIException

Description copied from class: WGDocument

Pushed the data of this document to another document of the same type. This method is allowed to save the target document if necessary, but is not required to.

Overrides:

pushData in class WGDocument

Parameters:

doc - The target document receiving the data.

Throws:

WGAPIException - If something goes wrong

isCacheable

public boolean isCacheable()
                    throws WGAPIException

Returns if this TML modules results should be browser-cacheable

Throws:

WGAPIException

setCacheable

public boolean setCacheable(boolean cacheable)
                     throws WGAPIException

Sets if the result of this modules code should be browser-cacheable

Throws:

WGAPIException

performSaveCheck

public void performSaveCheck()
                      throws ResourceIsLockedException,
                             WGAPIException,
                             WGAuthorisationException

Description copied from class: WGDocument

Performs a validation for saving the document at the current state, just like it actually was saved. This method finishes quietly if the save check succeeded. Otherwise an adequate WGAuthorisationException is thrown. For checking saving permissions without catching an exception see WGDocument.maySave().

Overrides:

performSaveCheck in class WGDesignResourceDocument

Throws:

WGAPIException

ResourceIsLockedException

WGAuthorisationException

dropCache

public void dropCache()
               throws WGAPIException

Description copied from class: WGDocument

Drops the cache of this document.

Overrides:

dropCache in class WGDocument

Throws:

WGAPIException

getChildNodes

public java.util.List<PageHierarchyNode> getChildNodes()
                                                throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns the child nodes of this hierarchy node

Specified by:

getChildNodes in interface PageHierarchyNode

Throws:

WGAPIException

getChildNodeIterator

public de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> getChildNodeIterator(int pageSize)
                                                                                           throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns an iterator for the child nodes of this hierarchy node

Specified by:

getChildNodeIterator in interface PageHierarchyNode

Parameters:

pageSize - The size of a fetch page, if the implementation fetches childnodes page-wise

Throws:

WGAPIException

getChildNodeType

public java.lang.Class getChildNodeType()

Description copied from interface: PageHierarchyNode

Return the class type of child nodes

Specified by:

getChildNodeType in interface PageHierarchyNode

getNodeKey

public java.lang.String getNodeKey()
                            throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.

Specified by:

getNodeKey in interface PageHierarchyNode

Throws:

WGAPIException

getNodeTitle

public java.lang.String getNodeTitle(java.lang.String language)
                              throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns the display title for the node. If multiple titles for multiple languages exist we choose a specific one for the given language.

Specified by:

getNodeTitle in interface PageHierarchyNode

Parameters:

language - The language whose title is wanted

Returns:

The title

Throws:

WGAPIException

getParentNode

public PageHierarchyNode getParentNode()
                                throws WGAPIException

Description copied from interface: PageHierarchyNode

Return the parent of this node in hierarchy. Return null at the root level.

Specified by:

getParentNode in interface PageHierarchyNode

Throws:

WGAPIException

getCodeOffset

public int getCodeOffset()
                  throws WGAPIException

Returns the line number that the first line of code in this module had in its source medium. Metadata headers might have been removed from the code. This metadata field reports the "real" number of the first line so OpenWGA can correctly report line numbers on errors

Throws:

WGAPIException

getType

public int getType()

Description copied from class: WGDocument

Returns the type of this document as constant WGDocument.TYPE_...

Specified by:

getType in class WGDocument