Package hec.gfx2d.swing.charts.data

Interface ChartModel

All Known Implementing Classes:
DefaultChartModel
public interface ChartModel
Copyright (C) 2017 Hydrologic Engineering Center, United States Army Corps of Engineers, All Rights Reserved

HEC-Java NEXGEN

  • Method Details

    • getId

      RmaDataId getId()
      Returns:
      the id for this chart or item item

    • getValue

      double getValue(RmaDataId itemId, Date timeIndex)
      Parameters:
      itemId - the item to retrieve the value from
      timeIndex - the corresponding time for the value retrieved
      Returns:
      the operational value of a item

    • getMinValue

      double getMinValue(RmaDataId itemId, Date timeIndex)
      Parameters:
      itemId - the item to retrieve the minimum value from
      timeIndex - the corresponding time for the value retrieved
      Returns:
      the minimum value of a item

    • getMaxValue

      double getMaxValue(RmaDataId itemId, Date timeIndex)
      Parameters:
      itemId - the item to retrieve the maximum value from
      timeIndex - the corresponding time for the value retrieved
      Returns:
      the maximum value of a item

    • getQuality

      int getQuality(RmaDataId itemId, Date timeIndex)
      Parameters:
      itemId - the item to retrieve the quality from
      timeIndex - the corresponding time for the value retrieved
      Returns:
      the quality of the item data

    • getUnits

      String getUnits(RmaDataId itemId)
      Parameters:
      itemId - the item to retrieve units for
      Returns:
      the units of the item identified

    • getEarliestDate

      Date getEarliestDate()
      Returns:
      the java.util.Date corresponding to the earliest recorded value item

    • getLatestDate

      Date getLatestDate()
      Returns:
      the java.util.Date corresponding to the latest recorded value item

    • getClosestDate

      Date getClosestDate(Date date)
      Parameters:
      date - the java.util.Date in question, attempting to find a closest match existing in value mappings
      Returns:
      the date in values mapping that is the closest to the given date

    • setComparator

      void setComparator(Comparator<RmaDataId> idComparator)
      Parameters:
      idComparator - the comparator to use when sorting the item ids in the getItemIds() method

    • getItemIds

      List<RmaDataId> getItemIds()
      Returns a list of all item ids in the chart, sorted by the comparator provided in setComparator or by default comparison (alphabetically by id name) if no comparator has been provided
      Returns:
      the list of all item ids in the chart
      See Also: