/**
 * $Id: SimplePoint.java,v 1.14 2003/08/22 23:02:38 dwd Exp $
 *
 * This software is provided by NOAA for full, free and open release.  It is
 * understood by the recipient/user that NOAA assumes no liability for any
 * errors contained in the code.  Although this software is released without
 * conditions or restrictions in its use, it is expected that appropriate
 * credit be given to its author and to the National Oceanic and Atmospheric
 * Administration should the software be included by the recipient as an
 * element in other product development.
 */

package sgtplot.dm;


import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;
import java.io.Serializable;

import sgtplot.InvalidMethodError;
import sgtplot.SGLabel;
import sgtplot.util.GeoDate;
import sgtplot.util.SoTPoint;
import sgtplot.util.SoTRange;
import sgtplot.util.SoTValue;

/**
 * SimplePoint provides an implementation of the
 * SGTPoint and Cartesian interfaces.
 *
 * @author Donald Denbo
 * @version $Revision: 1.14 $, $Date: 2003/08/22 23:02:38 $
 * @since 1.0
 * @see SGTPoint
 * @see Cartesian
*/
public class SimplePoint implements SGTPoint, Cartesian, Cloneable, Serializable {
  protected double xloc_ = Double.NaN;
  protected double yloc_ = Double.NaN;
  protected long tloc_;
  protected boolean xTime_ = false;
  protected boolean yTime_ = false;
  protected double value_;
  protected String title_;
  protected SGLabel keyTitle_ = null;
  protected String id_ = null;
    /**@shapeType AggregationLink
  * @clientRole value*/
    protected SGTMetaData valueMetaData_;

  /**
   * @link aggregation
   * @clientRole x
   */
  protected SGTMetaData xMetaData_;

  /**
   * @link aggregation
   * @clientRole y*/
  protected SGTMetaData yMetaData_;
  protected boolean hasValue_ = false;
  private PropertyChangeSupport changes_ = new PropertyChangeSupport(this);
  /**
   * Default constructor.
   */
  public SimplePoint() {
  }
  /**
   * Simple Point constructor.
   *
   * @param xloc X coordinate
   * @param yloc Y coordinate
   * @param title the title
   */
  public SimplePoint(double xloc,double yloc,String title) {
    xloc_ = xloc;
    yloc_ = yloc;
    title_ = title;
  }
  /**
   * Simple Point constructor.
   *
   * @since 3.0
   *
   * @param loc SoTPoint
   * @param title the title
   */
  public SimplePoint(SoTPoint loc, String title) {
    xTime_ = loc.isXTime();
    yTime_ = loc.isYTime();
    if(xTime_) {
      tloc_ = loc.getX().getLongTime();
    } else {
      xloc_ = ((Number)loc.getX().getObjectValue()).doubleValue();
    }
    if(yTime_) {
      tloc_ = loc.getY().getLongTime();
    } else {
      yloc_ = ((Number)loc.getY().getObjectValue()).doubleValue();
    }
    title_ = title;
  }
  /**
   * Create a copy.
   *
   * @since 2.0
   * @see SGTData
   */
  public SGTData copy() {
    SGTPoint newPoint;
    try {
      newPoint = (SGTPoint)clone();
    } catch (CloneNotSupportedException e) {
      newPoint = new SimplePoint();
    }
    return (SGTData)newPoint;
  }
  /**
   * Get the X coordinate.
   */
  public double getX() {
    return xloc_;
  }
  /**
   * Get the Y coordinate
   */
  public double getY() {
    return yloc_;
  }
  /**
   * Get the associated value.
   */
  public double getValue() {
    return value_;
  }
  /**
   * Is there an associated value?
   */
  public boolean hasValue() {
    return hasValue_;
  }
  /**
   * Get the time coordinate.
   */
  public GeoDate getTime() {
    return new GeoDate(tloc_);
  }
  /**
   * Get the time in long referenced
   * to 1970-01-01
   *
   * @since 3.0
   */
  public long getLongTime() {
    return tloc_;
  }
  /**
   * Set the time coordinate
   *
   * @since 3.0
   */
  public void setTime(GeoDate date) {
    setTime(date.getTime());
  }
  /**
   * @since 3.0
   */
  public void setTime(long t) {
    long old = tloc_;
    tloc_ = t;
    changes_.firePropertyChange("dataModified",
                                new Long(old),
                                new Long(tloc_));
  }
  /**
   * Is the X coordinate Time?
   */
  public boolean isXTime() {
    return xTime_;
  }
  /**
   * Is the Y coordinate Time?
   */
  public boolean isYTime() {
    return yTime_;
  }
  /**
   * Get the title.
   */
  public String getTitle() {
    return title_;
  }
  /**
   * Set the title.
   */
  public void setTitle(String title) {
    title_ = title;
  }
  public SGLabel getKeyTitle() {
    return keyTitle_;
  }
  /** Set the title formatted for the VectorKey. */
  public void setKeyTitle(SGLabel title) {
    keyTitle_ = title;
  }
  /**
   * Get the unique identifier.  The presence of the identifier
   * is optional, but if it is present it should be unique.  This
   * field is used to search for the layer that contains the data.
   *
   * @since 2.0
   * @return unique identifier
   * @see sgtplot.Pane
   * @see sgtplot.Layer
   */
  public String getId() {
    return id_;
  }
  /**
   * Set the unique identifier.
   */
  public void setId(String ident) {
    id_ = ident;
  }
  /**
   * Get the associated value SGTMetaData.
   */
  public SGTMetaData getValueMetaData() {
    return valueMetaData_;
  }
  /**
   * Set the X coordinate.
   * 
Property Change: dataModified.
   */
  public void setX(double xloc) {
    double old = xloc_;
    xloc_ = xloc;
    changes_.firePropertyChange("dataModified",
                                new Double(old),
                                new Double(xloc_));
  }
  /**
   * Set the Y coordinate.
   * 
Property Change: dataModified.
   */
  public void setY(double yloc) {
    double old = yloc_;
    yloc_ = yloc;
    changes_.firePropertyChange("dataModified",
                                new Double(old),
                                new Double(yloc_));
  }
  /**
   * The the associated value and basic metadata.
   * 
Property Change: associatedDataModified.
   *
   * @param value associated data
   * @param name values name
   * @param units values units
   */
  public void setValue(double value,String name,String units) {
    double old = value_;
    value_ = value;
    valueMetaData_ = new SGTMetaData(name, units);
    hasValue_ = true;
    changes_.firePropertyChange("associatedDataModified",
                                new Double(old),
                                new Double(value_));
  }
  /**
   * Set the SGTMetaData associated with the x
   * coordinate
   *
   * @since 2.0
   */
  public void setXMetaData(SGTMetaData md) {
    xMetaData_ = md;
  }
  /**
   * Set the SGTMetaData associated with the y
   * coordinate
   *
   * @since 2.0
   */
  public void setYMetaData(SGTMetaData md) {
    yMetaData_ = md;
  }
  public SGTMetaData getXMetaData() {
    return xMetaData_;
  }
  public SGTMetaData getYMetaData() {
    return yMetaData_;
  }
  public SoTRange getXRange() {
    if(xTime_) {
      return new SoTRange.Time(tloc_, tloc_);
    } else {
      return new SoTRange.Double(xloc_, xloc_);
    }
  }
  public SoTRange getYRange() {
    if(yTime_) {
      return new SoTRange.Time(tloc_, tloc_);
    } else {
      return new SoTRange.Double(yloc_, yloc_);
    }
  }
  public void addPropertyChangeListener(PropertyChangeListener l) {
    changes_.addPropertyChangeListener(l);
  }
  public void removePropertyChangeListener(PropertyChangeListener l) {
    changes_.removePropertyChangeListener(l);
  }
}