ucar.nc2.ft.point.DsgCollectionImpl 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!
/*
 * Copyright (c) 1998-2018 John Caron and University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */
package ucar.nc2.ft.point;

import ucar.nc2.Variable;
import ucar.nc2.dataset.CoordinateAxis;
import ucar.nc2.ft.DsgFeatureCollection;
import ucar.nc2.time.CalendarDateRange;
import ucar.nc2.time.CalendarDateUnit;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;

/**
 * Common methods for DsgFeatureCollection.
 *
 * @author caron
 * @since 9/25/2015.
 */
public abstract class DsgCollectionImpl implements DsgFeatureCollection {

  protected String name;
  protected String timeName = "time";
  protected CalendarDateUnit timeUnit;
  protected String altName = "altitude";
  protected String altUnits;
  protected CollectionInfo info;
  protected List coordVars;
  protected List extras; // variables needed to make CF/DSG writing work

  protected DsgCollectionImpl(String name, CalendarDateUnit timeUnit, String altUnits) {
    this.name = name;
    this.timeUnit = timeUnit;
    this.altUnits = altUnits;
  }

  protected DsgCollectionImpl(String name, List coordVars) {
    this.name = name;
    this.coordVars = coordVars;

    for (CoordinateAxis coord : coordVars) {
      if (coord.getAxisType().isTime()) {
        this.timeUnit = CalendarDateUnit.of(null, coord.getUnitsString());
        this.timeName = coord.getShortName();
      } else if (coord.getAxisType().isVert()) {
        this.altUnits = coord.getUnitsString();
        this.altName = coord.getShortName();
      }
    }
  }

  @Nonnull
  @Override
  public String getName() {
    return name;
  }

  @Nullable
  @Override
  public String getTimeName() {
    return timeName;
  }

  @Nullable
  @Override
  public CalendarDateUnit getTimeUnit() {
    return timeUnit;
  }

  @Nullable
  @Override
  public String getAltName() {
    return altName;
  }

  @Nullable
  @Override
  public String getAltUnits() {
    return altUnits;
  }

  @Nonnull
  @Override
  public List getCoordinateVariables() {
    return this.coordVars;
  }

  @Nonnull
  public List getExtraVariables() {
    return (extras == null) ? new ArrayList<>() : extras;
  }

  @Override
  public int size() {
    return (info == null) ? -1 : info.nfeatures;
  }

  public int getNobs() {
    return (info == null) ? -1 : info.nobs;
  }

  @Nullable
  @Override
  public CalendarDateRange getCalendarDateRange() {
    return (info == null) ? null : info.getCalendarDateRange(timeUnit);
  }

  @Nullable
  @Override
  public ucar.unidata.geoloc.LatLonRect getBoundingBox() {
    return (info == null) ? null : info.bbox;
  }

  @Nonnull
  public CollectionInfo getInfo() { // LOOK exposes mutable fields
    if (info == null)
      info = new CollectionInfo();
    return info;
  }
}