ucar.nc2.ft2.simpgeometry.Polygon 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 java.util.List;
import ucar.ma2.Array;
import ucar.nc2.Variable;
import ucar.nc2.dataset.NetcdfDataset;

/**
 * Generic interface for a Simple Geometry Polygon.
 * 
 * @author [email protected]
 *
 */
public interface Polygon extends SimpleGeometry {

  /**
   * Get the list of points which constitute the polygon.
   * 
   * @return points Points which constitute the polygon
   */
  List getPoints();

  /**
   * Get the data associated with this Polygon
   * 
   * @return data Data series associated with the Polygon
   */
  Array getData();

  /**
   * Get the next polygon in the sequence of multi-polygons
   * 
   * @return Next polygon in the same multipolygon if any, otherwise null
   */
  Polygon getNext();

  /**
   * Get the previous polygon in the sequence of multi-polygons
   * 
   * @return Previous polygon in the same multipolygon if any, otherwise null
   */
  Polygon getPrev();

  /**
   * Get whether or not this polygon is an interior ring
   * 
   * @return true if an interior ring, false if not
   */
  boolean getInteriorRing();

  /**
   * Add a point to this polygon's points list
   * 
   */
  void addPoint(double x, double y);

  /**
   * Set the data associated with this Polygon
   * 
   * @param data Array of data to set to
   */
  void setData(Array data);

  /**
   * Sets the next polygon which make up the multipolygon which this polygon is a part of.
   * 
   * @param next Polygon to set
   */
  void setNext(Polygon next);

  /**
   * Sets the previous polygon which makes up the multipolygon which this polygon is a part of.
   * 
   * @param prev Polygon to set
   */
  void setPrev(Polygon prev);

  /**
   * Simply sets whether or not this polygon is an interior ring
   * 
   * @param interior ring or not
   */
  void setInteriorRing(boolean interior);

  /**
   * Given a dataset, construct a polygon from the variable which holds polygons
   * and the index as given.
   * 
   * @param dataset Where the polygon variable resides
   * @param variable Which holds polygon information
   * @param index for Indexing within the polygon variable
   * 
   * @return the constructed Polygon with associated data
   */
  Polygon setupPolygon(NetcdfDataset dataset, Variable variable, int index);

}