com.alveole.studio.web.managers.struts2editor
Class Struts2BaseFileModel

java.lang.Object
  com.alveole.studio.web.managers.struts2editor.Struts2BaseFileModel

public class Struts2BaseFileModel
extends java.lang.Object

This class is a model associated to a Struts2BaseFileEditor. It is responsible for managing view. Alveole Studio Plugin enables to product struts2.xml files. These files are an export (filtered through XSLT files) of the tree that is designed by developper. But a simple tree is usually not sufficient to construct a whole application. As a result, this editor enables to perform customizations such as adding/removing interceptors on a package, adding beans...

Author:

sylvain

Constructor Summary

Struts2BaseFileModel(ProjectContext pContext, org.w3c.dom.Element strutsElementContainer)
Constructor.

Method Summary

void	deleteGlobalExceptionMapping(org.w3c.dom.Element mapping) Deletes a global exception mapping.
void	deleteGlobalResult(org.w3c.dom.Element result) Deletes a global result.
void	deletePackage(org.w3c.dom.Element pack) Deletes a package.
void	deleteResultType(org.w3c.dom.Element pack) Deletes a result-type.
org.w3c.dom.Element[]	getBeanElements(org.w3c.dom.Element beans) Get beans.
java.lang.String	getBeanLabel(org.w3c.dom.Element bean) Get bean label.
org.w3c.dom.Element	getBeansElement(org.w3c.dom.Element model) Get beans.
org.w3c.dom.Element[]	getConstantElements(org.w3c.dom.Element constants) Get constants.
java.lang.String	getConstantLabel(org.w3c.dom.Element constant) Get constant label.
org.w3c.dom.Element	getConstantsElement(org.w3c.dom.Element model) Get constants.
org.w3c.dom.Element[]	getGlobalExceptionMappingElements(org.w3c.dom.Element mappings) Get global exception mapping elements.
java.lang.String	getGlobalExceptionMappingLabel(org.w3c.dom.Element el) Gets an global exception mapping label.
org.w3c.dom.Element	getGlobalExceptionMappingsElement(org.w3c.dom.Element pack) Get global exception mapping element.
org.w3c.dom.Element[]	getGlobalResultElements(org.w3c.dom.Element globalResults) Get all global results defined inside a global-results tag.
java.lang.String	getGlobalResultLabel(org.w3c.dom.Element el) Gets an global result label.
org.w3c.dom.Element	getGlobalResultsElement(org.w3c.dom.Element pack) Get all global results.
java.lang.String	getInterceptorLabel(org.w3c.dom.Element el) Gets an interceptor label.
java.lang.String	getInterceptorRefLabel(org.w3c.dom.Element el) Gets an interceptor-ref label.
org.w3c.dom.Element[]	getInterceptorRefs(org.w3c.dom.Element stack) Get all interceptor-refs from a stack.
org.w3c.dom.Element[]	getInterceptorsAndStacks(org.w3c.dom.Element pack) Get all interceptors from a package.
org.w3c.dom.Element	getInterceptorsElement(org.w3c.dom.Element pack) Get all interceptors.
java.lang.String	getInterceptorStackLabel(org.w3c.dom.Element el) Gets an interceptor-stack label.
java.lang.String	getPackageLabel(org.w3c.dom.Element pack) Gets a label for the given package element.
java.lang.String	getPackageName(org.w3c.dom.Element pack) Gets a name (unique) for the given package element.
java.lang.String	getPackageNamespace(org.w3c.dom.Element pack) Gets a namespace for the given package element.
java.lang.String	getPackageParent(org.w3c.dom.Element pack) Gets parent for the given package element.
org.w3c.dom.Element[]	getPackages() Get all packages.
ProjectContext	getPContext()
org.w3c.dom.Element[]	getResultTypeElements(org.w3c.dom.Element pack) Gets a result-type elements.
java.lang.String	getResultTypeLabel(org.w3c.dom.Element el) Gets a result-type label.
org.w3c.dom.Element	getResultTypesElement(org.w3c.dom.Element pack) Gets a result-types element.
org.w3c.dom.Element	getStrutsElementContainer()
boolean	hasDefaultAction(org.w3c.dom.Element pack) Specifies that a default action is defined for this package.
boolean	hasDefaultInterceptor(org.w3c.dom.Element pack) Specifies that a default interceptor is defined for this package.
void	removeBean(org.w3c.dom.Element el) Removes a bean.
void	removeConstant(org.w3c.dom.Element el) Removes a constant.
void	removeDefaultActionRef(org.w3c.dom.Element ref) Removes a default-action-ref.
void	removeDefaultInterceptorRef(org.w3c.dom.Element ref) Removes a default-interceptor-ref.
void	removeInterceptor(org.w3c.dom.Element el) Removes an interceptor.
void	removeInterceptorRef(org.w3c.dom.Element el) Removes an interceptor-ref.
void	removeInterceptorStack(org.w3c.dom.Element el) Removes an interceptor.
void	setPackageName(org.w3c.dom.Element pack, java.lang.String name) Sets a name (unique) for the given package element.
void	setPackageNamespace(org.w3c.dom.Element pack, java.lang.String ns) Sets a namespace for the given package element.
void	setPackageParent(org.w3c.dom.Element pack, java.lang.String name) Sets parent for the given package element.
void	setPContext(ProjectContext context)
void	setStrutsElementContainer(org.w3c.dom.Element strutsElementContainer)
boolean	validatePackageName(java.lang.String name) Check if the given name is valid and unique.
boolean	validatePackageNamespace(java.lang.String namespace) Check if the given name is valid and unique.

Methods inherited from class java.lang.Object

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

Constructor Detail

Struts2BaseFileModel

public Struts2BaseFileModel(ProjectContext pContext,
                            org.w3c.dom.Element strutsElementContainer)

Constructor.

Parameters:

packageElementContainer - The root tag that contains all struts definitions. All struts tags MUST be prefixed by "s:".

Method Detail

getPackages

public org.w3c.dom.Element[] getPackages()

Get all packages.

getInterceptorsElement

public org.w3c.dom.Element getInterceptorsElement(org.w3c.dom.Element pack)

Get all interceptors.

getGlobalResultElements

public org.w3c.dom.Element[] getGlobalResultElements(org.w3c.dom.Element globalResults)

Get all global results defined inside a global-results tag.

getGlobalResultsElement

public org.w3c.dom.Element getGlobalResultsElement(org.w3c.dom.Element pack)

Get all global results.

getBeansElement

public org.w3c.dom.Element getBeansElement(org.w3c.dom.Element model)

Get beans.

getBeanElements

public org.w3c.dom.Element[] getBeanElements(org.w3c.dom.Element beans)

Get beans.

getConstantsElement

public org.w3c.dom.Element getConstantsElement(org.w3c.dom.Element model)

Get constants.

getConstantElements

public org.w3c.dom.Element[] getConstantElements(org.w3c.dom.Element constants)

Get constants.

getBeanLabel

public java.lang.String getBeanLabel(org.w3c.dom.Element bean)

Get bean label.

getConstantLabel

public java.lang.String getConstantLabel(org.w3c.dom.Element constant)

Get constant label.

getGlobalExceptionMappingsElement

public org.w3c.dom.Element getGlobalExceptionMappingsElement(org.w3c.dom.Element pack)

Get global exception mapping element.

getGlobalExceptionMappingElements

public org.w3c.dom.Element[] getGlobalExceptionMappingElements(org.w3c.dom.Element mappings)

Get global exception mapping elements.

getInterceptorsAndStacks

public org.w3c.dom.Element[] getInterceptorsAndStacks(org.w3c.dom.Element pack)

Get all interceptors from a package.

getInterceptorRefs

public org.w3c.dom.Element[] getInterceptorRefs(org.w3c.dom.Element stack)

Get all interceptor-refs from a stack.

getGlobalResultLabel

public java.lang.String getGlobalResultLabel(org.w3c.dom.Element el)

Gets an global result label.

getGlobalExceptionMappingLabel

public java.lang.String getGlobalExceptionMappingLabel(org.w3c.dom.Element el)

Gets an global exception mapping label.

getInterceptorLabel

public java.lang.String getInterceptorLabel(org.w3c.dom.Element el)

Gets an interceptor label.

getInterceptorRefLabel

public java.lang.String getInterceptorRefLabel(org.w3c.dom.Element el)

Gets an interceptor-ref label.

getResultTypeLabel

public java.lang.String getResultTypeLabel(org.w3c.dom.Element el)

Gets a result-type label.

getInterceptorStackLabel

public java.lang.String getInterceptorStackLabel(org.w3c.dom.Element el)

Gets an interceptor-stack label.

removeInterceptor

public void removeInterceptor(org.w3c.dom.Element el)

Removes an interceptor.

removeConstant

public void removeConstant(org.w3c.dom.Element el)

Removes a constant.

removeBean

public void removeBean(org.w3c.dom.Element el)

Removes a bean.

removeInterceptorRef

public void removeInterceptorRef(org.w3c.dom.Element el)

Removes an interceptor-ref.

removeInterceptorStack

public void removeInterceptorStack(org.w3c.dom.Element el)

Removes an interceptor.

getPackageLabel

public java.lang.String getPackageLabel(org.w3c.dom.Element pack)

Gets a label for the given package element.

hasDefaultInterceptor

public boolean hasDefaultInterceptor(org.w3c.dom.Element pack)

Specifies that a default interceptor is defined for this package.

hasDefaultAction

public boolean hasDefaultAction(org.w3c.dom.Element pack)

Specifies that a default action is defined for this package.

removeDefaultInterceptorRef

public void removeDefaultInterceptorRef(org.w3c.dom.Element ref)

Removes a default-interceptor-ref.

removeDefaultActionRef

public void removeDefaultActionRef(org.w3c.dom.Element ref)

Removes a default-action-ref.

validatePackageName

public boolean validatePackageName(java.lang.String name)

Check if the given name is valid and unique.

validatePackageNamespace

public boolean validatePackageNamespace(java.lang.String namespace)

Check if the given name is valid and unique.

getResultTypesElement

public org.w3c.dom.Element getResultTypesElement(org.w3c.dom.Element pack)

Gets a result-types element.

getResultTypeElements

public org.w3c.dom.Element[] getResultTypeElements(org.w3c.dom.Element pack)

Gets a result-type elements.

getPackageName

public java.lang.String getPackageName(org.w3c.dom.Element pack)

Gets a name (unique) for the given package element.

getPackageParent

public java.lang.String getPackageParent(org.w3c.dom.Element pack)

Gets parent for the given package element.

setPackageName

public void setPackageName(org.w3c.dom.Element pack,
                           java.lang.String name)

Sets a name (unique) for the given package element.

setPackageParent

public void setPackageParent(org.w3c.dom.Element pack,
                             java.lang.String name)

Sets parent for the given package element.

getPackageNamespace

public java.lang.String getPackageNamespace(org.w3c.dom.Element pack)

Gets a namespace for the given package element.

setPackageNamespace

public void setPackageNamespace(org.w3c.dom.Element pack,
                                java.lang.String ns)

Sets a namespace for the given package element.

getStrutsElementContainer

public org.w3c.dom.Element getStrutsElementContainer()

Returns:

the strutsElementContainer

setStrutsElementContainer

public void setStrutsElementContainer(org.w3c.dom.Element strutsElementContainer)

Parameters:

strutsElementContainer - the strutsElementContainer to set

deletePackage

public void deletePackage(org.w3c.dom.Element pack)

Deletes a package.

deleteResultType

public void deleteResultType(org.w3c.dom.Element pack)

Deletes a result-type.

deleteGlobalResult

public void deleteGlobalResult(org.w3c.dom.Element result)

Deletes a global result.

deleteGlobalExceptionMapping

public void deleteGlobalExceptionMapping(org.w3c.dom.Element mapping)

Deletes a global exception mapping.

getPContext

public ProjectContext getPContext()

Returns:

the pContext

setPContext

public void setPContext(ProjectContext context)

Parameters:

context - the pContext to set