AlternativeStrokeElements.java

/**
 * OrbisGIS is a java GIS application dedicated to research in GIScience.
 * OrbisGIS is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * OrbisGIS is distributed under GPL 3 license.
 *
 * Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
 * Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
 *
 * This file is part of OrbisGIS.
 *
 * OrbisGIS 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 3 of the License, or (at your option) any later
 * version.
 *
 * OrbisGIS 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
 * OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, please consult: <http://www.orbisgis.org/>
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.orbisgis.coremap.renderer.se.stroke;

import java.util.ArrayList;
import java.util.List;
import net.opengis.se._2_0.core.AlternativeStrokeElementsType;
import net.opengis.se._2_0.core.StrokeElementType;
import org.orbisgis.coremap.renderer.se.SeExceptions.InvalidStyle;
import org.orbisgis.coremap.renderer.se.SymbolizerNode;

/**
 * {@code AlternativeStrokeElements} provides the option for the rendering system to 
 * choose from different {@code StrokeElement} definitions.</p>
 * <p>Instances of this class contains a list of {@code StrokElement} that is used
 * to provide the said options.
 * @author Maxence Laurent
 */
public class AlternativeStrokeElements extends CompoundStrokeElement {

        private List<StrokeElement> elements;

        /**
         * Buld a new, empty, {@code AlternativeStrokeElement}
         */
        public AlternativeStrokeElements() {
                elements = new ArrayList<StrokeElement>();
        }

        /**
         * Buld a new {@code AlternativeStrokeElement}, using the informations 
         * stored in the JAXB {@code AlternativeStrokeElementType}.
         * @param aset
         * @throws org.orbisgis.coremap.renderer.se.SeExceptions.InvalidStyle
         */
        public AlternativeStrokeElements(AlternativeStrokeElementsType aset) throws InvalidStyle {
                this();
                for (StrokeElementType se : aset.getStrokeElement()) {
                        StrokeElement strokeElement = new StrokeElement(se);
                        strokeElement.setParent(this);
                        elements.add(strokeElement);
                }
                if (elements.isEmpty()) {
                        throw new InvalidStyle("Alternative Stroke Element must, at least, contains one stroke element");
                }
        }

        @Override
        public Object getJAXBType() {
                AlternativeStrokeElementsType aset = new AlternativeStrokeElementsType();

                List<StrokeElementType> strokeElement = aset.getStrokeElement();

                for (StrokeElement elem : this.elements) {
                        strokeElement.add((StrokeElementType) elem.getJAXBType());
                }

                return aset;
        }

        @Override
        public List<SymbolizerNode> getChildren() {
                List<SymbolizerNode> ls = new ArrayList<SymbolizerNode>();
                ls.addAll(elements);
                return ls;
        }

        /**
         * Get the elements registered in this {@code AlternativeStrokeElement}.
         * @return 
         * A list of {@link StrokeElement}.
         */
        public List<StrokeElement> getElements() {
                return elements;
        }

        /**
         * Set the elements registered in this {@code AlternativeStrokeElement}.
         * @param elements 
         */
        public void setElements(ArrayList<StrokeElement> elements) {
                this.elements = elements;
        }
}