Application: gvSIG desktop » gvSIG data providers based on gdal

package org.gvsig.raster.gdal.provider;

import java.io.File;

import java.util.Arrays;

import java.util.HashSet;

import java.util.Set;

import org.apache.commons.io.FilenameUtils;

import org.gdal.gdal.Driver;

import org.gdal.gdal.gdal;

import org.gdal.gdalconst.gdalconstConstants;

import org.gvsig.fmap.dal.serverexplorer.filesystem.impl.AbstractFilesystemServerExplorerProviderFactory;

import org.gvsig.fmap.dal.serverexplorer.filesystem.spi.FilesystemServerExplorerProvider;

import org.gvsig.fmap.dal.serverexplorer.filesystem.spi.FilesystemServerExplorerProviderFactory;

/**

 * Factory for GDAL filesystem providers

 *

 */

public class RasterGdalFileSystemServerProviderFactory

        extends AbstractFilesystemServerExplorerProviderFactory

        implements FilesystemServerExplorerProviderFactory 

    {

    private final RasterGdalStoreProviderFactory providerFactory;

    private final String newParams;

    private Set<String> validExtensions;

    /**

     * Constructor

     * @param providerFactory

     * @param newParams Definition name of the params used to create a new store

     */

    public RasterGdalFileSystemServerProviderFactory(RasterGdalStoreProviderFactory providerFactory, String newParams){

        super(providerFactory.getName(), providerFactory.getDescription());

        this.providerFactory=providerFactory;

        this.newParams=newParams;

        init();

    }

    private void init(){

        this.validExtensions=new HashSet<>();

        String driverExtension=(String)getDriver().GetMetadata_Dict().get(gdalconstConstants.GDAL_DMD_EXTENSION);

        //At least the driver given extension is always accepted (more can be defined in its parameters)

//      GDAL_DMD_EXTENSION only returns an extension. GDAL_DMD_EXTENSIONS should be used instead in GDAL 2.0.

//      GDAL_DMD_EXTENSIONS returns a list of accepted extensions separated by a blank

//      Meanwhile, most common extensions are added defined in the xml parameters

        if (driverExtension!=null){

            validExtensions.add(driverExtension);

        }

    }

    /**

     * Adds valid extensions to be accepted by the driver ({"jpg","jpeg","jp2",...})

     * @param extensions

     */

    public void addAcceptedExtensions(String[] extensions){

        if (extensions!=null){

            for (String extension:extensions){

                validExtensions.add(extension.trim());

            }

        }

    }

    @Override

    public FilesystemServerExplorerProvider create() {

         return new RasterGdalFileSystemServerProvider(this);

    }

    @Override

    public boolean accept(File file) {

        //If the driver is in the list to be avoided, it will not be opened

        String drvName=providerFactory.getDriver().getShortName();

        if ( Arrays.asList(RasterGdalLibrary.EXCLUDED_OPEN_DRIVERS).contains(drvName) ){

            return false;

        }

        if (isAcceptedExtension(file)){

            if (!file.exists()) {

                return true;

            }

            return isAcceptedByDriver(file);

        }

        return false;

    }

    private Driver getDriver(){

        return providerFactory.getDriver();

    }

    /**

     * Return true if the File extension is accepted by the FileSystemServerProvider

     * @param file

     * @return

     */

    private boolean isAcceptedExtension(File file) {

        if (file!=null){

            String extension=FilenameUtils.getExtension(file.getName());

            if (validExtensions != null && !validExtensions.isEmpty()) {

                for (String validExtension : validExtensions) {

                    if (validExtension.equalsIgnoreCase(extension)) {

                        return true;

                    }

                }

            } else {

                return true;

            }

        }

        return false;

    }

    /**

     * Returns true if the driver can open the file

     * @param file

     * @return

     */

    private boolean isAcceptedByDriver(File file) {

        String drvName=getDriver().getShortName();

        Driver openingDriver=null;

        openingDriver = gdal.IdentifyDriver(file.getAbsolutePath());

        if (openingDriver==null){

            return false;

        }

        String openingDrvName=openingDriver.getShortName();

        return drvName.equalsIgnoreCase(openingDrvName);

    }

    @Override

    public int allowCreate() {

        //If the driver is in the list to be avoided, it will not be created

        String drvName=getDriver().getShortName();

        if ( Arrays.asList(RasterGdalLibrary.EXCLUDED_STORE_DRIVERS).contains(drvName) ){

            return NO;

        }

        String allowCreate=(String)getDriver().GetMetadata_Dict().get(gdalconstConstants.GDAL_DCAP_CREATE);

        String allowCreateCopy=(String)getDriver().GetMetadata_Dict().get(gdalconstConstants.GDAL_DCAP_CREATECOPY);

        if  ( (allowCreate!=null && allowCreate.equalsIgnoreCase("YES")) ||

              (allowCreateCopy!=null && allowCreateCopy.equalsIgnoreCase("YES")) ){

            return YES;

        }else{

            return NO;

        }

    }

    @Override

    public String getName() {

        return providerFactory.getName();

    }

    @Override

    public String getDescription() {

        return providerFactory.getDescription();

    }

//    @Override

//    public int getMode() {

//        return DataServerExplorer.MODE_RASTER;

//    }

//

//    @Override

//    public boolean isMode(int mode) {

//        return getMode()==mode;

//    }

    String getNewParamsDefinitionName(){

        return newParams;

    }

    /**

     * Store Provider factory to be used to create a new store

     * @return RasterGdalStoreProviderFactory

     */

    public RasterGdalStoreProviderFactory getProviderFactory(){

        return this.providerFactory;

    }

}