AbstractFolderTreeNode.java

/**
 * geo-platform
 * Rich webgis framework
 * http://geo-platform.org
 * ====================================================================
 * <p>
 * Copyright (C) 2008-2017 geoSDI Group (CNR IMAA - Potenza - ITALY).
 * <p>
 * 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 3 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, see http://www.gnu.org/licenses/
 * <p>
 * ====================================================================
 * <p>
 * Linking this library statically or dynamically with other modules is
 * making a combined work based on this library. Thus, the terms and
 * conditions of the GNU General Public License cover the whole combination.
 * <p>
 * As a special exception, the copyright holders of this library give you permission
 * to link this library with independent modules to produce an executable, regardless
 * of the license terms of these independent modules, and to copy and distribute
 * the resulting executable under terms of your choice, provided that you also meet,
 * for each linked independent module, the terms and conditions of the license of
 * that module. An independent module is a module which is not derived from or
 * based on this library. If you modify this library, you may extend this exception
 * to your version of the library, but you are not obligated to do so. If you do not
 * wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.gui.model.tree;

import com.extjs.gxt.ui.client.data.ModelData;
import com.google.common.collect.Maps;
import org.geosdi.geoplatform.gui.configuration.composite.GPTreeCompositeType;
import org.geosdi.geoplatform.gui.configuration.map.client.layer.GPFolderClientInfo;
import org.geosdi.geoplatform.gui.configuration.map.client.layer.IGPFolderElements;
import org.geosdi.geoplatform.gui.model.GPLayerBean;
import org.geosdi.geoplatform.gui.model.tree.visitor.IVisitor;
import org.geosdi.geoplatform.gui.observable.Observable;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

public abstract class AbstractFolderTreeNode extends GPBeanTreeModel
        implements GPCompositeTreeModelConverter<IGPFolderElements> {

    private static final long serialVersionUID = 4886440607031207404L;
    //
    private ObservableFolderTreeNode observable = new ObservableFolderTreeNode();
    protected int numberOfDescendants = 0;
    private boolean loaded = Boolean.FALSE;

    public enum GPFolderKeyValue {

        LABEL("label");
        //
        private String value;

        GPFolderKeyValue(String theValue) {
            this.value = theValue;
        }

        @Override
        public String toString() {
            return this.value;
        }
    }

    protected AbstractFolderTreeNode() {
    }

    protected AbstractFolderTreeNode(GPFolderClientInfo folder) {
        super(folder.getId(), folder.getLabel(), folder.getzIndex(),
                folder.isChecked());
    }

    @Override
    public void accept(IVisitor visitor) {
        visitor.visitFolder(this);
    }

    @Override
    public void setLabel(String label) {
        super.setLabel(label);
        super.set(GPFolderKeyValue.LABEL.toString(), label);
    }

    @Override
    public GPTreeCompositeType getTreeCompositeType() {
        return GPTreeCompositeType.COMPOSITE;
    }

    /**
     * @return the number of childrens
     */
    public int getNumberOfDescendants() {
        return numberOfDescendants;
    }

    /**
     * @param numberOfChildrens the numberOfChildrens to set
     */
    public void setNumberOfDescendants(int numberOfChildrens) {
        this.numberOfDescendants = numberOfChildrens;
    }

    /**
     * @return the loaded
     */
    public boolean isLoaded() {
        return loaded;
    }

    /**
     * @param loaded the loaded to set
     */
    public void setLoaded(boolean loaded) {
        this.loaded = loaded;
    }

    /**
     * The Folder Child as a Map
     *
     * @return Map<String, GPLayerBean>
     */
    public Map<String, GPLayerBean> getLayers() {
        Map<String, GPLayerBean> childMap = Maps.newHashMap();

        List<ModelData> childList = super.getChildren();

        for (Iterator<ModelData> it = childList.iterator(); it.hasNext(); ) {
            ModelData model = it.next();

            if (model instanceof GPLayerBean) {
                childMap.put(((GPLayerBean) model).getLabel(),
                        (GPLayerBean) model);
            }
        }

        return childMap;
    }

    @Override
    public void setId(Long id) {
        super.setId(id);
        observable.setChanged();
        observable.notifyObservers(id);
    }

    public ObservableFolderTreeNode getObservable() {
        return observable;
    }

    public void setObservable(ObservableFolderTreeNode observable) {
        this.observable = observable;
    }

    /**
     * @return {@link Boolean}
     */
    public abstract boolean isExpanded();

    public class ObservableFolderTreeNode extends Observable {

        @Override
        protected synchronized void setChanged() {
            super.setChanged();
        }
    }
}