it.geosolutions.geoserver.rest.encoder.utils.XmlElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geoserver-manager Show documentation
GeoServer Manager is a library to interact with GeoServer The scope of this library is to have a simple API, and use as few external libs as possible.
There is a newer version: 1.8.7
Show newest version
/*
 *  GeoServer-Manager - Simple Manager Library for GeoServer
 *  
 *  Copyright (C) 2007,2011 GeoSolutions S.A.S.
 *  http://www.geo-solutions.it
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package it.geosolutions.geoserver.rest.encoder.utils;


import org.jdom.Content;
import org.jdom.Element;
import org.jdom.Text;
import org.jdom.output.Format;
import org.jdom.output.XMLOutputter;

/**
 * XmlElement class.
 *
 * @author Carlo Cancellieri - [email protected]
 * @version $Id: $
 */
public class XmlElement{
	
	private Element root;
	

    private static final long serialVersionUID = 1L;
	
    //RAW format so that newlines are preserved!
        private final static XMLOutputter OUTPUTTER = new XMLOutputter(Format.getRawFormat());
        
	/**
	 * Constructor for XmlElement.
	 *
	 * @param name a {@link java.lang.String} object.
	 */
	public XmlElement(final String name){
		root=new Element(name);
	}

    /**
     * Constructor for XmlElement.
     *
     * @param e a {@link org.jdom.Element} object.
     */
    public XmlElement(final Element e) {
        root = e;
    }
    
    /**
     * Empty constructor:
     * Use {@link #setRoot(String)} or {@link #setRoot(Element)} to initialize the root
     */
    protected XmlElement() {
    }

    /**
     * update the root of this node
     *
     * @param root a {@link org.jdom.Element} object.
     */
    protected void setRoot(final Element root) {
        this.root = root;
    }
    
    /**
     * update the root of this node
     *
     * @param name is the name of the root node
     */
    protected void setRoot(final String name){
        root=new Element(name);
    }

	/**
	 * Getter for the field root.
	 *
	 * @return a {@link org.jdom.Element} object.
	 */
	public Element getRoot(){
		return root;
	}
	
	/**
	 * add
	 *
	 * @param nodename a {@link java.lang.String} object.
	 * @param nodetext a {@link java.lang.String} object.
	 */
	protected void add(final String nodename, final String nodetext) {
    	add(nodename,new Text(nodetext));
    }
	
	/**
	 * add
	 *
	 * @param nodename a {@link java.lang.String} object.
	 * @param nodetext a {@link org.jdom.Content} object.
	 */
	protected void add(final String nodename, final Content nodetext) {
    	final Element el=new Element(nodename);
    	el.setContent(nodetext);
    	this.addContent(el);
    }
    
	/**
	 * set
	 *
	 * @param nodename a {@link java.lang.String} object.
	 * @param nodetext a {@link java.lang.String} object.
	 */
	protected void set(final String nodename, final String nodetext) {
    	set(nodename,new Text(nodetext));
    }
	
	/**
	 * set
	 *
	 * @param nodename a {@link java.lang.String} object.
	 * @param nodeContent a {@link org.jdom.Content} object.
	 */
	protected void set(final String nodename, final Content nodeContent) {
    	final Element el=ElementUtils.contains(getRoot(),nodename);
    	if (el==null){
    		add(nodename,nodeContent);
    	}
    	else {
    		el.setContent(nodeContent);
    	}
    }
    
	/**
	 * addContent
	 *
	 * @param child a {@link org.jdom.Content} object.
	 * @return a {@link org.jdom.Element} object.
	 */
	protected Element addContent(Content child){
		return root.addContent(child);
	}
	
	/**
	 * isEmpty
	 *
	 * @return a boolean.
	 */
	public boolean isEmpty() {
        return root.getChildren().isEmpty();
    }
	
	/**
	 * remove
	 *
	 * @param key a {@link java.lang.String} object.
	 * @return a boolean.
	 */
	public boolean remove(final String key){
		final Element el=ElementUtils.contains(root,key);
		if (el!=null){
			return ElementUtils.remove(root,el);
		}
		else
			return false;
	}
	
    /** {@inheritDoc} */
    @Override
    public String toString() {
		return OUTPUTTER.outputString(root);
    }
}