This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.ant
Class DeleteNodeTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.lenya.cms.ant.PublicationTask
              org.apache.lenya.cms.ant.DeleteNodeTask

Direct Known Subclasses:

DeleteLanguageNodeTask

public class DeleteNodeTask
extends PublicationTask

Ant task to delete a node of a tree.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

DeleteNodeTask()
Creates a new instance of DeleteNodeTask

Method Summary

void	deleteNode(java.lang.String documentid, java.lang.String area) Delete a node of a tree.
void	execute() (non-Javadoc)
java.lang.String	getArea() Get the area.
protected java.lang.String	getDocumentid() return the document-id corresponding to the node to delete
void	setArea(java.lang.String area) Set the area.
void	setDocumentid(java.lang.String string) Set the value of the document-id corresponding to the node to delete

Methods inherited from class org.apache.lenya.cms.ant.PublicationTask

assertString, getContextPrefix, getPublication, getPublicationDirectory, getPublicationId, getServletContext

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteNodeTask

public DeleteNodeTask()

Creates a new instance of DeleteNodeTask

Method Detail

getArea

public java.lang.String getArea()

Get the area.

Returns:

the area.

setArea

public void setArea(java.lang.String area)

Set the area.

Parameters:

area - the area

getDocumentid

protected java.lang.String getDocumentid()

return the document-id corresponding to the node to delete

Returns:

string The document-id.

setDocumentid

public void setDocumentid(java.lang.String string)

Set the value of the document-id corresponding to the node to delete

Parameters:

string - The document-id.

deleteNode

public void deleteNode(java.lang.String documentid,
                       java.lang.String area)
                throws SiteTreeException

Delete a node of a tree.

Parameters:

documentid - The id of the document corresponding to the node to delete.

area - the areaof the tree

Throws:

SiteTreeException - if an error occurs

execute

public void execute()
             throws org.apache.tools.ant.BuildException

(non-Javadoc)

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

See Also:

Task.execute()