Package hec.heclib.dss

Class HecDSSUtilities

java.lang.Object

hec.heclib.dss.HecDSSFileAccess

hec.heclib.dss.HecDssCatalog

hec.heclib.dss.HecDSSDataAttributes

hec.heclib.dss.HecDataManager

hec.heclib.dss.HecDSSUtilities

All Implemented Interfaces:

HecDssListener, IHecDSSUtilities, Cloneable, EventListener

public class HecDSSUtilities
extends HecDataManager
implements IHecDSSUtilities

HecDSSUtilities is a HecDataManager with utility features such as squeezing, and copying records between DSS files

Nested Class Summary

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

HecDssCatalog.WriteCatalogFileRunnable

Field Summary

Fields inherited from class hec.heclib.dss.HecDataManager

_recordData, logFileName, messageUnit

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

Fields inherited from interface hec.heclib.dss.IHecDSSUtilities

STATUS_OKAY

Constructor Summary

Constructors

Constructor	Description
HecDSSUtilities()

Method Summary

Modifier and Type	Method	Description
void	cancelProcess()
int	cancelSqueeze()
int	checkFile()
boolean	checkForSevereDssError()
int	convertVersion(String convertFileName)
int	copyFile(HecDataManager toDataManager)
int	copyFile(String toDSSFilename)
protected int	copyRecords(int[] fromDSSTable, int[] toDSSTable, Vector pathnameList)	copyRecords is used for low level record copy between two dss files.
protected int	copyRecords(int[] fromDSSTable, int[] toDSSTable, Vector pathnameListfrom, Vector pathnameListTo)	copyRecords is used for low level record copy between two dss files.
int	copyRecordsFrom(HecDataManager toDataManager, List<String> pathnameList)
int	copyRecordsFrom(HecDataManager toDataManager, List<String> pathnameListFrom, List<String> pathnameListTo)
int	copyRecordsFrom(String toDSSFilename, List<String> pathnameList)	copyRecordsFrom copies from HecDSSUtilities instance to the toDSSFilename
int	copyRecordsInto(HecDataManager fromDataManager, List<String> pathnameList)
int	copyRecordsInto(String fromDSSFilename, List<String> pathnameList)
int	delete(List<String> pathnameList)
void	dss_zquery(String parameter, stringContainer alpha, int[] numb)
void	dss_zset(String parameter, String alpha, int number)
int	duplicateRecords(List<String> pathnameList, List<String> newPathnameList)
int	fileAccessInfo(int[] accessMode, int[] numberAccesses, int[] numberWrites, int[] pidsArray, int[] modesArray, int[] numberPids)
int	fileStats()
Vector<CondensedReference>	getCondensedCatalog()
Vector<CondensedReference>	getCondensedCatalog(String[] sortedPathnames, boolean querryTimes)
List<String>	getDeletedRecords()
Vector	getLastDeletePathnames()
short[]	readRawShorts(String pathname)
int	renameRecords(List<String> pathnameList, List<String> newPathnameList)
int	squeeze()
int	squeeze(boolean onlyIfNeeded)
boolean	squeezeNeeded()
int	undelete(List<String> pathnames)
int	undoLastDelete()

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, displayLogFile, done, flushMessageFile, generateLogFileName, getLogFileName, getRecordInfo, getRecordInfo, getRecordInfo, getTSRecordInfo, numberArray, release, release, setLogFile, setMessageFile, setProgramName, status, windMessageFile, Xarray, Yarray, Yarray, zlocationRetrieve, zlocationStore

Methods inherited from class hec.heclib.dss.HecDSSDataAttributes

aPart, arrayEndTime, arrayStartTime, bPart, clearDefaultParts, convertDoubleUnits, convertUnits, cPart, createArrayObject, createObject, createPairedDataObject, createTextObject, createTimeSeriesObject, defaultAPart, defaultBPart, defaultCPart, defaultDPart, defaultEPart, defaultFPart, dirty, dPart, endTime, ePart, fPart, getLastWriteTime, getLastWriteTime, getLastWriteTimeMillis, getLastWriteTimeMillis, getRecordBasics, isGridRecord, isTimeWindowSet, localUnitSystem, pathname, pathnameDataType, readRawBytes, readRawBytes, readRawRecord, readRawShorts, readRawShorts, recordExists, recordsUpdated, recordType, recordType, recordTypes, setAPart, setBPart, setCPart, setDefaultAPart, setDefaultBPart, setDefaultCPart, setDefaultDPart, setDefaultEPart, setDefaultFPart, setDefaultPathnameParts, setDefaultTimeWindow, setDefaultTimeWindow, setDPart, setDSSFileName, setEndTime, setEPart, setFPart, setLocalUnitSystem, setPathname, setPathnameParts, setStartTime, setTimeWindow, setTimeWindow, startTime, writeRawRecord

Methods inherited from class hec.heclib.dss.HecDssCatalog

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

Methods inherited from class hec.heclib.dss.HecDSSFileAccess

allSevereErrorMessages, appendNameToDirectory, catchSevereErrors, checkAccessReset, 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, isFileRemote, lastSevereErrorMessage, nextTimeSeriesPathname, numberRecords, open, open, processStatus, requestSecondAccess, setDefaultDirectory, setDefaultDSSFileName, setDss, setDSSFileName, setDSSFileName, setDSSFileName, setInterrupt, setMessageLevel, setSpaceReclaimation, setSpaceReclaimationPerm, 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

Methods inherited from interface hec.heclib.dss.IHecDSSUtilities

allSevereErrorMessages, checkAllPathnames, checkForError, checkLinks, checkPathnameBins, clearError, clearSevereError, clearStatus, close, createNewCatalog, delete, done, DSSFileName, fileAccessible, fileOpened, forceMultiUserAccess, getCatalogName, getDssFileVersion, getPathnameList, getProcessStatus, getTimeSeriesExtents, getTSRecordInfo, isCatalogValid, lastSevereErrorMessage, nextTimeSeriesPathname, numberRecords, open, recordExists, recordType, recordTypes, searchDSSCatalog, searchDSSPaths, setDSSFileName, setDSSFileName, setForceNewCatalog, setInterrupt, setPathname, writeAccess, zinqir, zinqir

Constructor Details

HecDSSUtilities

public HecDSSUtilities()

Method Details

fileAccessInfo

public int fileAccessInfo(int[] accessMode,
 int[] numberAccesses,
 int[] numberWrites,
 int[] pidsArray,
 int[] modesArray,
 int[] numberPids)

fileStats

public int fileStats()

Specified by:

fileStats in interface IHecDSSUtilities

checkFile

public int checkFile()

delete

public int delete(List<String> pathnameList)

Specified by:

delete in interface IHecDSSUtilities

getDeletedRecords

public List<String> getDeletedRecords()

undelete

public int undelete(List<String> pathnames)

Specified by:

undelete in interface IHecDSSUtilities

undoLastDelete

public int undoLastDelete()

Specified by:

undoLastDelete in interface IHecDSSUtilities

copyRecordsInto

public int copyRecordsInto(HecDataManager fromDataManager,
 List<String> pathnameList)

copyRecordsInto

public int copyRecordsInto(String fromDSSFilename,
 List<String> pathnameList)

Specified by:

copyRecordsInto in interface IHecDSSUtilities

copyRecordsFrom

public int copyRecordsFrom(HecDataManager toDataManager,
 List<String> pathnameList)

copyRecordsFrom

public int copyRecordsFrom(HecDataManager toDataManager,
 List<String> pathnameListFrom,
 List<String> pathnameListTo)

copyRecordsFrom

public int copyRecordsFrom(String toDSSFilename,
 List<String> pathnameList)

Description copied from interface: IHecDSSUtilities

copyRecordsFrom copies from HecDSSUtilities instance to the toDSSFilename

Specified by:

copyRecordsFrom in interface IHecDSSUtilities

Parameters:

toDSSFilename - destination of records

pathnameList - list of paths to copy

Returns:

returns the number of records copied.

copyFile

public int copyFile(HecDataManager toDataManager)

copyFile

public int copyFile(String toDSSFilename)

Specified by:

copyFile in interface IHecDSSUtilities

getLastDeletePathnames

public Vector getLastDeletePathnames()

Specified by:

getLastDeletePathnames in interface IHecDSSUtilities

copyRecords

protected int copyRecords(int[] fromDSSTable,
 int[] toDSSTable,
 Vector pathnameList)

copyRecords is used for low level record copy between two dss files.

Parameters:

fromDSSTable -

toDSSTable -

pathnameList -

Returns:

returns the number of records copied.

copyRecords

protected int copyRecords(int[] fromDSSTable,
 int[] toDSSTable,
 Vector pathnameListfrom,
 Vector pathnameListTo)

copyRecords is used for low level record copy between two dss files. WARNING: if the dss files are different versions grid records are not copied (grids are copied in calling method copyRecords(HecDataManager src,HecDataManager dest,....)

Parameters:

fromDSSTable - source dss ifltab

toDSSTable - destination ifltab

pathnameListfrom - list of paths in source

pathnameListTo - path name to save in destination

Returns:

returns the number of records copied.

duplicateRecords

public int duplicateRecords(List<String> pathnameList,
 List<String> newPathnameList)

Specified by:

duplicateRecords in interface IHecDSSUtilities

renameRecords

public int renameRecords(List<String> pathnameList,
 List<String> newPathnameList)

Specified by:

renameRecords in interface IHecDSSUtilities

convertVersion

public int convertVersion(String convertFileName)

squeeze

public int squeeze()

Specified by:

squeeze in interface IHecDSSUtilities

squeeze

public int squeeze(boolean onlyIfNeeded)

cancelSqueeze

public int cancelSqueeze()

Specified by:

cancelSqueeze in interface IHecDSSUtilities

squeezeNeeded

public boolean squeezeNeeded()

cancelProcess

public void cancelProcess()

Specified by:

cancelProcess in interface IHecDSSUtilities

getCondensedCatalog

public Vector<CondensedReference> getCondensedCatalog()

Specified by:

getCondensedCatalog in interface IHecDSSUtilities

getCondensedCatalog

public Vector<CondensedReference> getCondensedCatalog(String[] sortedPathnames,
 boolean querryTimes)

checkForSevereDssError

public boolean checkForSevereDssError()

Specified by:

checkForSevereDssError in interface IHecDSSUtilities

readRawShorts

public short[] readRawShorts(String pathname)

Specified by:

readRawShorts in interface IHecDSSUtilities

dss_zset

public void dss_zset(String parameter,
 String alpha,
 int number)

Specified by:

dss_zset in interface IHecDSSUtilities

dss_zquery

public void dss_zquery(String parameter,
 stringContainer alpha,
 int[] numb)

Specified by:

dss_zquery in interface IHecDSSUtilities