Application: gvSIG desktop

/* 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.spi;

import java.awt.Image;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Iterator;

import java.util.List;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataStoreParameters;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.timesupport.Interval;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.dispose.DisposeUtils;

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.DynObject_v2;

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

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

import org.gvsig.tools.exception.BaseException;

/**

 * Class to be extended by the providers to be implemented

 * @author dmartinezizquierdo

 *

 */

public abstract class AbstractRasterStoreProvider extends AbstractDisposable implements RasterStoreProvider{

    protected static final Logger LOG =

        LoggerFactory.getLogger(AbstractRasterStoreProvider.class);

    private RasterStoreProviderServices store;

    private DelegatedDynObject metadata;

    private DataStoreParameters parameters;

    private ArrayList<BandDescriptor> bandDescriptors;

    protected BufferDimensions dimensions;

    protected AbstractRasterStoreProvider(DataStoreParameters params,

        DataStoreProviderServices storeServices, DynObject metadata) {

        this.store=(RasterStoreProviderServices)storeServices;

        this.metadata=(DelegatedDynObject)metadata;

        this.parameters=params;

    }

    /**

     * @return the parameters

     */

    public DataStoreParameters getParameters() {

        return parameters;

    }

    /**

     * Create or get a resource of <code>type</code> for <code>params</code> in

     * {@link ResourceManager}

     *

     * @param type

     * @param params

     * @return

     * @throws InitializeException

     */

    protected ResourceProvider createResource(String type, Object[] params)

            throws InitializeException {

        ResourceManagerProviderServices manager = (ResourceManagerProviderServices) DALLocator

                .getResourceManager();

        ResourceProvider resource = manager.createAddResource(type, params);

        return resource;

    }

    /**

     * unsupported by default (return null), override this otherwise

     *

     * @see org.gvsig.fmap.dal.spi.DataStoreProvider#getChilds()

     */

    public Iterator<?> getChilds() {

        return null;

    }

    /**

     * (non-Javadoc)

     * @return RasterStoreProviderServices

     *

     * @see

     * org.gvsig.fmap.dal.feature.spi.RasterStoreProvider#getStoreServices()

     */

    public RasterStoreProviderServices getStoreServices() {

        return this.store;

    }

    /**

     * do nothing by default, override this otherwise

     *

     * @see org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider#close()

     */

    public void close() throws CloseException {

        // Do nothing by default

    }

    /**

     * do nothing by default, override this otherwise

     *

     * @see org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider#refresh()

     */

    public void refresh() throws OpenException {

        // Do nothing by default

    }

    public Interval getInterval() {

        // Do nothing

        return null;

    }

    public Collection<?> getTimes() {

        // Do nothing

        return null;

    }

    public Collection<?> getTimes(Interval interval) {

        // Do nothing

        return null;

    }

    // --- Metadata methods ---

    public void delegate(DynObject dynObject) {

        if (this.metadata == null) {

            return;

        }

        this.metadata.delegate(dynObject);

    }

    public DynClass getDynClass() {

        if (this.metadata == null) {

            return null;

        }

        return this.metadata.getDynClass();

    }

    public void implement(DynClass dynClass) {

        if (this.metadata == null) {

            return;

        }

        this.metadata.implement(dynClass);

    }

    public Object getDynValue(String name) throws DynFieldNotFoundException {

        if (this.metadata == null) {

            return null;

        }

        // TODO this.open??

        return this.metadata.getDynValue(name);

    }

    public void setDynValue(String name, Object value)

        throws DynFieldNotFoundException {

        if (this.metadata == null) {

            return;

        }

        // TODO this.open??

        this.metadata.setDynValue(name, value);

    }

    public boolean hasDynValue(String name) {

        if (this.metadata == null) {

            return false;

        }

        // TODO this.open??

        return this.metadata.hasDynValue(name);

    }

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

        throws DynMethodException {

        if (this.metadata == null) {

            return null;

        }

        // TODO this.open??

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

    }

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

            throws DynMethodException {

        if (this.metadata == null) {

            return null;

        }

        // TODO this.open??

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

    }

    public void clear() {

        if (metadata != null) {

            metadata.clear();

        }

    }

    protected void doDispose() throws BaseException {

        LOG.debug("Dispose AbstractRasterStoreProvider '"+this.getFullName()+"'");

        this.metadata = null;

        this.parameters = null;

        if (bandDescriptors != null) {

            for (Iterator iterator = bandDescriptors.iterator(); iterator.hasNext();) {

                BandDescriptor bandDescriptor = (BandDescriptor) iterator.next();

                DisposeUtils.dispose(bandDescriptor);

                iterator.remove();

            }

            this.bandDescriptors = null;

        }

    }

    @Override

    public TileStruct getTileStruct() {

        //Subclasses should implement this method

        throw new UnsupportedOperationException();

    }

    protected void autoOpen(){

        try {

            open();

        } catch (Exception e) {

            throw new RuntimeException(e);

        }

    }

    @Override

    public Image getImageLegend() {

        return null;

    }

    /**

     * @return

     */

    public List<BandDescriptor> getBandsDescriptor() {

        if(bandDescriptors==null){

            bandDescriptors = new ArrayList<BandDescriptor>();

        }

        if(bandDescriptors.isEmpty()){

            for (int i = 0; i < this.getBands(); i++) {

                bandDescriptors.add(getStoreServices().createBandDescriptor(i,

                    new ArrayList<BandAttributeDescriptor>()));

            }

        }

        return this.bandDescriptors;

    }

    @Override

    public BandDescriptorServices getBandDescriptor(int band) {

        if(band > this.getBands()){

            throw new IllegalArgumentException("Invalid band");

        }

        return (BandDescriptorServices) this.getBandsDescriptor().get(band);

    }

    public NoData getNoData(RasterQuery rasterQuery, int band){

        List<BandQuery> bands = rasterQuery.getBands();

        for (BandQuery bandQuery : bands) {

            if(bandQuery.getDescriptor().getBand()==band){

                NoData noData = bandQuery.getDescriptor().getNoData();

                if(noData == null) {

                    break;

                }

                return noData;

            }

        }

        return this.getBandDescriptor(band).getNoData();

    }

    public NoData[] getNoDatas(){

        NoData[] noDatas = new NoData[this.getBands()];

        for (int i = 0; i < this.getBands(); i++) {

            noDatas[i] = this.getBandDescriptor(i).getNoData();

        }

        return noDatas;

    }

    public int[] getDataTypes(){

        int[] dataTypes = new int[this.getBands()];

        for (int i = 0; i < this.getBands(); i++) {

            dataTypes[i] = this.getBandDescriptor(i).getDataType();

        }

        return dataTypes;

    }

    @Override

    public boolean isTiled() {

        return false;

    }

    @Override

    public boolean hasDynMethod(String name) {

        if( metadata instanceof DynObject_v2 ) {

            return ((DynObject_v2)this.metadata).hasDynMethod(name);

        }

        return false;

    }

}