com.mpaike.core.config.xml.elementreader.GenericElementReader.java Source code

Introduction

Here is the source code for com.mpaike.core.config.xml.elementreader.GenericElementReader.java

Source

/*
 * Copyright (C) 2009-2010 WWF Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
    
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
    
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
    
 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in WWF's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.42y.net/legal/licensing"
 */
package com.mpaike.core.config.xml.elementreader;

import java.util.Iterator;

import org.dom4j.Attribute;
import org.dom4j.Element;

import com.mpaike.core.config.ConfigElement;
import com.mpaike.core.config.element.GenericConfigElement;
import com.mpaike.core.config.xml.XMLConfigService.PropertyConfigurer;

/**
 * Implementation of a generic element reader. This class can be used to 
 * convert any config element into a GenericConfigElement.
 */
public class GenericElementReader implements ConfigElementReader {
    private PropertyConfigurer propertyConfigurer;

    /**
     * Construct
     * 
     * @param propertyConfigurer
     */
    public GenericElementReader(PropertyConfigurer propertyConfigurer) {
        this.propertyConfigurer = propertyConfigurer;
    }

    /**
     * @see com.ebizserve.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element)
     */
    public ConfigElement parse(Element element) {
        GenericConfigElement configElement = null;

        if (element != null) {
            configElement = createConfigElement(element);

            // process any children there may be
            processChildren(element, configElement);
        }

        return configElement;
    }

    /**
     * Recursively processes the children creating the required config element
     * objects as it goes
     * 
     * @param element
     * @param parentConfig
     */
    @SuppressWarnings("unchecked")
    private void processChildren(Element element, GenericConfigElement parentConfig) {
        // get the list of children for the given element
        Iterator<Element> children = element.elementIterator();
        while (children.hasNext()) {
            Element child = children.next();
            GenericConfigElement childConfigElement = createConfigElement(child);
            parentConfig.addChild(childConfigElement);

            // recurse down the children
            processChildren(child, childConfigElement);
        }
    }

    /**
     * Creates a ConfigElementImpl object from the given element.
     * 
     * @param element The element to parse
     * @return The GenericConfigElement representation of the given element
     */
    @SuppressWarnings("unchecked")
    private GenericConfigElement createConfigElement(Element element) {
        // get the name and value of the given element
        String name = element.getName();

        // create the config element object and populate with value
        // and attributes
        GenericConfigElement configElement = new GenericConfigElement(name);
        if ((element.hasContent()) && (element.hasMixedContent() == false)) {
            String value = element.getTextTrim();
            if (value != null && value.length() > 0) {
                if (propertyConfigurer != null) {
                    value = propertyConfigurer.resolveValue(value);
                }
                configElement.setValue(value);
            }
        }

        Iterator<Attribute> attrs = element.attributeIterator();
        while (attrs.hasNext()) {
            Attribute attr = attrs.next();
            String attrName = attr.getName();
            String attrValue = attr.getValue();

            if (propertyConfigurer != null) {
                attrValue = propertyConfigurer.resolveValue(attrValue);
            }

            configElement.addAttribute(attrName, attrValue);
        }

        return configElement;
    }

}