Package hec.heclib.dss

Class HecTimeSeriesBase

java.lang.Object

hec.heclib.dss.HecDSSFileAccess

hec.heclib.dss.HecDssCatalog

hec.heclib.dss.HecDSSDataAttributes

hec.heclib.dss.HecDataManager

hec.heclib.dss.HecTimeSeriesBase

All Implemented Interfaces:

HecDssListener, AutoCloseable, Cloneable, EventListener

Direct Known Subclasses:

HecTimeSeries

public class HecTimeSeriesBase
extends HecDataManager

Nested Class Summary

Nested classes/interfaces inherited from class hec.heclib.dss.HecDssCatalog

HecDssCatalog.WriteCatalogFileRunnable

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	_defaultInterval
protected int	_interval
protected boolean	_retrieveAllTimes

Fields inherited from class hec.heclib.dss.HecDataManager

_recordData, DSS_ERROR, DSS_FILE_ERROR, DSS_SEVERE_ERROR, STATUS_DATA_ERROR

Fields inherited from class hec.heclib.dss.HecDSSDataAttributes

_arrayEndTime, _arraySize, _arrayStartTime, _checkedNumber, _dataLengthInts, _dataType, _defaultEndTime, _defaultStartTime, _desiredArraySize, _dirty, _dssPathname, _endTime, _localUnitSystem, _recordExists, _recordType, _slashPosition, _startTime, _timeSeries, _timeWindowSet, _typeX, _unitsX, ALBERS, ALBERS_GRID, ALBERS_GRID_WITH_TIME, DOUBLE_ARRAY, ENGLISH_UNITS, ERROR, FILE, FLOAT_ARRAY, HRAP, HRAP_GRID, HRAP_GRID_WITH_TIME, IMAGE, INT_ARRAY, IRREGULAR_TIME_PATTERN, IRREGULAR_TIME_SERIES, IRREGULAR_TIME_SERIES_DOUBLES, LOCATION_LEVEL, PAIRED, PAIRED_DOUBLES, REGULAR_TIME_PATTERN, REGULAR_TIME_SERIES, REGULAR_TIME_SERIES_DOUBLES, SI_UNITS, SINGLE_VALUE, SPECIFIED_GRID, SPECIFIED_GRID_TYPE, SPECIFIED_GRID_WITH_TIME, TEXT, UNDEFINED_GRID, UNDEFINED_GRID_TYPE, UNDEFINED_GRID_WITH_TIME, UNDEFINED_UNITS, UNKNOWN

Fields inherited from class hec.heclib.dss.HecDssCatalog

_catalogName, _forceNewCatalog, _listenerList, _observerThreads, _useCollectionGroups, crcValues, dataTypeEnd, dataTypeStart, endDates, lastWriteTimeFile, lastWriteTimeRecord, listIsCollection, listIsComplete, listIsSorted, maxNumberToRetrieve, pathnameAddresses, pathnameHash, pathnameList, pathnameWithWild, startDates, statusRead, statusWanted

Fields inherited from class hec.heclib.dss.HecDSSFileAccess

_defaultDirectory, _defaultDSSFileName, _fileData, _maxNumberReopensForError, _numberReopensForError, _severeErrorIndex, _severeErrorMessages, _severeErrorRaised, ABBREVIATED_CATALOG, CONDENSED_CATALOG, FULL_CATALOG, MESS_LEVEL_CRITICAL, MESS_LEVEL_GENERAL, MESS_LEVEL_INTERNAL_DIAG_1, MESS_LEVEL_INTERNAL_DIAG_2, MESS_LEVEL_NONE, MESS_LEVEL_TERSE, MESS_LEVEL_USER_DIAG, MESS_METHOD_ALIAS, MESS_METHOD_CATALOG, MESS_METHOD_CHECK, MESS_METHOD_COPY, MESS_METHOD_FILE_CHECK, MESS_METHOD_GENERAL, MESS_METHOD_GET, MESS_METHOD_GLOBAL, MESS_METHOD_JNI, MESS_METHOD_LOCKING, MESS_METHOD_OPEN, MESS_METHOD_PERM, MESS_METHOD_PUT, MESS_METHOD_READ, MESS_METHOD_TS_READ, MESS_METHOD_TS_WRITE, MESS_METHOD_UTILITY, MESS_METHOD_WRITE

Constructor Summary

Constructors

Constructor	Description
HecTimeSeriesBase()
HecTimeSeriesBase(String DssFileName)

Method Summary

Modifier and Type	Method	Description
static String	getAppropriateEPart(int[] times)
static String	getAppropriateIrregularBlock(int[] times)
static String	getAppropriateRegularEPart(int[] times)
int	getDefaultUnitsType(stringContainer units, stringContainer type)	For storing data, if the units and the type are not given, generate some default ones based on the "C" part of the pathname
static String	getDpartFromTime(HecTime startTime, String ePart)	Returns the correct D (date) part of a DSS pathname, given the E part (interval) and a time in the block For example, if your data starts on 22Mar2008 and the E part is "1Year", then this will return 01JAN2008
static String	getEPartFromInterval(int interval)
static int	getIntervalFromEPart(String ePart)
static Vector<String>	getListOfEParts()	Returns standard list of E-Parts excluding pseudo-regular prefix:~ and less than 1 minute
static int	getMostCommonInterval(int[] times)
protected int	getNumberValuesForArraySize()
static boolean	getTimeWindowFromPath(HecDataManager dataManager, DSSPathname path, HecTime startTime, HecTime endTime)
int	interval()
static boolean	isRegular(int[] times)
int	numberValues()
int	precision()
int	setEPart(String ePart)
int	setInterval(int interval)
int	setPathname(String pathname)
int	setPathnameParts(String pathnameParts)	Takes a string containing pathname parts in the form "B=MY LOC, C=FLOW, E = 1HOUR", and sets the parts
void	setPrecision(int precision)
void	setStartTime(HecTime startTime)
void	setType(String type)
void	setUnits(String units)
void	status()	print basic info to console
String	type()
String	units()
static int	zgintlFromEPart(String ePart)

Methods inherited from class hec.heclib.dss.HecDataManager

addAlias, addAlias, addAlias, addAliasList, aliasGetPrimary, aliasGetPrimary, aliasList, aliasList, aliasRemove, aliasRemove, aliasRemoveList, clear, closeLogFile, closeMessageFile, convertUnitSystem, copyContainerToRecordData, copyRecordDataToContainer, done, flushMessageFile, getRecordInfo, getRecordInfo, getRecordInfo, getTSRecordInfo, numberArray, release, release, setMessageFile, setProgramName, Xarray, Yarray, Yarray, zlocationRetrieve, zlocationStore

Methods inherited from class hec.heclib.dss.HecDSSDataAttributes

aPart, arrayEndTime, arrayStartTime, bPart, convertDoubleUnits, convertUnits, cPart, createArrayObject, createObject, createPairedDataObject, createTextObject, createTimeSeriesObject, dirty, dPart, endTime, ePart, fPart, getLastWriteTime, getLastWriteTime, getLastWriteTimeMillis, getLastWriteTimeMillis, getRecordBasics, isGridRecord, isTimeWindowSet, localUnitSystem, pathname, pathnameDataType, recordExists, recordsUpdated, recordType, recordType, recordTypes, setAPart, setBPart, setCPart, setDefaultTimeWindow, setDefaultTimeWindow, setDPart, setDSSFileName, setEndTime, setFPart, setLocalUnitSystem, setTimeWindow, setTimeWindow, startTime

Methods inherited from class hec.heclib.dss.HecDssCatalog

addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, buildCondensedList, buildSortedCatalog, callCatalog, callCatalog, callCatalogOriginal, catalogFile, clearList, clone, compareCondensedPaths, expandPathname, fireHecDssEvent, getCatalog, getCatalog, getCatalog, getCatalogName, getCatalogSortAddresses, getCondensedCatalog, getCondensedCatalog, getDeletedPaths, getEPartLoc, getMaximumPartLengths, getPathnameList, getPathnameList, getPathnameList7, getPathnameListAndDates, getPathnames, getSortedPathnameList, getUseCollectionGroups, hecDssEventPerformed, isCatalogValid, isPathnamePartsString, pathNamePartsToRegex, processSearchParts, readCatalog, removeHecDssListener, searchDSSCatalog, searchDSSCatalog, searchDSSPaths, searchDSSPaths, setCatalogSortAddresses, setForceNewCatalog, setMaxNumberToRetrieve, setPathnameList, setPathnameList, setPathWithWildChars, setUseCollectionGroups, sort, sortCatalog, startObserverThread, whatChanged, whatChanged, whatChangedCompare, whatChangedSetStart, whatChangedSetStart, whatChangedSetStart, wildCharsToRegex, writeCatalog

Methods inherited from class hec.heclib.dss.HecDSSFileAccess

allSevereErrorMessages, appendNameToDirectory, checkAllPathnames, checkForError, checkForSevereError, checkForSevereError, checkForSevereFileError, checkLinks, checkPathnameBins, checkSystemError, cleanDSSFileName, clearError, clearSevereError, clearSevereError, clearStatus, close, close, closeAll, closeAllFiles, closeAndClear, closeDSSFile, debugLook, debugLook7, debugModify, defaultDirectory, defaultDSSFileName, doesDSSFileExist, DSSFileName, fileAccessible, fileOpened, fileStatus, flushMessages, forceMultiUserAccess, getCollectionList, getCollectionSequenceList, getCollectionSize, getDssFileVersion, getDssFileVersion, getFileInfo, getFileLastWriteTime, getFileLastWriteTimeMillis, getIrregBeginningDate, getLastError, getMessageLevel, getNumberRecords, getProcessStatus, getTimeSeriesExtents, getTSRecordInfo, lastSevereErrorMessage, numberRecords, open, open, processStatus, requestSecondAccess, setDefaultDirectory, setDefaultDSSFileName, setDss, setDSSFileName, setDSSFileName, setDSSFileName, setInterrupt, setMessageLevel, setUnit, writeAccess, zgetMessageLevel, zinqir, zinqir, zinquire, zmessage, zquery, zquery, zset, zsetFile, zsetMessageLevel

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_defaultInterval

protected static int _defaultInterval

_retrieveAllTimes

protected boolean _retrieveAllTimes

_interval

protected int _interval

Constructor Details

HecTimeSeriesBase

public HecTimeSeriesBase()

HecTimeSeriesBase

public HecTimeSeriesBase(String DssFileName)

Method Details

precision

public int precision()

setPrecision

public void setPrecision(int precision)

getIntervalFromEPart

public static int getIntervalFromEPart(String ePart)

zgintlFromEPart

public static int zgintlFromEPart(String ePart)

getEPartFromInterval

public static String getEPartFromInterval(int interval)

getListOfEParts

public static Vector<String> getListOfEParts()

Returns standard list of E-Parts excluding pseudo-regular prefix:~ and less than 1 minute

getAppropriateIrregularBlock

public static String getAppropriateIrregularBlock(int[] times)

getAppropriateRegularEPart

public static String getAppropriateRegularEPart(int[] times)

getAppropriateEPart

public static String getAppropriateEPart(int[] times)

isRegular

public static boolean isRegular(int[] times)

getMostCommonInterval

public static int getMostCommonInterval(int[] times)

getDpartFromTime

public static String getDpartFromTime(HecTime startTime,
 String ePart)

Returns the correct D (date) part of a DSS pathname, given the E part (interval) and a time in the block For example, if your data starts on 22Mar2008 and the E part is "1Year", then this will return 01JAN2008

Parameters:

startTime - HecTime

ePart - String

Returns:

dPart String

setInterval

public int setInterval(int interval)

interval

public int interval()

setEPart

public int setEPart(String ePart)

Overrides:

setEPart in class HecDSSDataAttributes

setPathname

public int setPathname(String pathname)

Overrides:

setPathname in class HecDSSDataAttributes

getTimeWindowFromPath

public static boolean getTimeWindowFromPath(HecDataManager dataManager,
 DSSPathname path,
 HecTime startTime,
 HecTime endTime)

getNumberValuesForArraySize

protected int getNumberValuesForArraySize()

setPathnameParts

public int setPathnameParts(String pathnameParts)

Takes a string containing pathname parts in the form "B=MY LOC, C=FLOW, E = 1HOUR", and sets the parts

Overrides:

setPathnameParts in class HecDSSDataAttributes

Parameters:

pathnameParts - input string with part definition

Returns:

zero on success

setUnits

public void setUnits(String units)

setType

public void setType(String type)

units

public String units()

type

public String type()

status

public void status()

print basic info to console

Overrides:

status in class HecDataManager

getDefaultUnitsType

public int getDefaultUnitsType(stringContainer units,
 stringContainer type)

For storing data, if the units and the type are not given, generate some default ones based on the "C" part of the pathname

Parameters:

units - output units such as 'CFS '

type - output type such as 'PER-CUM'

Returns:

numberValues

public int numberValues()

setStartTime

public void setStartTime(HecTime startTime)

Overrides:

setStartTime in class HecDSSDataAttributes