org.opencms.setup.xml
Class CmsXmlAddImgGalleryParam

java.lang.Object
  extended by org.opencms.setup.xml.A_CmsSetupXmlUpdate
      extended by org.opencms.setup.xml.CmsXmlAddImgGalleryParam
All Implemented Interfaces:
I_CmsSetupXmlUpdate

public class CmsXmlAddImgGalleryParam
extends A_CmsSetupXmlUpdate

Adds the new image gallery parameter processing parameter.

Since:
6.1.8
Version:
$Revision: 1.2 $
Author:
Michael Moossen

Constructor Summary
CmsXmlAddImgGalleryParam()
           
 
Method Summary
protected  boolean executeUpdate(org.dom4j.Document document, java.lang.String xpath)
          Executes the adding/updating changes on the given document.
protected  java.lang.String getCommonPath()
          Returns a parent path that is common for all nodes to modify.
 java.lang.String getName()
          Returns the nice name for the change.
 java.lang.String getXmlFilename()
          Returns the affected xml configuration file name.
protected  java.util.List getXPathsToUpdate()
          Returns a list of xpaths for the nodes to add/update.
 
Methods inherited from class org.opencms.setup.xml.A_CmsSetupXmlUpdate
execute, getCodeToChange, getXPathsToRemove, prepareDoc, updateDoc, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsXmlAddImgGalleryParam

public CmsXmlAddImgGalleryParam()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: I_CmsSetupXmlUpdate
Returns the nice name for the change.

Returns:
the nice name
See Also:
I_CmsSetupXmlUpdate.getName()

getXmlFilename

public java.lang.String getXmlFilename()
Description copied from interface: I_CmsSetupXmlUpdate
Returns the affected xml configuration file name.

Returns:
the xml file name
See Also:
I_CmsSetupXmlUpdate.getXmlFilename()

executeUpdate

protected boolean executeUpdate(org.dom4j.Document document,
                                java.lang.String xpath)
Description copied from class: A_CmsSetupXmlUpdate
Executes the adding/updating changes on the given document.

Only needs to be overriden if A_CmsSetupXmlUpdate.getXPathsToUpdate() is not empty.

Overrides:
executeUpdate in class A_CmsSetupXmlUpdate
Parameters:
document - the document to apply the changes to
xpath - the xpath to execute the changes for
Returns:
if something was modified
See Also:
A_CmsSetupXmlUpdate.executeUpdate(org.dom4j.Document, java.lang.String)

getCommonPath

protected java.lang.String getCommonPath()
Description copied from class: A_CmsSetupXmlUpdate
Returns a parent path that is common for all nodes to modify.

Overrides:
getCommonPath in class A_CmsSetupXmlUpdate
Returns:
common parent path
See Also:
A_CmsSetupXmlUpdate.getCommonPath()

getXPathsToUpdate

protected java.util.List getXPathsToUpdate()
Description copied from class: A_CmsSetupXmlUpdate
Returns a list of xpaths for the nodes to add/update.

Overrides:
getXPathsToUpdate in class A_CmsSetupXmlUpdate
Returns:
a list of strings
See Also:
A_CmsSetupXmlUpdate.getXPathsToUpdate()