teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5994:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5994:  * documentation coming with Dive4Elements River for details.
teichmann@5863:  */
teichmann@5863: 
teichmann@5831: package org.dive4elements.river.themes;
ingo@340: 
ingo@340: import java.util.HashMap;
ingo@340: import java.util.Map;
ingo@340: 
gernotbelger@9555: import org.dive4elements.artifacts.common.utils.XMLUtils;
gernotbelger@9555: import org.dive4elements.artifacts.common.utils.XMLUtils.ElementCreator;
ingo@340: import org.w3c.dom.Document;
ingo@340: import org.w3c.dom.Element;
ingo@340: import org.w3c.dom.Node;
ingo@340: 
ingo@340: 
ingo@340: /**
ingo@340:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@340:  */
gernotbelger@9555: final class DefaultTheme implements Theme {
ingo@340: 
ingo@340:     /** The name of the theme.*/
gernotbelger@9555:     private final String name;
ingo@340: 
gernotbelger@9555:     private String facet;
ingo@340: 
gernotbelger@9555:     private int index;
ingo@340: 
ingo@340:     /** The map storing the fields of this theme.*/
gernotbelger@9555:     private final Map<String, ThemeField> fields;
ingo@340: 
ingo@340:     /** The map storing the attributes of this theme.*/
gernotbelger@9555:     private final Map<String, String> attr;
ingo@340: 
gernotbelger@9555:     private final String description;
ingo@340: 
ingo@340:     /**
ingo@340:      * Initializes the components of this Theme.
ingo@340:      */
gernotbelger@9555:     public DefaultTheme(final String name, final String description) {
ingo@340:         this.name        = name;
ingo@340:         this.description = description;
gernotbelger@9555:         this.fields      = new HashMap<>();
gernotbelger@9555:         this.attr        = new HashMap<>();
ingo@340:     }
ingo@340: 
gernotbelger@9555:     @Override
ingo@340:     public String getName() {
gernotbelger@9555:         return this.name;
ingo@340:     }
ingo@340: 
ingo@340:     public String getDescription() {
gernotbelger@9555:         return this.description;
ingo@340:     }
ingo@340: 
gernotbelger@9555:     @Override
gernotbelger@9555:     public void setFacet(final String facet) {
ingo@1668:         this.facet = facet;
ingo@1668:     }
ingo@1668: 
gernotbelger@9555:     @Override
gernotbelger@9555:     public void setIndex(final int index) {
ingo@1668:         this.index = index;
ingo@1668:     }
ingo@1668: 
gernotbelger@9555:     public void addAttribute(final String name, final String value) {
ingo@340:         if (name != null && value != null) {
gernotbelger@9555:             this.attr.put(name, value);
ingo@340:         }
ingo@340:     }
ingo@340: 
gernotbelger@9555:     public void addField(final String name, final ThemeField field) {
ingo@340:         if (name != null && field != null) {
gernotbelger@9555:             this.fields.put(name, field);
ingo@340:         }
ingo@340:     }
ingo@340: 
gernotbelger@9555:     @Override
gernotbelger@9555:     public Document toXML() {
gernotbelger@9555:         final Document doc = XMLUtils.newDocument();
ingo@340: 
gernotbelger@9555:         final ElementCreator cr = new ElementCreator(doc, null, null);
ingo@340: 
gernotbelger@9555:         final Element theme = cr.create("theme");
gernotbelger@9555:         theme.setAttribute("facet", this.facet);
gernotbelger@9555:         theme.setAttribute("index", String.valueOf(this.index));
ingo@340: 
ingo@340:         appendAttributes(cr, theme);
ingo@340:         appendFields(cr, theme);
ingo@340: 
ingo@340:         doc.appendChild(theme);
ingo@340: 
ingo@340:         return doc;
ingo@340:     }
ingo@340: 
ingo@340: 
ingo@340:     /**
ingo@340:      * Appends the attributes configured for this theme.
ingo@340:      *
ingo@340:      * @param cr The ElementCreator.
ingo@340:      * @param theme The document root element.
ingo@340:      */
gernotbelger@9555:     protected void appendAttributes(final ElementCreator cr, final Element theme) {
ingo@340: 
gernotbelger@9555:         for (final Map.Entry<String, String> entry: this.attr.entrySet()) {
gernotbelger@9555:             final String key = entry.getKey();
gernotbelger@9555:             final String val = entry.getValue();
ingo@340: 
sascha@3732:             if (key != null && val != null) {
sascha@3732:                 cr.addAttr(theme, key, val);
ingo@340:             }
ingo@340:         }
ingo@340:     }
ingo@340: 
ingo@340: 
ingo@340:     /**
ingo@340:      * Appends the fields configured for this theme.
ingo@340:      *
ingo@340:      * @param cr The ElementCreator.
ingo@340:      * @param theme The document root element.
ingo@340:      */
gernotbelger@9555:     protected void appendFields(final ElementCreator cr, final Element theme) {
ingo@340: 
gernotbelger@9555:         for (final ThemeField field: this.fields.values()) {
gernotbelger@9555:             final Document doc = field.toXML();
gernotbelger@9555:             final Node    root = doc.getFirstChild();
ingo@340: 
ingo@340:             theme.appendChild(theme.getOwnerDocument().importNode(root, true));
ingo@340:         }
ingo@340:     }
gernotbelger@9555: }