Package hec.heclib.dss

Class AbstractDssDataManager

java.lang.Object

hec.heclib.dss.AbstractDssDataManager

All Implemented Interfaces:

DssDataManager

Direct Known Subclasses:

LocalDssDataManager

public abstract class AbstractDssDataManager
extends Object
implements DssDataManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDssDataManager(IHecDSSUtilities dataManager)

Method Summary

Modifier and Type	Method	Description
List<DSSErrorMessage>	allSevereErrorMessages()
void	cancelProcess()
void	cancelSqueeze()
int	checkAllPathnames()
boolean	checkForSevereError()
int	checkLinks()
int	checkPathnameBins()
void	clearStatus()
void	close()
int	createNewCatalog(int catalogType)
IHecDSSUtilities	dataManager()	Returns either remote or local dataManager
void	done()
String	DSSFileName()	Returns either Remote or local call to DSSFileName()
String	DSSFileName(int i)
int	duplicateRecords(List<String> pathnameList, List<String> newPathnameList)
boolean	fileAccessible()
boolean	fileOpened()
void	fileStats()
int	forceMultiUserAccess()
String	getCatalogName(int catalogType)
boolean	getCatalogNeedsUpdate()
Color	getColor(int i)	Deprecated.
Component	getComponent(int index)	Deprecated.
List<CondensedReference>	getCondensedCatalog()
protected int	getDisplayUnitSystem()
String	getDSSFileName()	gets current dss filename
int	getDssFileVersion()	gets the version of the dss file opened by the DataManager.
String[]	getPathnameList(boolean forceUpdate)
int	getTabNum()	Deprecated.
boolean	getTimeSeriesExtents(String pathname, HecTime start, HecTime end)
TimeZone	getTimeZone()
String	getTitle()	Deprecated.
int	getTSRecordInfo(String pathname, HecTime start, HecTime end, stringContainer units, stringContainer type)
boolean	isExplicitlyClosed()
boolean	isSameFile(String dssFileName)
DSSErrorMessage	lastSevereErrorMessage()
int	numberRecords()
int	open()
int	readData(DataReference dataReference, GridContainer gridContainer)
int	readData(DataReference dataReference, TinContainer tinContainer)
short[]	readRawShorts(String pathname)
protected abstract List	readTinData(DSSIdentifier dssId, TinContainer tinContainer)
boolean	recordExists(String pathname)
boolean[]	recordsExist(List<String> pathnames)
int	recordType(String pathname)
Map<String,Integer>	recordTypes(String[] pathname)
int	renameRecords(List<String> pathnameList, List<String> newPathnameList)
int	searchDSSCatalog(String scanString, List<String> pathnameList)
int	searchDSSPaths(String scanString, List<String> pathnameList)
void	setCatalogNeedsUpdate(boolean catalogNeedsUpdate)
void	setDisplayUnitSystem(int unitSystem)
int	setDSSFileName(String dssFileName, boolean fileMustExist, int dssVersion)	Sets the dSSFileName attribute of the DssDataManager object
void	setForceNewCatalog(boolean newCatalog)	Sets the forceNewCatalog attribute of the DssDataManager object
void	setInterrupt(boolean interrupt)
void	setTimeZone(TimeZone timeZone)
int	squeeze()
boolean	writeAccess()
int	writeData(DataContainer dataContainer)
int	zinqir(String parameter)
void	zinqir(String parameter, stringContainer alpha, int[] numb)
void	zquery(String parameter, stringContainer alpha, int[] numb)
void	zset(String parameter, String alpha, int number)

Methods inherited from class java.lang.Object

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

Methods inherited from interface hec.heclib.dss.DssDataManager

checkForError, cleanDSSFileName, clearSevereError, convertVersion, copyFile, copyRecordsFrom, copyRecordsInto, delete, doesDSSFileExist, DssFileManagerStatus, exportFile, fileAccessInfo, getCatalog, getCondensedCatalog, getLastDeletePathnames, getMessageLevel, getProcessStatus, getRecordInfo, isRemote, lastErrorMessage, readData, readData, readData, readData, readData, readData, readData, readData, readGriddedData, readImage, readLocation, recordsUpdated, setDSSFileName, setDSSFileName, setMessageLevel, setUnit, undelete, undoLastDelete, writeData, writeData, writeData, writeData, writeData, writeFile, writeLocation

Constructor Details

AbstractDssDataManager

protected AbstractDssDataManager(IHecDSSUtilities dataManager)

Method Details

dataManager

public IHecDSSUtilities dataManager()

Description copied from interface: DssDataManager

Returns either remote or local dataManager

Specified by:

dataManager in interface DssDataManager

Returns:

Returns either HecDSSUtilitiesRemote or HecDSSUtilities

setDSSFileName

public int setDSSFileName(String dssFileName,
 boolean fileMustExist,
 int dssVersion)

Description copied from interface: DssDataManager

Sets the dSSFileName attribute of the DssDataManager object

Specified by:

setDSSFileName in interface DssDataManager

Parameters:

dssFileName - The new dSSFileName value

fileMustExist - The new dSSFileName value

Returns:

Description of the Returned Value

getDssFileVersion

public int getDssFileVersion()

Description copied from interface: DssDataManager

gets the version of the dss file opened by the DataManager.

Specified by:

getDssFileVersion in interface DssDataManager

setForceNewCatalog

public void setForceNewCatalog(boolean newCatalog)

Description copied from interface: DssDataManager

Sets the forceNewCatalog attribute of the DssDataManager object

Specified by:

setForceNewCatalog in interface DssDataManager

Parameters:

newCatalog - The new forceNewCatalog value

fileStats

public void fileStats()

Specified by:

fileStats in interface DssDataManager

setCatalogNeedsUpdate

public void setCatalogNeedsUpdate(boolean catalogNeedsUpdate)

Specified by:

setCatalogNeedsUpdate in interface DssDataManager

getCatalogNeedsUpdate

public boolean getCatalogNeedsUpdate()

Specified by:

getCatalogNeedsUpdate in interface DssDataManager

checkForSevereError

public boolean checkForSevereError()

Specified by:

checkForSevereError in interface DssDataManager

setDisplayUnitSystem

public void setDisplayUnitSystem(int unitSystem)

Specified by:

setDisplayUnitSystem in interface DssDataManager

getDisplayUnitSystem

protected int getDisplayUnitSystem()

setTimeZone

public void setTimeZone(TimeZone timeZone)

Specified by:

setTimeZone in interface DssDataManager

getTimeZone

public TimeZone getTimeZone()

Specified by:

getTimeZone in interface DssDataManager

createNewCatalog

public int createNewCatalog(int catalogType)

Specified by:

createNewCatalog in interface DssDataManager

getCatalogName

public String getCatalogName(int catalogType)

Specified by:

getCatalogName in interface DssDataManager

recordExists

public boolean recordExists(String pathname)

Specified by:

recordExists in interface DssDataManager

recordsExist

public boolean[] recordsExist(List<String> pathnames)

Specified by:

recordsExist in interface DssDataManager

done

public void done()

Specified by:

done in interface DssDataManager

lastSevereErrorMessage

public DSSErrorMessage lastSevereErrorMessage()

Specified by:

lastSevereErrorMessage in interface DssDataManager

allSevereErrorMessages

public List<DSSErrorMessage> allSevereErrorMessages()

Specified by:

allSevereErrorMessages in interface DssDataManager

cancelProcess

public void cancelProcess()

Specified by:

cancelProcess in interface DssDataManager

cancelSqueeze

public void cancelSqueeze()

Specified by:

cancelSqueeze in interface DssDataManager

setInterrupt

public void setInterrupt(boolean interrupt)

Specified by:

setInterrupt in interface DssDataManager

clearStatus

public void clearStatus()

Specified by:

clearStatus in interface DssDataManager

close

public void close()

Specified by:

close in interface DssDataManager

isExplicitlyClosed

public boolean isExplicitlyClosed()

Specified by:

isExplicitlyClosed in interface DssDataManager

checkAllPathnames

public int checkAllPathnames()

Specified by:

checkAllPathnames in interface DssDataManager

checkLinks

public int checkLinks()

Specified by:

checkLinks in interface DssDataManager

checkPathnameBins

public int checkPathnameBins()

Specified by:

checkPathnameBins in interface DssDataManager

duplicateRecords

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

Specified by:

duplicateRecords in interface DssDataManager

getDSSFileName

public String getDSSFileName()

Description copied from interface: DssDataManager

gets current dss filename

Specified by:

getDSSFileName in interface DssDataManager

Returns:

Returns DSS filename

DSSFileName

public String DSSFileName()

Description copied from interface: DssDataManager

Returns either Remote or local call to DSSFileName()

Specified by:

DSSFileName in interface DssDataManager

Returns:

Returns DSS filename

isSameFile

public boolean isSameFile(String dssFileName)

Specified by:

isSameFile in interface DssDataManager

fileOpened

public boolean fileOpened()

Specified by:

fileOpened in interface DssDataManager

open

public int open()

Specified by:

open in interface DssDataManager

fileAccessible

public boolean fileAccessible()

Specified by:

fileAccessible in interface DssDataManager

getTSRecordInfo

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

Specified by:

getTSRecordInfo in interface DssDataManager

getTimeSeriesExtents

public boolean getTimeSeriesExtents(String pathname,
 HecTime start,
 HecTime end)

Specified by:

getTimeSeriesExtents in interface DssDataManager

numberRecords

public int numberRecords()

Specified by:

numberRecords in interface DssDataManager

readData

public int readData(DataReference dataReference,
 GridContainer gridContainer)

Specified by:

readData in interface DssDataManager

readData

public int readData(DataReference dataReference,
 TinContainer tinContainer)

Specified by:

readData in interface DssDataManager

readTinData

protected abstract List readTinData(DSSIdentifier dssId,
 TinContainer tinContainer)

readRawShorts

public short[] readRawShorts(String pathname)

Specified by:

readRawShorts in interface DssDataManager

recordType

public int recordType(String pathname)

Specified by:

recordType in interface DssDataManager

recordTypes

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

Specified by:

recordTypes in interface DssDataManager

renameRecords

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

Specified by:

renameRecords in interface DssDataManager

getPathnameList

public String[] getPathnameList(boolean forceUpdate)

Specified by:

getPathnameList in interface DssDataManager

searchDSSCatalog

public int searchDSSCatalog(String scanString,
 List<String> pathnameList)

Specified by:

searchDSSCatalog in interface DssDataManager

searchDSSPaths

public int searchDSSPaths(String scanString,
 List<String> pathnameList)

Specified by:

searchDSSPaths in interface DssDataManager

getCondensedCatalog

public List<CondensedReference> getCondensedCatalog()

Specified by:

getCondensedCatalog in interface DssDataManager

forceMultiUserAccess

public int forceMultiUserAccess()

Specified by:

forceMultiUserAccess in interface DssDataManager

squeeze

public int squeeze()

Specified by:

squeeze in interface DssDataManager

writeAccess

public boolean writeAccess()

Specified by:

writeAccess in interface DssDataManager

writeData

public int writeData(DataContainer dataContainer)

Specified by:

writeData in interface DssDataManager

zinqir

public int zinqir(String parameter)

Specified by:

zinqir in interface DssDataManager

zinqir

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

Specified by:

zinqir in interface DssDataManager

zset

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

Specified by:

zset in interface DssDataManager

DSSFileName

public String DSSFileName(int i)

Specified by:

DSSFileName in interface DssDataManager

zquery

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

Specified by:

zquery in interface DssDataManager

getColor

@Deprecated
public Color getColor(int i)

Deprecated.

getComponent

@Deprecated
public Component getComponent(int index)

Deprecated.

getTabNum

@Deprecated
public int getTabNum()

Deprecated.

getTitle

@Deprecated
public String getTitle()

Deprecated.

Alternative method to get the filename

Returns:

Description of the Returned Value