decodes.tsdb.CTimeSeries Maven / Gradle / Ivy
Show all versions of opendcs Show documentation
package decodes.tsdb;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Date;
import java.util.Collections;
import java.util.Comparator;
import java.util.Properties;
import ilex.util.Logger;
import ilex.var.IFlags;
import ilex.var.TimedVariable;
import ilex.var.NoConversionException;
import decodes.db.Constants;
import decodes.sql.DbKey;
/**
Computational Time Series Class.
This class holds links to meta data and the actual time series data.
*/
public class CTimeSeries
{
/** This is used to display the time series name
* which is site name "-" ts name */
private String displayName;
/** Site datatype ID */
private DbKey sdi;
/** The table selector */
private String tableSelector;
/** Interval code */
private String interval;
/** Model ID (modeled data only) */
private int modelId;
/** Model run ID (modeled data only) */
private int modelRunId;
/** The units that this data is currently in. */
private String unitsAbbr;
/**
* The ID of the computation that produced this time series, or
* Constants.undefinedId if this was read from the database.
*/
private DbKey computationId;
/** The vector of variables. */
private ArrayList vars;
/** For tracking tasklist records of computations. */
private ArrayList taskListRecNums; // Note these ARE integers, not DbKey.
/** timeseries name .used for customised timeseries name in tables and plots **/
private String briefDescription;
/** TimeSeries properties */
private Properties props = new Properties();
private static Comparator tvComparator =
new Comparator()
{
public int compare(TimedVariable v1, TimedVariable v2)
{
return v1.getTime().compareTo(v2.getTime());
}
};
/** Database-specific object containing additional meta-data. */
private TimeSeriesIdentifier timeSeriesIdentifier;
/** Transient storage for comp processor */
private HashSet dependentCompIds;
private boolean _isExpanded = false;
public void setIsExpanded() { _isExpanded = true; }
public boolean isExpanded() { return _isExpanded; }
/**
* Constructor.
* @param sdi The site-datatype-id (or ddid for NWIS).
* @param interval one of the valid interval codes.
* @param sel The table selector ("R_" or "M_" for HDB, DBNO for NWIS).
* @see IntervalCodes
*/
public CTimeSeries( DbKey sdi, String interval, String sel )
{
this.sdi = sdi;
this.interval = interval;
this.tableSelector = sel;
this.modelRunId = Constants.undefinedIntKey;
this.modelId = Constants.undefinedIntKey;
this.computationId = Constants.undefinedId;
this.displayName = null;
vars = new ArrayList();
unitsAbbr = "unknown";
dependentCompIds = null;
taskListRecNums = new ArrayList();
}
public CTimeSeries(TimeSeriesIdentifier tsId)
{
this.sdi = tsId.getKey();
this.interval = tsId.getInterval();
this.tableSelector = tsId.getTableSelector();
this.modelRunId = Constants.undefinedIntKey;
this.modelId = Constants.undefinedIntKey;
this.computationId = Constants.undefinedId;
this.displayName = null;
vars = new ArrayList();
unitsAbbr = "unknown";
this.displayName = tsId.getDisplayName();
dependentCompIds = null;
taskListRecNums = new ArrayList();
setTimeSeriesIdentifier(tsId);
}
/**
* Construct time series for a computation parameter.
*/
public CTimeSeries(DbCompParm parm)
{
this(parm.getSiteDataTypeId(), parm.getInterval(),
parm.getTableSelector());
this.modelId = parm.getModelId();
this.displayName = null;
}
/**
* @return the site-datatype-id (SDI for USBR HDB, ddid for USGS NWIS)
*/
public DbKey getSDI( )
{
return sdi;
}
/**
* Sets the site-datatype-id (or ddid for NWIS).
* @param sdi the id
*/
public void setSDI( DbKey sdi )
{
this.sdi = sdi;
}
/**
* @return the table selector
*/
public String getTableSelector( )
{
return tableSelector;
}
/**
* Sets the table selector.
* @param sel table selector
*/
public void setTableSelector( String sel )
{
this.tableSelector = sel;
}
/**
* @return string representing the interval of data in this time series.
* @see IntervalCodes
*/
public String getInterval( )
{
return interval;
}
/**
* Sets the string representing the interval of this time series.
* @see IntervalCodes
*/
public void setInterval( String interval )
{
this.interval = interval;
}
/**
* @return the model-run-id (HDB modeled data only).
*/
public int getModelRunId( )
{
return modelRunId;
}
/**
* Sets the model-Run-id (HDB modeled data only).
* @param modelRunId the id
*/
public void setModelRunId( int modelRunId )
{
this.modelRunId = modelRunId;
}
/**
* @return the model-id (HDB modeled data only).
*/
public int getModelId( )
{
return modelId;
}
/**
* Sets the model-id (HDB modeled data only).
* @param modelId the id
*/
public void setModelId( int modelId )
{
this.modelId = modelId;
}
/**
* @return the computation-id (Constants.undefinedId if this time series
* is not the result of a computation.
*/
public DbKey getComputationId( )
{
return computationId;
}
/**
* Sets the Computation ID.
* @param computationId the id
*/
public void setComputationId( DbKey computationId )
{
this.computationId = computationId;
}
/**
* Return sample at the specified index or null if none.
* @param idx the index
* @return sample at the specified index or null if none.
*/
public synchronized TimedVariable sampleAt( int idx )
{
if (idx >= 0 && idx < vars.size())
return vars.get(idx);
return null;
}
/**
* Add a sample to the time series.
* Values are kept in ascending order, so this method finds the appropriate
* spot for insertion.
* If this sample has the exact same time stamp as a value already in the
* series, then the old value is replaced.
*
* Warning: This method assumes that the time series is sorted. If you
* have changed time-tags of elements in the list, call sort() before
* adding new samples.
* @param tv the timed variable to insert.
*/
public synchronized void addSample( TimedVariable tv )
{
int sz = vars.size();
int idx = 0;
if (sz > 0)
{
idx = Collections.binarySearch(vars, tv, tvComparator);
// If same time stamp, replace old value.
if (idx >= 0)
{
vars.set(idx, tv);
return;
}
idx = (-idx) - 1;
}
vars.add(idx, tv);
}
/**
* Find the sample at the specified time within the fudge factor.
* @param sec Second value (offset from epoch)
* @param fudge number of seconds fudge factor.
* @return TimedVariable or null if not found.
*/
public TimedVariable findWithin(long sec, int fudge)
{
//Logger.instance().info("findWithin(" + sec + ", " + fudge + ")"
//+ "date value = " + (new Date(sec*1000L)));
for(TimedVariable tv : vars)
{
int sect = (int)(tv.getTime().getTime() / 1000L);
int dt = sect - (int)sec;
//Logger.instance().info("findWithin sect=" + sect + ", dt=" + dt);
if (dt == 0)
return tv;
// 20170525 Changed second clause below from "dt <= fudge" to "dt < fudge".
// This will prevent a value from being considered part of two different time slices.
// Example roundSec=60, so fudge=30. If sec=12:00:00 we want to accept 11:59:30...12:00:29
// because 12:00:30 would be considered part of the 12:01 timeslice.
if (-fudge <= dt && dt < fudge)
return tv;
}
return null;
}
/**
* Convenience method which can be called with a date object
* @param d
* @param fudge
* @return
*/
public TimedVariable findWithin(Date d, int fudge)
{
return findWithin(d.getTime()/1000L, fudge);
}
/**
* Delete any variables in this time series with the specified time
* within the specified fudge factor.
* @return true if a value was deleted.
*/
public boolean deleteWithin(long sec, int fudge)
{
for(int i=0; i getDependentCompIds()
{
if (dependentCompIds == null)
dependentCompIds = new HashSet();
return dependentCompIds;
}
/** Adds a computation ID to this TS's list. */
public void addDependentCompId(DbKey compId)
{
if (dependentCompIds == null)
dependentCompIds = new HashSet();
dependentCompIds.add(compId);
}
/** @return the list of tasklist record nums used to populate this ts. */
public ArrayList getTaskListRecNums() { return taskListRecNums; }
/** Adds a recnum to the list of tasklist record nums. */
public void addTaskListRecNum(int recnum) { taskListRecNums.add(recnum); }
/** Clears the list of tasklist record nums. */
public void clearTaskListRecNums() { taskListRecNums.clear(); }
/**
* @return the tsName
*/
public String getBriefDescription()
{
return briefDescription;
}
/**
* @param tsName
* the tsName to set
*/
public void setBriefDescription(String briefDescription)
{
this.briefDescription = briefDescription;
}
/**
* @return the props
*/
public Properties getProperties() {
return props;
}
/**
* Adds a property to this time series.
* @param name the property name.
* @param value the property value.
*/
public void setProperty(String name, String value)
{
props.setProperty(name, value);
}
}