de.innovationgate.wga.common

Class DesignDirectory

java.lang.Object

de.innovationgate.wga.common.DesignDirectory

public class DesignDirectory
extends java.lang.Object

Holds constants about WGA design directory structure

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DesignDirectory.ScriptInformation Cumumated information about a script module type in design synchronisation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESIGN_DEFINITION_FILE Name of the design definition file
static java.lang.String	FOLDERNAME_FILES Name of the design folder containing file container directories
static java.lang.String	FOLDERNAME_JAVA Name of the optional design folder containing java classes
static java.lang.String	FOLDERNAME_SCRIPT Name of the design folder containing Script modules
static java.lang.String	FOLDERNAME_SCRIPT_CSS Name of the folder containing Script modules of type "CSS"
static java.lang.String	FOLDERNAME_SCRIPT_GROOVY Name of the folder containing Script modules of type "Groovy"
static java.lang.String	FOLDERNAME_SCRIPT_JAVASCRIPT Name of the folder containing Script modules of type "JavaScript"
static java.lang.String	FOLDERNAME_SCRIPT_TMLSCRIPT Name of the folder containing Script modules of type "TMLScript"
static java.lang.String	FOLDERNAME_SCRIPT_VBS Name of the folder containing Script modules of type "Visual Basic Script"
static java.lang.String	FOLDERNAME_SCRIPT_XML Name of the folder containing Script modules of type "XML"
static java.lang.String	FOLDERNAME_TML Name of the design folder containing WebTML modules
static java.lang.String	NAME_METADATADIR Name of design metadata directory
static java.lang.String	OBFUSCATE_FLAGFILE Flag file name indicating design obfuscation
static java.lang.String	SCRIPTTYPE_CSS Script module type "CSS"
static java.lang.String	SCRIPTTYPE_JS Script module type "JavaScript"
static java.lang.String	SCRIPTTYPE_TMLSCRIPT Script module type "TMLScript"
static java.lang.String	SCRIPTTYPE_VBS Script module type "Visual Basic Script"
static java.lang.String	SCRIPTTYPE_XML Script module type "XML"
static java.lang.String	SUFFIX_METADATA Suffix for design metadata files
static java.lang.String	SUFFIX_SCRIPT_CSS Suffix for Script module files of type "CSS"
static java.lang.String	SUFFIX_SCRIPT_GROOVY Suffix for Script module files of type "Groovy"
static java.lang.String	SUFFIX_SCRIPT_JAVASCRIPT Suffix for Script module files of type "JavaScript"
static java.lang.String	SUFFIX_SCRIPT_TMLSCRIPT Suffix for Script module files of type "TMLScript"
static java.lang.String	SUFFIX_SCRIPT_VBS Suffix for Script module files of type "Visual Basic Script"
static java.lang.String	SUFFIX_SCRIPT_XML Suffix for Script module files of type "XML"
static java.lang.String	SUFFIX_TML Suffix for WebTML module files
static java.lang.String	SYNCINFO_FILE Name of the (deprecated) sync information file

Constructor Summary

Constructors

Constructor and Description
DesignDirectory()

Method Summary

Methods

Modifier and Type	Method and Description
static java.io.File	getDesignDefinitionFile(java.io.File parent)
static org.apache.commons.vfs2.FileObject	getDesignDefinitionFile(org.apache.commons.vfs2.FileObject parent)
static DesignDirectory.ScriptInformation	getScriptInformation(java.lang.String type) Returns script type information for the given script type
static DesignDirectory.ScriptInformation	getScriptInformationBySuffix(java.lang.String suffix) Returns script type information for the script type whose design files use the given suffix
static java.util.Map	getScriptTypes() Returns a Map containing DesignDirectory.ScriptInformation objects, mapped by their script types (constants SCRIPTTYPE_...)

Methods inherited from class java.lang.Object

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

Field Detail

SCRIPTTYPE_VBS

public static final java.lang.String SCRIPTTYPE_VBS

Script module type "Visual Basic Script"

See Also:

Constant Field Values

SCRIPTTYPE_XML

public static final java.lang.String SCRIPTTYPE_XML

Script module type "XML"

See Also:

Constant Field Values

SCRIPTTYPE_TMLSCRIPT

public static final java.lang.String SCRIPTTYPE_TMLSCRIPT

Script module type "TMLScript"

See Also:

Constant Field Values

SCRIPTTYPE_JS

public static final java.lang.String SCRIPTTYPE_JS

Script module type "JavaScript"

See Also:

Constant Field Values

SCRIPTTYPE_CSS

public static final java.lang.String SCRIPTTYPE_CSS

Script module type "CSS"

See Also:

Constant Field Values

SYNCINFO_FILE

public static final java.lang.String SYNCINFO_FILE

Name of the (deprecated) sync information file

See Also:

Constant Field Values

DESIGN_DEFINITION_FILE

public static final java.lang.String DESIGN_DEFINITION_FILE

Name of the design definition file

See Also:

Constant Field Values

OBFUSCATE_FLAGFILE

public static final java.lang.String OBFUSCATE_FLAGFILE

Flag file name indicating design obfuscation

See Also:

Constant Field Values

NAME_METADATADIR

public static final java.lang.String NAME_METADATADIR

Name of design metadata directory

See Also:

Constant Field Values

SUFFIX_TML

public static final java.lang.String SUFFIX_TML

Suffix for WebTML module files

See Also:

Constant Field Values

SUFFIX_SCRIPT_CSS

public static final java.lang.String SUFFIX_SCRIPT_CSS

Suffix for Script module files of type "CSS"

See Also:

Constant Field Values

SUFFIX_METADATA

public static final java.lang.String SUFFIX_METADATA

Suffix for design metadata files

See Also:

Constant Field Values

SUFFIX_SCRIPT_JAVASCRIPT

public static final java.lang.String SUFFIX_SCRIPT_JAVASCRIPT

Suffix for Script module files of type "JavaScript"

See Also:

Constant Field Values

SUFFIX_SCRIPT_VBS

public static final java.lang.String SUFFIX_SCRIPT_VBS

Suffix for Script module files of type "Visual Basic Script"

See Also:

Constant Field Values

SUFFIX_SCRIPT_TMLSCRIPT

public static final java.lang.String SUFFIX_SCRIPT_TMLSCRIPT

Suffix for Script module files of type "TMLScript"

See Also:

Constant Field Values

SUFFIX_SCRIPT_XML

public static final java.lang.String SUFFIX_SCRIPT_XML

Suffix for Script module files of type "XML"

See Also:

Constant Field Values

SUFFIX_SCRIPT_GROOVY

public static final java.lang.String SUFFIX_SCRIPT_GROOVY

Suffix for Script module files of type "Groovy"

See Also:

Constant Field Values

FOLDERNAME_JAVA

public static final java.lang.String FOLDERNAME_JAVA

Name of the optional design folder containing java classes

See Also:

Constant Field Values

FOLDERNAME_TML

public static final java.lang.String FOLDERNAME_TML

Name of the design folder containing WebTML modules

See Also:

Constant Field Values

FOLDERNAME_SCRIPT

public static final java.lang.String FOLDERNAME_SCRIPT

Name of the design folder containing Script modules

See Also:

Constant Field Values

FOLDERNAME_FILES

public static final java.lang.String FOLDERNAME_FILES

Name of the design folder containing file container directories

See Also:

Constant Field Values

FOLDERNAME_SCRIPT_TMLSCRIPT

public static final java.lang.String FOLDERNAME_SCRIPT_TMLSCRIPT

Name of the folder containing Script modules of type "TMLScript"

See Also:

Constant Field Values

FOLDERNAME_SCRIPT_XML

public static final java.lang.String FOLDERNAME_SCRIPT_XML

Name of the folder containing Script modules of type "XML"

See Also:

Constant Field Values

FOLDERNAME_SCRIPT_CSS

public static final java.lang.String FOLDERNAME_SCRIPT_CSS

Name of the folder containing Script modules of type "CSS"

See Also:

Constant Field Values

FOLDERNAME_SCRIPT_GROOVY

public static final java.lang.String FOLDERNAME_SCRIPT_GROOVY

Name of the folder containing Script modules of type "Groovy"

See Also:

Constant Field Values

FOLDERNAME_SCRIPT_JAVASCRIPT

public static final java.lang.String FOLDERNAME_SCRIPT_JAVASCRIPT

Name of the folder containing Script modules of type "JavaScript"

See Also:

Constant Field Values

FOLDERNAME_SCRIPT_VBS

public static final java.lang.String FOLDERNAME_SCRIPT_VBS

Name of the folder containing Script modules of type "Visual Basic Script"

See Also:

Constant Field Values

Constructor Detail

DesignDirectory

public DesignDirectory()

Method Detail

getScriptTypes

public static java.util.Map getScriptTypes()

Returns a Map containing DesignDirectory.ScriptInformation objects, mapped by their script types (constants SCRIPTTYPE_...)

getScriptInformation

public static DesignDirectory.ScriptInformation getScriptInformation(java.lang.String type)

Returns script type information for the given script type

Parameters:

type - The script type. Use constants SCRIPTTYPE_...

getScriptInformationBySuffix

public static DesignDirectory.ScriptInformation getScriptInformationBySuffix(java.lang.String suffix)

Returns script type information for the script type whose design files use the given suffix

Parameters:

suffix - The suffix for script files

getDesignDefinitionFile

public static org.apache.commons.vfs2.FileObject getDesignDefinitionFile(org.apache.commons.vfs2.FileObject parent)
                                                                  throws org.apache.commons.vfs2.FileSystemException

Throws:

org.apache.commons.vfs2.FileSystemException

getDesignDefinitionFile

public static java.io.File getDesignDefinitionFile(java.io.File parent)