/*
$Id: DeleteNodeTask.java,v 1.2 2003/08/12 10:06:41 egli Exp $
<License>
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Lenya" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Michael Wechner <michi@apache.org>. For more information on the Apache Soft-
ware Foundation, please see <http://www.apache.org/>.
Lenya includes software developed by the Apache Software Foundation, W3C,
DOM4J Project, BitfluxEditor, Xopus, and WebSHPINX.
</License>
*/
package org.apache.lenya.cms.ant;
import org.apache.lenya.cms.publication.DefaultSiteTree;
import org.apache.lenya.cms.publication.SiteTreeException;
import org.apache.lenya.cms.publication.SiteTreeNode;
import org.apache.tools.ant.BuildException;
/**
* Ant task to delete a node of a tree.
* @author edith
*/
public class DeleteNodeTask extends PublicationTask {
private String area;
private String documentid;
/**
* Creates a new instance of DeleteNodeTask
*/
public DeleteNodeTask() {
super();
}
/**
* Get the area.
*
* @return the area.
*/
public String getArea() {
return area;
}
/**
* Set the area.
*
* @param area the area
*/
public void setArea(String area) {
this.area = area;
}
/**
* return the document-id corresponding to the node to delete
* @return string The document-id.
*/
protected String getDocumentid() {
return documentid;
}
/**
* Set the value of the document-id corresponding to the node to delete
*
* @param string The document-id.
*/
public void setDocumentid(String string) {
documentid = string;
}
/**
* Delete a node of a tree.
*
* @param documentid The id of the document corresponding to the node to delete.
* @param area the areaof the tree
*
* @throws SiteTreeException if an error occurs
*/
public void deleteNode(String documentid, String area)
throws SiteTreeException {
DefaultSiteTree tree = null;
try {
tree = getPublication().getSiteTree(area);
SiteTreeNode node = tree.removeNode(documentid);
if (node == null) {
throw new SiteTreeException("Node " + node + " couldn't be removed");
}
tree.save();
} catch (Exception e) {
throw new SiteTreeException(e);
}
}
/** (non-Javadoc)
* @see org.apache.tools.ant.Task#execute()
*/
public void execute() throws BuildException {
try {
log("document-id corresponding to the node: " + getDocumentid());
log("area: " + getArea());
deleteNode(getDocumentid(), getArea());
} catch (Exception e) {
throw new BuildException(e);
}
}
}