Package hec.heclib.dss

Class HecDSSDataAttributes

java.lang.Object

hec.heclib.dss.HecDSSFileAccess

hec.heclib.dss.HecDssCatalog

hec.heclib.dss.HecDSSDataAttributes

All Implemented Interfaces:

HecDssListener, Cloneable, EventListener

Direct Known Subclasses:

HecDataManager

public class HecDSSDataAttributes
extends HecDssCatalog

HecDSSDataAttributes contains various data utility methods and constants. includes: data type and other constants, path utilities, factory methods for IO objects, and time window methods.

Nested Class Summary

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

HecDssCatalog.WriteCatalogFileRunnable

Field Summary

Fields

Modifier and Type	Field	Description
protected HecTime	_arrayEndTime
protected int	_arraySize
protected HecTime	_arrayStartTime
protected int	_checkedNumber
protected int	_dataLengthInts
protected int	_dataType
protected static HecTime	_defaultEndTime
protected static HecTime	_defaultStartTime
protected int	_desiredArraySize
protected boolean	_dirty
protected DSSPathname	_dssPathname
protected HecTime	_endTime
protected int	_localUnitSystem
protected boolean	_recordExists
protected int	_recordType
protected int[]	_slashPosition
protected HecTime	_startTime
protected boolean	_timeSeries
protected boolean	_timeWindowSet
protected String	_typeX
protected String	_unitsX
static final int	ALBERS
static final int	ALBERS_GRID
static final int	ALBERS_GRID_WITH_TIME
static final int	DOUBLE_ARRAY
static final int	ENGLISH_UNITS
static final int	ERROR
static final int	FILE
static final int	FLOAT_ARRAY
static final int	HRAP
static final int	HRAP_GRID
static final int	HRAP_GRID_WITH_TIME
static final int	IMAGE
static final int	INT_ARRAY
static final int	IRREGULAR_TIME_PATTERN
static final int	IRREGULAR_TIME_SERIES
static final int	IRREGULAR_TIME_SERIES_DOUBLES
static final int	LOCATION_LEVEL
static final int	PAIRED
static final int	PAIRED_DOUBLES
static final int	REGULAR_TIME_PATTERN
static final int	REGULAR_TIME_SERIES
static final int	REGULAR_TIME_SERIES_DOUBLES
static final int	SI_UNITS
static final int	SINGLE_VALUE
static final int	SPECIFIED_GRID
static final int	SPECIFIED_GRID_TYPE
static final int	SPECIFIED_GRID_WITH_TIME
static final int	TEXT
static final int	UNDEFINED_GRID
static final int	UNDEFINED_GRID_TYPE
static final int	UNDEFINED_GRID_WITH_TIME
static final int	UNDEFINED_UNITS
static final int	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
HecDSSDataAttributes()

Method Summary

Modifier and Type	Method	Description
String	aPart()
HecTime	arrayEndTime()
HecTime	arrayStartTime()
String	bPart()
static void	clearDefaultParts()
static int	convertDoubleUnits(double[] data, int number, int fromUnits, int toUnits)
static int	convertUnits(double[] data, int number, int fromUnitSyst, int toUnitSyst, stringContainer units)
String	cPart()
HecDssArray	createArrayObject(String pathname)
HecDataManager	createObject(String pathname)
HecPairedData	createPairedDataObject(String pathname)
HecDssText	createTextObject(String pathname)
HecTimeSeries	createTimeSeriesObject(String pathname)
static String	defaultAPart()
static String	defaultBPart()
static String	defaultCPart()
static String	defaultDPart()
static String	defaultEPart()
static String	defaultFPart()
boolean	dirty()
String	dPart()
HecTime	endTime()
String	ePart()
String	fPart()
HecTime	getLastWriteTime()
HecTime	getLastWriteTime(String pathname)
long	getLastWriteTimeMillis()
long	getLastWriteTimeMillis(String pathname)
HecDSSRecordBasics	getRecordBasics()
boolean	isGridRecord(String pathname)	Determines if record for the given pathname is represents a grid.
boolean	isTimeWindowSet()
int	localUnitSystem()
String	pathname()
static int	pathnameDataType(String pathname)	Tries to determine data type quickly from pathname only, without accessing the DSS file.
byte[]	readRawBytes()
byte[]	readRawBytes(int[] internalHeader, int limitInternalHeader, int[] numberInternalHeader, int[] compressionHeader, int limitCompressionHeader, int[] numberCompressionHeader, int[] userHeader, int limitUserHeader, int[] numberUserHeader, int[] stat)
int	readRawRecord(RawContainer rawContainer, boolean getLengthsOnly)
short[]	readRawShorts()
short[]	readRawShorts(int[] internalHeader, int limitInternalHeader, int[] numberInternalHeader, int[] compressionHeader, int limitCompressionHeader, int[] numberCompressionHeader, int[] userHeader, int limitUserHeader, int[] numberUserHeader, int[] stat)
boolean	recordExists(String pathname)
int	recordsUpdated(long startTime, List<String> pathnames, List<Long> updateTimes, List<Integer> recordTypes)	Retrieves infomation about record updated since the specified time.
int	recordType()
int	recordType(String pathname)
Map<String,Integer>	recordTypes(String[] pathnames)
void	setAPart(String partName)
void	setBPart(String partName)
void	setCPart(String partName)
static void	setDefaultAPart(String partName)
static void	setDefaultBPart(String partName)
static void	setDefaultCPart(String partName)
static void	setDefaultDPart(String partName)
static int	setDefaultEPart(String partName)
static void	setDefaultFPart(String partName)
int	setDefaultPathnameParts(String pathnameParts)
void	setDefaultTimeWindow(HecTime startTime, HecTime endTime)
int	setDefaultTimeWindow(String userLine)
void	setDPart(String partName)
int	setDSSFileName(String dssFileName, boolean fileMustExist)
void	setEndTime(HecTime endTime)
int	setEPart(String partName)
void	setFPart(String partName)
void	setLocalUnitSystem(int localUnitSystem)
int	setPathname(String path)
int	setPathnameParts(String pathnameParts)
void	setStartTime(HecTime startTime)
void	setTimeWindow(HecTime startTime, HecTime endTime)
int	setTimeWindow(String userLine)
HecTime	startTime()
void	status()
int	writeRawRecord(RawContainer rawContainer)

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, done, 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

Field Details

ERROR

public static final int ERROR

See Also:

• Constant Field Values

UNKNOWN

public static final int UNKNOWN

See Also:

• Constant Field Values

INT_ARRAY

public static final int INT_ARRAY

See Also:

• Constant Field Values

FLOAT_ARRAY

public static final int FLOAT_ARRAY

See Also:

• Constant Field Values

DOUBLE_ARRAY

public static final int DOUBLE_ARRAY

See Also:

• Constant Field Values

LOCATION_LEVEL

public static final int LOCATION_LEVEL

See Also:

• Constant Field Values

REGULAR_TIME_SERIES

public static final int REGULAR_TIME_SERIES

See Also:

• Constant Field Values

REGULAR_TIME_PATTERN

public static final int REGULAR_TIME_PATTERN

See Also:

• Constant Field Values

REGULAR_TIME_SERIES_DOUBLES

public static final int REGULAR_TIME_SERIES_DOUBLES

See Also:

• Constant Field Values

IRREGULAR_TIME_SERIES

public static final int IRREGULAR_TIME_SERIES

See Also:

• Constant Field Values

IRREGULAR_TIME_PATTERN

public static final int IRREGULAR_TIME_PATTERN

See Also:

• Constant Field Values

IRREGULAR_TIME_SERIES_DOUBLES

public static final int IRREGULAR_TIME_SERIES_DOUBLES

See Also:

• Constant Field Values

PAIRED

public static final int PAIRED

See Also:

• Constant Field Values

PAIRED_DOUBLES

public static final int PAIRED_DOUBLES

See Also:

• Constant Field Values

TEXT

public static final int TEXT

See Also:

• Constant Field Values

SINGLE_VALUE

public static final int SINGLE_VALUE

See Also:

• Constant Field Values

UNDEFINED_GRID_WITH_TIME

public static final int UNDEFINED_GRID_WITH_TIME

See Also:

• Constant Field Values

UNDEFINED_GRID

public static final int UNDEFINED_GRID

See Also:

• Constant Field Values

UNDEFINED_GRID_TYPE

public static final int UNDEFINED_GRID_TYPE

See Also:

• Constant Field Values

HRAP_GRID_WITH_TIME

public static final int HRAP_GRID_WITH_TIME

See Also:

• Constant Field Values

HRAP_GRID

public static final int HRAP_GRID

See Also:

• Constant Field Values

HRAP

public static final int HRAP

See Also:

• Constant Field Values

ALBERS_GRID_WITH_TIME

public static final int ALBERS_GRID_WITH_TIME

See Also:

• Constant Field Values

ALBERS_GRID

public static final int ALBERS_GRID

See Also:

• Constant Field Values

ALBERS

public static final int ALBERS

See Also:

• Constant Field Values

SPECIFIED_GRID_WITH_TIME

public static final int SPECIFIED_GRID_WITH_TIME

See Also:

• Constant Field Values

SPECIFIED_GRID

public static final int SPECIFIED_GRID

See Also:

• Constant Field Values

SPECIFIED_GRID_TYPE

public static final int SPECIFIED_GRID_TYPE

See Also:

• Constant Field Values

FILE

public static final int FILE

See Also:

• Constant Field Values

IMAGE

public static final int IMAGE

See Also:

• Constant Field Values

UNDEFINED_UNITS

public static final int UNDEFINED_UNITS

See Also:

• Constant Field Values

ENGLISH_UNITS

public static final int ENGLISH_UNITS

See Also:

• Constant Field Values

SI_UNITS

public static final int SI_UNITS

See Also:

• Constant Field Values

_defaultStartTime

protected static HecTime _defaultStartTime

_defaultEndTime

protected static HecTime _defaultEndTime

_dssPathname

protected DSSPathname _dssPathname

_dirty

protected boolean _dirty

_slashPosition

protected int[] _slashPosition

_startTime

protected HecTime _startTime

_endTime

protected HecTime _endTime

_arrayStartTime

protected HecTime _arrayStartTime

_arrayEndTime

protected HecTime _arrayEndTime

_timeWindowSet

protected boolean _timeWindowSet

_arraySize

protected int _arraySize

_desiredArraySize

protected int _desiredArraySize

_recordType

protected int _recordType

_checkedNumber

protected int _checkedNumber

_dataLengthInts

protected int _dataLengthInts

_dataType

protected int _dataType

_localUnitSystem

protected int _localUnitSystem

_recordExists

protected boolean _recordExists

_timeSeries

protected boolean _timeSeries

_unitsX

protected String _unitsX

_typeX

protected String _typeX

Constructor Details

HecDSSDataAttributes

public HecDSSDataAttributes()

Method Details

createObject

public HecDataManager createObject(String pathname)

createTimeSeriesObject

public HecTimeSeries createTimeSeriesObject(String pathname)

createPairedDataObject

public HecPairedData createPairedDataObject(String pathname)

createTextObject

public HecDssText createTextObject(String pathname)

createArrayObject

public HecDssArray createArrayObject(String pathname)

setDSSFileName

public int setDSSFileName(String dssFileName,
 boolean fileMustExist)

Overrides:

setDSSFileName in class HecDSSFileAccess

setDefaultAPart

public static void setDefaultAPart(String partName)

setDefaultBPart

public static void setDefaultBPart(String partName)

setDefaultCPart

public static void setDefaultCPart(String partName)

setDefaultDPart

public static void setDefaultDPart(String partName)

setDefaultEPart

public static int setDefaultEPart(String partName)

setDefaultFPart

public static void setDefaultFPart(String partName)

clearDefaultParts

public static void clearDefaultParts()

defaultAPart

public static String defaultAPart()

defaultBPart

public static String defaultBPart()

defaultCPart

public static String defaultCPart()

defaultDPart

public static String defaultDPart()

defaultEPart

public static String defaultEPart()

defaultFPart

public static String defaultFPart()

aPart

public String aPart()

bPart

public String bPart()

cPart

public String cPart()

dPart

public String dPart()

ePart

public String ePart()

fPart

public String fPart()

pathname

public String pathname()

Overrides:

pathname in class HecDssCatalog

setAPart

public void setAPart(String partName)

setBPart

public void setBPart(String partName)

setCPart

public void setCPart(String partName)

setDPart

public void setDPart(String partName)

setEPart

public int setEPart(String partName)

setFPart

public void setFPart(String partName)

setPathname

public int setPathname(String path)

setPathnameParts

public int setPathnameParts(String pathnameParts)

setDefaultPathnameParts

public int setDefaultPathnameParts(String pathnameParts)

dirty

public boolean dirty()

pathnameDataType

public static int pathnameDataType(String pathname)

Tries to determine data type quickly from pathname only, without accessing the DSS file. This is meant to be quick For a more comprehensive and accurate value, use recordType.

Parameters:

pathname - String

Returns:

int

recordsUpdated

public int recordsUpdated(long startTime,
 List<String> pathnames,
 List<Long> updateTimes,
 List<Integer> recordTypes)

Retrieves infomation about record updated since the specified time.

Any of the vector parameters may be null if that information is not required. Any of the vectors that are not null are cleared before being populated.

Parameters:

startTime - Time after which to report updated records - in Java milliseconds

pathnames - The list of pathnames of the records that have been updated - may be null.

updateTimes - The list of update times of the records that have been updated - may be null.

recordTypes - The list of types of the records that have been updated - may be null.

Returns:

Zero if successful.

recordTypes

public Map<String,Integer> recordTypes(String[] pathnames)

recordType

public int recordType(String pathname)

recordType

public int recordType()

isGridRecord

public boolean isGridRecord(String pathname)

Determines if record for the given pathname is represents a grid.

Parameters:

pathname -

Returns:

recordExists

public boolean recordExists(String pathname)

getLastWriteTimeMillis

public long getLastWriteTimeMillis()

getLastWriteTimeMillis

public long getLastWriteTimeMillis(String pathname)

getLastWriteTime

public HecTime getLastWriteTime()

getLastWriteTime

public HecTime getLastWriteTime(String pathname)

getRecordBasics

public HecDSSRecordBasics getRecordBasics()

setStartTime

public void setStartTime(HecTime startTime)

setEndTime

public void setEndTime(HecTime endTime)

setTimeWindow

public void setTimeWindow(HecTime startTime,
 HecTime endTime)

setTimeWindow

public int setTimeWindow(String userLine)

setDefaultTimeWindow

public void setDefaultTimeWindow(HecTime startTime,
 HecTime endTime)

setDefaultTimeWindow

public int setDefaultTimeWindow(String userLine)

startTime

public HecTime startTime()

arrayStartTime

public HecTime arrayStartTime()

endTime

public HecTime endTime()

arrayEndTime

public HecTime arrayEndTime()

isTimeWindowSet

public boolean isTimeWindowSet()

setLocalUnitSystem

public void setLocalUnitSystem(int localUnitSystem)

localUnitSystem

public int localUnitSystem()

convertUnits

public static int convertUnits(double[] data,
 int number,
 int fromUnitSyst,
 int toUnitSyst,
 stringContainer units)

convertDoubleUnits

public static int convertDoubleUnits(double[] data,
 int number,
 int fromUnits,
 int toUnits)

status

public void status()

readRawBytes

public byte[] readRawBytes()

readRawBytes

public byte[] readRawBytes(int[] internalHeader,
 int limitInternalHeader,
 int[] numberInternalHeader,
 int[] compressionHeader,
 int limitCompressionHeader,
 int[] numberCompressionHeader,
 int[] userHeader,
 int limitUserHeader,
 int[] numberUserHeader,
 int[] stat)

readRawRecord

public int readRawRecord(RawContainer rawContainer,
 boolean getLengthsOnly)

writeRawRecord

public int writeRawRecord(RawContainer rawContainer)

readRawShorts

public short[] readRawShorts()

readRawShorts

public short[] readRawShorts(int[] internalHeader,
 int limitInternalHeader,
 int[] numberInternalHeader,
 int[] compressionHeader,
 int limitCompressionHeader,
 int[] numberCompressionHeader,
 int[] userHeader,
 int limitUserHeader,
 int[] numberUserHeader,
 int[] stat)