VectorDataLayerType.java

/*
 * Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
 *
 * 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/
 */

package org.esa.snap.ui.product;

import com.bc.ceres.binding.Property;
import com.bc.ceres.binding.PropertyContainer;
import com.bc.ceres.binding.PropertySet;
import com.bc.ceres.core.Assert;
import com.bc.ceres.glayer.Layer;
import com.bc.ceres.glayer.LayerContext;
import com.bc.ceres.glayer.LayerType;
import com.bc.ceres.glayer.LayerTypeRegistry;
import com.bc.ceres.glayer.annotations.LayerTypeMetadata;
import org.esa.snap.core.datamodel.ProductNode;
import org.esa.snap.core.datamodel.RasterDataNode;
import org.esa.snap.core.datamodel.VectorDataNode;
import org.esa.snap.core.layer.ProductLayerContext;

/**
 * A {@link LayerType} that creates layers of type {@link VectorDataLayer} for a given {@code VectorDataNode}.
 *
 * @author Marco Peters
 * @author Norman Fomferra
 * @author Ralf Quast
 * @since BEAM 4.7
 */
@LayerTypeMetadata(name = "VectorDataLayerType",
        aliasNames = {"VectorDataLayerType"})
public class VectorDataLayerType extends LayerType {

    public static final String PROPERTY_NAME_VECTOR_DATA = "vectorData";
    public static final String VECTOR_DATA_LAYER_ID_PREFIX = "org.esa.snap.layers.vectorData";

    public static VectorDataLayer createLayer(LayerContext ctx, VectorDataNode vectorDataNode) {
        Assert.notNull(ctx, "ctx");
        final ProductLayerContext plc = (ProductLayerContext) ctx;
        final VectorDataLayerType specialLayerType = vectorDataNode.getExtension(VectorDataLayerType.class);
        final VectorDataLayer layer;
        if (specialLayerType != null) {
            layer = specialLayerType.createLayerInternal(plc, vectorDataNode);
        } else {
            final VectorDataLayerType fallbackLayerType = LayerTypeRegistry.getLayerType(VectorDataLayerType.class);
            if (fallbackLayerType == null) {
                throw new IllegalStateException("fallbackLayerType == null (missing default VectorDataLayerType)");
            }
            layer = fallbackLayerType.createLayerInternal(plc, vectorDataNode);
        }
        return layer;
    }

    @Override
    public boolean isValidFor(LayerContext ctx) {
        return ctx instanceof ProductLayerContext;
    }

    @Override
    public Layer createLayer(LayerContext ctx, PropertySet configuration) {
        Assert.notNull(ctx, "ctx");
        final ProductLayerContext plc = (ProductLayerContext) ctx;
        final String vectorDataName = (String) configuration.getValue(PROPERTY_NAME_VECTOR_DATA);
        final VectorDataNode vectorDataNode = plc.getProduct().getVectorDataGroup().get(vectorDataName);
        Assert.notNull(vectorDataNode, String.format("VectorDataNode '%s' does not exist", vectorDataName));
        final ProductNode productNode = plc.getProductNode();
        assert(productNode instanceof RasterDataNode);
        return createLayer(vectorDataNode, (RasterDataNode) productNode, configuration);
    }

    @Override
    public PropertySet createLayerConfig(LayerContext ctx) {
        return createLayerConfig();
    }

    public static PropertySet createLayerConfig() {
        final PropertyContainer configuration = new PropertyContainer();
        configuration.addProperty(Property.create(VectorDataLayerType.PROPERTY_NAME_VECTOR_DATA, String.class));
        return configuration;
    }

    protected VectorDataLayer createLayer(VectorDataNode vectorDataNode, RasterDataNode rasterDataNode, PropertySet configuration) {
        return new VectorDataLayer(this, vectorDataNode, rasterDataNode, configuration);
    }

    private VectorDataLayer createLayerInternal(ProductLayerContext ctx, VectorDataNode vectorDataNode) {
        final PropertySet configuration = createLayerConfig(ctx);
        // Save the name of the vectorDataNode, so that we can reconstruct the layer later (e.g. if loaded from session file).
        configuration.setValue(PROPERTY_NAME_VECTOR_DATA, vectorDataNode.getName());
        final ProductNode productNode = ctx.getProductNode();
        assert(productNode instanceof RasterDataNode);
        return createLayer(vectorDataNode, (RasterDataNode) productNode, configuration);
    }

}