Package hec.heclib.dss

Class HecDataManager

java.lang.Object

hec.heclib.dss.HecDSSFileAccess

hec.heclib.dss.HecDssCatalog

hec.heclib.dss.HecDSSDataAttributes

hec.heclib.dss.HecDataManager

All Implemented Interfaces:

HecDssListener, AutoCloseable, Cloneable, EventListener

Direct Known Subclasses:

GriddedData, HecDssArray, HecDssFileStore, HecDssText, HecDssTin, HecDSSUtilities, HecPairedData, HecTimeSeriesBase

public class HecDataManager
extends HecDSSDataAttributes

HecDataManager is considered the base class which most HEC-DSS classes inherit from (there are lower classes, but the Java programmer should not access them.)

Nested Class Summary

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

HecDssCatalog.WriteCatalogFileRunnable

Field Summary

Fields

Modifier and Type	Field	Description
protected HecDSSRecordData	_recordData
protected static final int	DSS_ERROR
protected static final int	DSS_FILE_ERROR
protected static final int	DSS_SEVERE_ERROR
protected static final int	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
HecDataManager()
HecDataManager(String DssFileName)
HecDataManager(String DssFileName, int version)

Method Summary

Modifier and Type	Method	Description
int	addAlias(CondensedReference primary, DSSPathname aliasPart)
int	addAlias(String aliasPathname)
int	addAlias(String primaryPathname, String aliasPathname)
int	addAliasList(String[] primaryPathnameList, String[] aliasPathnameList)
String	aliasGetPrimary()
String	aliasGetPrimary(String aliasPathname)
String[]	aliasList()
String[]	aliasList(String aliasPathname)
int	aliasRemove(boolean removeAll)
int	aliasRemove(String aliasPathname, boolean removeAll)
int	aliasRemoveList(String[] aliasPathnameList)
void	clear()	Removes all references to data sets.
static void	closeLogFile()
static void	closeMessageFile()
int	convertUnitSystem(int unitSystem)	Convert the data in the recordData array to the unit system specified The data must have already been read before calling this function
int	copyContainerToRecordData(DataContainer dataContainer)
protected void	copyRecordDataToContainer(DataContainer dataContainer)
void	done()	Similar to a destructor, this function indicates that this object no longer needs its data.
static void	flushMessageFile()
HecDSSRecordInfo	getRecordInfo()	Get information about an individual record (pathname) This is information that would be shown in a regular catalog and from a zcheck call.
boolean	getRecordInfo(HecDSSRecordInfo recordInfo)	Get information about an individual record (pathname) This is information that would be shown in a regular catalog and from a zcheck call.
HecDSSRecordInfo	getRecordInfo(String pathname)
int	getTSRecordInfo(HecTime start, HecTime end, stringContainer units, stringContainer type)
int	numberArray()
protected void	release()
protected void	release(boolean closeFileIfNotUsed)
static int	setMessageFile(String filename)
static void	setProgramName(String programName)
void	status()
void	Xarray(doubleArrayContainer X)
void	Yarray(doubleArrayContainer Y)
void	Yarray(doubleArrayContainer[] Y)
int	zlocationRetrieve(DataContainer dataContainer)
int	zlocationStore(DataContainer dataContainer)

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, setEPart, setFPart, setLocalUnitSystem, setPathname, setPathnameParts, setStartTime, 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

_recordData

protected HecDSSRecordData _recordData

DSS_ERROR

protected static final int DSS_ERROR

See Also:

• Constant Field Values

STATUS_DATA_ERROR

protected static final int STATUS_DATA_ERROR

See Also:

• Constant Field Values

DSS_FILE_ERROR

protected static final int DSS_FILE_ERROR

See Also:

• Constant Field Values

DSS_SEVERE_ERROR

protected static final int DSS_SEVERE_ERROR

See Also:

• Constant Field Values

Constructor Details

HecDataManager

public HecDataManager()

HecDataManager

public HecDataManager(String DssFileName)

HecDataManager

public HecDataManager(String DssFileName,
 int version)

Method Details

release

protected void release()

release

protected void release(boolean closeFileIfNotUsed)

done

public void done()

Similar to a destructor, this function indicates that this object no longer needs its data. Data will be deleted when others no longer need it

Overrides:

done in class HecDSSFileAccess

clear

public void clear()

Removes all references to data sets. This is used when the same object is used to read or write a different data set (not recommended).

closeLogFile

public static void closeLogFile()

setMessageFile

public static int setMessageFile(String filename)

flushMessageFile

public static void flushMessageFile()

closeMessageFile

public static void closeMessageFile()

setProgramName

public static void setProgramName(String programName)

addAlias

public int addAlias(String aliasPathname)

addAlias

public int addAlias(String primaryPathname,
 String aliasPathname)

addAlias

public int addAlias(CondensedReference primary,
 DSSPathname aliasPart)

addAliasList

public int addAliasList(String[] primaryPathnameList,
 String[] aliasPathnameList)

aliasGetPrimary

public String aliasGetPrimary()

aliasGetPrimary

public String aliasGetPrimary(String aliasPathname)

aliasRemove

public int aliasRemove(boolean removeAll)

aliasRemove

public int aliasRemove(String aliasPathname,
 boolean removeAll)

aliasRemoveList

public int aliasRemoveList(String[] aliasPathnameList)

aliasList

public String[] aliasList()

aliasList

public String[] aliasList(String aliasPathname)

zlocationRetrieve

public int zlocationRetrieve(DataContainer dataContainer)

zlocationStore

public int zlocationStore(DataContainer dataContainer)

numberArray

public int numberArray()

Xarray

public void Xarray(doubleArrayContainer X)

Yarray

public void Yarray(doubleArrayContainer[] Y)

Yarray

public void Yarray(doubleArrayContainer Y)

convertUnitSystem

public int convertUnitSystem(int unitSystem)

Convert the data in the recordData array to the unit system specified The data must have already been read before calling this function

status

public void status()

Overrides:

status in class HecDSSDataAttributes

copyRecordDataToContainer

protected void copyRecordDataToContainer(DataContainer dataContainer)

copyContainerToRecordData

public int copyContainerToRecordData(DataContainer dataContainer)

getRecordInfo

public HecDSSRecordInfo getRecordInfo()

Get information about an individual record (pathname) This is information that would be shown in a regular catalog and from a zcheck call. See HecDSSRecordInfo for what is returned This is for a single record, not an entire data set.

getRecordInfo

public HecDSSRecordInfo getRecordInfo(String pathname)

getRecordInfo

public boolean getRecordInfo(HecDSSRecordInfo recordInfo)

Get information about an individual record (pathname) This is information that would be shown in a regular catalog and from a zcheck call. See HecDSSRecordInfo for what is returned This is for a single record, not an entire data set.

getTSRecordInfo

public int getTSRecordInfo(HecTime start,
 HecTime end,
 stringContainer units,
 stringContainer type)