Application: gvSIG desktop » gvSIG raster

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.raster.impl;

import java.util.Collection;

import java.util.Iterator;

import java.util.List;

import java.util.Set;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataQuery;

import org.gvsig.fmap.dal.DataServerExplorer;

import org.gvsig.fmap.dal.DataSet;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreNotification;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.exception.CloneException;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.exception.OpenException;

import org.gvsig.fmap.dal.exception.ValidateDataParametersException;

import org.gvsig.fmap.dal.feature.exception.PersistenceStoreAlreadyLoadedException;

import org.gvsig.fmap.dal.impl.DefaultDataManager;

import org.gvsig.fmap.dal.raster.api.BandAttributeDescriptor;

import org.gvsig.fmap.dal.raster.api.BandDescriptor;

import org.gvsig.fmap.dal.raster.api.BandQuery;

import org.gvsig.fmap.dal.raster.api.RasterQuery;

import org.gvsig.fmap.dal.raster.api.RasterSet;

import org.gvsig.fmap.dal.raster.api.RasterStore;

import org.gvsig.fmap.dal.raster.api.RasterStoreNotification;

import org.gvsig.fmap.dal.raster.spi.RasterStoreProvider;

import org.gvsig.fmap.dal.raster.spi.RasterStoreProviderServices;

import org.gvsig.fmap.dal.resource.Resource;

import org.gvsig.fmap.dal.resource.spi.ResourceProvider;

import org.gvsig.fmap.dal.spi.DataStoreInitializer;

import org.gvsig.fmap.dal.spi.DataStoreProvider;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.metadata.MetadataLocator;

import org.gvsig.metadata.MetadataManager;

import org.gvsig.metadata.exceptions.MetadataException;

import org.gvsig.raster.lib.buffer.api.BandInfo;

import org.gvsig.timesupport.Interval;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.impl.AbstractDisposable;

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.dynobject.exception.DynFieldNotFoundException;

import org.gvsig.tools.dynobject.exception.DynMethodException;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.observer.impl.DelegateWeakReferencingObservable;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.visitor.Visitor;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Implements RasterStore

 * @author dmartinezizquierdo

 *

 */

public class DefaultRasterStore extends AbstractDisposable implements

DataStoreInitializer, RasterStoreProviderServices, RasterStore, Observer {

    private static final Logger LOG = LoggerFactory

        .getLogger(DefaultRasterStore.class);

    private static final String PERSISTENCE_DEFINITION_NAME = "RasterStore";

    private static final String METADATA_DEFINITION_NAME= "RasterStore";

    private DataStoreParameters parameters = null;

    private RasterStoreProvider provider = null;

    private DelegatedDynObject metadata;

    private DefaultDataManager dataManager = null;

    private DelegateWeakReferencingObservable delegateObservable =

        new DelegateWeakReferencingObservable(this);

    @Override

    public void intializePhase1(DataManager dataManager,

        DataStoreParameters parameters) throws InitializeException {

        DynObjectManager dynManager = ToolsLocator.getDynObjectManager();

        this.metadata =

            (DelegatedDynObject) dynManager.createDynObject(

                METADATA_DEFINITION_NAME, MetadataManager.METADATA_NAMESPACE);

        this.dataManager = (DefaultDataManager) dataManager;

        this.parameters = parameters;

    }

    @Override

    public void intializePhase2(DataStoreProvider provider)

        throws InitializeException {

        this.provider = (RasterStoreProvider) provider;

        try {

            provider.open();

        } catch (OpenException e) {

            throw new InitializeException("Can't open provider: ", e);

        }

        this.delegate(provider);

    }

    /**

     * Registers persistence

     */

    public static void registerPersistenceDefinition() {

        PersistenceManager manager = ToolsLocator.getPersistenceManager();

        if (manager.getDefinition(PERSISTENCE_DEFINITION_NAME) == null) {

            DynStruct definition =

                manager.addDefinition(DefaultRasterStore.class,

                    PERSISTENCE_DEFINITION_NAME, PERSISTENCE_DEFINITION_NAME

                        + " Persistent definition", null, null);

            definition.addDynFieldString("dataStoreName").setMandatory(true)

                .setPersistent(true);

            definition.addDynFieldObject("parameters")

                .setClassOfValue(DynObject.class).setMandatory(true)

                .setPersistent(true);

        }

    }

    /**

     * Registers metadata

     * @throws MetadataException

     */

    public static void registerMetadataDefinition() throws MetadataException {

        MetadataManager manager = MetadataLocator.getMetadataManager();

        if (manager.getDefinition(METADATA_DEFINITION_NAME) == null) {

            DynStruct metadataDefinition =

                manager.addDefinition(METADATA_DEFINITION_NAME, null);

            metadataDefinition.extend(manager

                .getDefinition(DataStore.METADATA_DEFINITION_NAME));

        }

    }

    /**

     * @return dataManager

     */

    public DataManager getManager() {

        return this.dataManager;

    }

    @Override

    public String getName() {

        return this.provider.getName();

    }

    @Override

    public String getFullName() {

        return this.provider.getFullName();

    }

    @Override

    public DataStoreParameters getParameters() {

        return parameters;

    }

    @Override

    public String getProviderName() {

        return this.provider.getProviderName();

    }

    @Override

    public void refresh() throws DataException {

        this.notifyChange(RasterStoreNotification.BEFORE_REFRESH);

        this.provider.refresh();

        this.notifyChange(RasterStoreNotification.AFTER_REFRESH);

    }

    @Override

    public DataSet getDataSet() throws DataException {

        return this.getRasterSet();

    }

    @Override

    public DataSet getDataSet(DataQuery dataQuery) throws DataException {

        return this.getRasterSet((RasterQuery) dataQuery);

    }

    @Override

    public void getDataSet(Observer observer) throws DataException {

        this.getRasterSet(null,observer);

    }

    @Override

    public void getDataSet(DataQuery dataQuery, Observer observer)

        throws DataException {

        this.getRasterSet((RasterQuery)dataQuery,observer);

    }

    @Override

    public RasterSet getRasterSet(RasterQuery rasterQuery) throws DataException {

        return new DefaultRasterSet(this, rasterQuery);

    }

    @Override

    public RasterSet getRasterSet() throws DataException {

        return new DefaultRasterSet(this, null);

    }

    /**

     * Adds an observer to the DataSet

     * @param observer

     * @throws DataException

     */

    public void getRasterSet(Observer observer) throws DataException {

        RasterSet set=this.getRasterSet();

        set.addObserver(observer);

    }

    /**

     * Adds an observer to the queried DataSet

     * @param rasterQuery

     * @param observer

     * @throws DataException

     */

    public void getRasterSet(RasterQuery rasterQuery, Observer observer)

        throws DataException {

        RasterSet set=this.getRasterSet(rasterQuery);

        set.addObserver(observer);

    }

    @Override

    public void accept(Visitor visitor) throws BaseException {

        RasterSet set = getRasterSet();

        try {

            set.accept(visitor);

        } finally {

            set.dispose();

        }

    }

    @Override

    public void accept(Visitor visitor, DataQuery dataQuery)

        throws BaseException {

        RasterSet set = getRasterSet((RasterQuery)dataQuery);

        try {

            set.accept(visitor);

        } finally {

            set.dispose();

        }

    }

    @Override

    public DataSet getSelection() throws DataException {

        // TODO Auto-generated method stub

        return null;

    }

    @Override

    public void setSelection(DataSet selection) throws DataException {

        // TODO Auto-generated method stub

    }

    @Override

    public DataSet createSelection() throws DataException {

        // TODO Auto-generated method stub

        return null;

    }

    @Override

    public Iterator<?> getChildren() {

        return this.provider.getChilds();

    }

    @Override

    public DataServerExplorer getExplorer()

        throws DataException, ValidateDataParametersException {

        return this.provider.getExplorer();

    }

    @Override

    public DataQuery createQuery() {

        return createRasterQuery();

    }

    @Override

    public Interval getInterval() {

        return this.provider.getInterval();

    }

    @Override

    public Collection<?> getTimes() {

        return this.provider.getTimes();

    }

    @Override

    public Collection<?> getTimes(Interval interval) {

        return this.provider.getTimes(interval);

    }

    @Override

    public void disableNotifications() {

        this.delegateObservable.disableNotifications();

    }

    @Override

    public void enableNotifications() {

        this.delegateObservable.enableNotifications();

    }

    @Override

    public void beginComplexNotification() {

        this.delegateObservable.beginComplexNotification();

    }

    @Override

    public void endComplexNotification() {

        this.delegateObservable.endComplexNotification();

    }

    @Override

    public void addObserver(Observer observer) {

        if (delegateObservable != null) {

            this.delegateObservable.addObserver(observer);

        }

    }

    @Override

    public void deleteObserver(Observer observer) {

        if (delegateObservable != null) {

            this.delegateObservable.deleteObserver(observer);

        }

    }

    @Override

    public void deleteObservers() {

        this.delegateObservable.deleteObservers();

    }

    @Override

    public void saveToState(PersistentState state) throws PersistenceException {

        state.set("dataStoreName", this.getName());

        state.set("parameters", this.parameters);

    }

    @Override

    public void loadFromState(PersistentState state)

        throws PersistenceException {

        if (this.provider != null) {

            throw new PersistenceStoreAlreadyLoadedException(this.getName());

        }

        if (this.getManager() == null) {

            this.dataManager = (DefaultDataManager) DALLocator.getDataManager();

        }

        DataStoreParameters params =

            (DataStoreParameters) state.get("parameters");

        try {

            this.dataManager.intializeDataStore(this, params);

        } catch (InitializeException e) {

            throw new PersistenceException(e);

        } catch (DataException e) {

            throw new PersistenceException(e);

        }

    }

    //

    // ====================================================================

    // Metadata related methods

    //

    @Override

    public Set<?> getMetadataChildren() throws MetadataException {

        // TODO Auto-generated method stub

        return null;

    }

    @Override

    public Object getMetadataID() throws MetadataException {

        return this.provider.getSourceId();

    }

    @Override

    public String getMetadataName() throws MetadataException {

        return this.provider.getProviderName();

    }

    @Override

    public DynClass getDynClass() {

        return this.metadata.getDynClass();

    }

    @Override

    public void implement(DynClass dynClass) {

        this.metadata.implement(dynClass);

    }

    @Override

    public void delegate(DynObject dynObject) {

        this.metadata.delegate(dynObject);

    }

    @Override

    public Object getDynValue(String name) throws DynFieldNotFoundException {

        if (this.metadata.hasDynValue(name)) {

            return this.metadata.getDynValue(name);

        }

        if (METADATA_PROVIDER.equalsIgnoreCase(name)) {

            return this.provider.getProviderName();

        } else if (METADATA_CONTAINERNAME.equalsIgnoreCase(name)) {

            return this.provider.getSourceId();

        }

        return this.metadata.getDynValue(name);

    }

    @Override

    public void setDynValue(String name, Object value)

        throws DynFieldNotFoundException {

        this.metadata.setDynValue(name, value);

    }

    @Override

    public boolean hasDynValue(String name) {

        return this.metadata.hasDynValue(name);

    }

    @Override

    public Object invokeDynMethod(String name, Object[] args)

        throws DynMethodException {

        return this.metadata.invokeDynMethod(this, name, args);

    }

    @Override

    public Object invokeDynMethod(int code, Object[] args)

        throws DynMethodException {

        return this.metadata.invokeDynMethod(this, code, args);

    }

    @Override

    public void clear() {

        if (metadata != null) {

            metadata.clear();

        }

    }

    @Override

    public RasterQuery createRasterQuery() {

        return new DefaultRasterQuery();

    }

    @Override

    public DataStore getStore() {

        return this;

    }

    @Override

    public void update(Observable observable, Object notification) {

        if (observable instanceof DataSet) {

            this.notifyChange(RasterStoreNotification.DATASET_CHANGED);

        } else{

            if (observable instanceof RasterStoreProvider) {

                if (observable == this.provider) {

                    this.notifyChange(RasterStoreNotification.STORE_PROVIDER_CHANGED);

                }

            }

        }

    }

    @Override

    protected void doDispose() throws BaseException {

        this.notifyChange(DataStoreNotification.BEFORE_DISPOSE);

        this.provider.dispose();

        this.parameters = null;

        this.notifyChange(DataStoreNotification.AFTER_DISPOSE);

        if (delegateObservable != null) {

            this.delegateObservable.deleteObservers();

            this.delegateObservable = null;

        }

    }

    @Override

    public Object clone() throws CloneNotSupportedException{

        DataStoreParameters dsp = getParameters();

        DefaultRasterStore cloned_store = null;

        try {

            cloned_store = (DefaultRasterStore) DALLocator.getDataManager().

                openStore(this.getProviderName(), dsp);

        } catch (Exception e) {

            throw new CloneException(e);

        }

        return cloned_store;

    }

    /**

     * Notifies change

     * @param notification

     */

    public void notifyChange(String notification) {

        if (delegateObservable != null) {

            notifyChange(new DefaultRasterStoreNotification(this, notification));

        }

    }

    @Override

    public void notifyChange(String notification, ResourceProvider data) {

        notifyChange(new DefaultRasterStoreNotification(this,

            DataStoreNotification.RESOURCE_CHANGED));

    }

    /**

     * Notifies change

     * @param storeNotification

     */

    public void notifyChange(DefaultRasterStoreNotification storeNotification) {

        delegateObservable.notifyObservers(storeNotification);

    }

    /**

     * Gets this provider

     * @return RasterStoreProvider

     */

    public RasterStoreProvider getProvider(){

        return this.provider;

    }

    @Override

    public Envelope getEnvelope() throws DataException {

        return this.getRasterSet().getEnvelope();

    }

    @Override

    public BandInfo getBandInfo(int band) {

        return this.provider.getBandInfo(band);

    }

    @Override

    public BandDescriptor getBandDescriptor(int band) {

        return this.provider.getBandDescriptor(band);

    }

    @Override

    public BandQuery createBandQuery(int band) {

        return new DefaultBandQuery(band, getBandDescriptor(band));

    }

    @Override

    public int getBands() {

        return this.provider.getBands();

    }

    @Override

    public BandDescriptor createBandDescriptor(int band, List<BandAttributeDescriptor> attributes) {

        return new DefaultBandDescriptor(band, attributes);

    }

    @Override

    public BandAttributeDescriptor createBandAttributeDescriptor(int band, String name,

        String description, List<Object> values, String units) {

        return new DefaultBandAttributeDescriptor(band, name, description, values, units);

    }

    @Override

    public BandAttributeDescriptor createBandAttributeDescriptor(int band, String name, String description,

        List<Object> values) {

        return new DefaultBandAttributeDescriptor(band, name, description, values);

    }

    @Override

    public void notifyChange(String notification, Resource resource) {

        notifyChange(new DefaultRasterStoreNotification(this,

            DataStoreNotification.RESOURCE_CHANGED));

    }

    @Override

    public RasterStore getRasterStore() {

        return this;

    }

}