ucar.nc2.ft2.simpgeometry.SimpleGeometryFeatureDataset Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.gecko.ucar.netcdf Show documentation
Re-packaged Unidata netCDF
The newest version!
package ucar.nc2.ft2.simpgeometry;

import ucar.nc2.Attribute;
import ucar.nc2.AttributeContainer;
import ucar.nc2.NetcdfFile;
import ucar.nc2.VariableSimpleIF;
import ucar.nc2.constants.CDM;
import ucar.nc2.constants.FeatureType;
import ucar.nc2.dataset.*;
import ucar.nc2.ft.FeatureDataset;
import ucar.nc2.ft2.simpgeometry.adapter.SimpleGeometryCS;
import ucar.nc2.time.CalendarDate;
import ucar.nc2.time.CalendarDateRange;
import ucar.nc2.util.cache.FileCacheIF;
import ucar.unidata.geoloc.LatLonRect;
import java.io.IOException;
import java.util.*;

public class SimpleGeometryFeatureDataset implements FeatureDataset {

  private NetcdfDataset ncd;

  /**
   * Open a netcdf dataset, using NetcdfDataset.defaultEnhanceMode plus CoordSystems
   * and turn into a SimpleGeometryFeatureDataset.
   *
   * @param location netcdf dataset to open, using NetcdfDataset.acquireDataset().
   * @return SimpleGeometryFeatureDataset
   * @throws java.io.IOException on read error
   * @see ucar.nc2.dataset.NetcdfDataset#acquireDataset
   */
  public static SimpleGeometryFeatureDataset open(String location) throws IOException {
    return open(location, NetcdfDataset.getDefaultEnhanceMode());
  }

  /**
   * Open a netcdf dataset, using NetcdfDataset.defaultEnhanceMode plus CoordSystems
   * and turn into a SimpleGeometryFeatureDataset.
   *
   * @param location netcdf dataset to open, using NetcdfDataset.acquireDataset().
   * @param enhanceMode open netcdf dataset with this enhanceMode
   * @return SimpleGeometryFeatureDataset
   * @throws java.io.IOException on read error
   * @see ucar.nc2.dataset.NetcdfDataset#acquireDataset
   */
  public static SimpleGeometryFeatureDataset open(String location, Set enhanceMode)
      throws IOException {
    NetcdfDataset ds = ucar.nc2.dataset.NetcdfDataset.acquireDataset(null, DatasetUrl.findDatasetUrl(location),
        enhanceMode, -1, null, null);
    return new SimpleGeometryFeatureDataset(ds);
  }

  /**
   * Create a SimpleGeometryFeatureDataset from a NetcdfDataset.
   *
   * @param ncd underlying NetcdfDataset, will do Enhance.CoordSystems if not already done.
   * @throws java.io.IOException on read error
   */
  public SimpleGeometryFeatureDataset(NetcdfDataset ncd) throws IOException {
    this.ncd = ncd;
    Set enhance = ncd.getEnhanceMode();
    if (enhance == null || enhance.isEmpty())
      enhance = NetcdfDataset.getDefaultEnhanceMode();
    ncd.enhance(enhance);
  }

  @Override
  public String getTitle() {
    String title = ncd.getTitle();
    if (title == null)
      title = ncd.getRootGroup().findAttributeString(CDM.TITLE, null);
    if (title == null)
      title = getName();
    return title;
  }

  @Override
  public String getDescription() {
    String desc = ncd.getRootGroup().findAttributeString(CDM.DESCRIPTION, null);
    if (desc == null)
      desc = ncd.getRootGroup().findAttributeString(CDM.HISTORY, null);
    return (desc == null) ? getName() : desc;
  }

  @Override
  public String getLocation() {
    return (ncd != null) ? ncd.getLocation() : "";
  }

  @Override
  public CalendarDateRange getCalendarDateRange() {
    return null;
  }

  @Override
  public CalendarDate getCalendarDateStart() {
    return null;
  }

  @Override
  public CalendarDate getCalendarDateEnd() {
    return null;
  }

  @Override
  public LatLonRect getBoundingBox() {
    return null;
  }

  @Override
  public AttributeContainer attributes() {
    return ncd.getRootGroup().attributes();
  }

  /** @deprecated use attributes() */
  @Deprecated
  public List getGlobalAttributes() {
    return ncd.getGlobalAttributes();
  }

  /** @deprecated use attributes() */
  @Deprecated
  public Attribute findGlobalAttributeIgnoreCase(String name) {
    return ncd.findGlobalAttributeIgnoreCase(name);
  }

  @Override
  public List getDataVariables() {
    return null;
  }


  public VariableSimpleIF getDataVariable(String shortName) {
    return ncd.getRootGroup().findVariableLocal(shortName);
  }

  public NetcdfFile getNetcdfFile() {
    return ncd;
  }

  @Override
  public void close() throws IOException {
    ncd.close();
  }

  @Override
  public long getLastModified() {
    return 0;
  }

  /** @deprecated do not use */
  @Deprecated
  @Override
  public void setFileCache(FileCacheIF fileCache) {
    ncd.setFileCache(fileCache);
  }

  @Override
  public void getDetailInfo(Formatter sf) {
    ncd.getDetailInfo(sf);
  }

  /**
   * the name of the dataset is the last part of the location
   * 
   * @return the name of the dataset
   */
  public String getName() {
    String loc = ncd.getLocation();
    int pos = loc.lastIndexOf('/');
    if (pos < 0)
      pos = loc.lastIndexOf('\\');
    return (pos < 0) ? loc : loc.substring(pos + 1);
  }

  /**
   * @return the underlying NetcdfDataset
   */
  public NetcdfDataset getNetcdfDataset() {
    return ncd;
  }

  /**
   * This is a set of GeoGrids with the same GeoCoordSys.
   */
  public static class SimpleGeometryCovSet {

    private SimpleGeometryCS gcc;
    private List covs = new ArrayList<>();


    private SimpleGeometryCovSet(SimpleGeometryCS gcc) {
      this.gcc = gcc;
    }

    private void add(SimpleGeometryFeature cov) {
      covs.add(cov);
    }

    /**
     * Get list of GeoGrid objects
     */
    public List getGrids() {
      return covs;
    }

    /**
     * all GeoGrids point to this GeoCoordSysImpl.
     *
     * @deprecated use getGeoCoordSystem() if possible.
     */
    public SimpleGeometryCS getSGCoordSys() {
      return gcc;
    }

  }

  ////////////////////////////
  // for ucar.nc2.ft.FeatureDataset

  public FeatureType getFeatureType() {
    return FeatureType.SIMPLE_GEOMETRY;
  }

  public String getImplementationName() {
    return ncd.getConventionUsed();
  }

  /** @deprecated do not use */
  @Deprecated
  public void release() throws IOException {
    if (ncd != null)
      ncd.release();
  }

  /** @deprecated do not use */
  @Deprecated
  public void reacquire() throws IOException {
    if (ncd != null)
      ncd.reacquire();
  }

}