Package hec.heclib.dss

Interface DssDataManager

All Known Implementing Classes:
AbstractDssDataManager, LocalDssDataManager
public interface DssDataManager

  • Method Details

    • isRemoteFileName

      static boolean isRemoteFileName(String dssFileName)

    • setDSSFileName

      default void setDSSFileName(String name)
      Sets the dSSFileName attribute of the DssDataManager object
      Parameters:
      name - The new dSSFileName value

    • setDSSFileName

      default int setDSSFileName(String dssFileName, boolean fileMustExist)

    • setDSSFileName

      int setDSSFileName(String dssFileName, boolean fileMustExist, int dssVersion)
      Sets the dSSFileName attribute of the DssDataManager object
      Parameters:
      dssFileName - The new dSSFileName value
      fileMustExist - The new dSSFileName value
      Returns:
      Description of the Returned Value

    • getDssFileVersion

      int getDssFileVersion()
      gets the version of the dss file opened by the DataManager.

    • setForceNewCatalog

      void setForceNewCatalog(boolean newCatalog)
      Sets the forceNewCatalog attribute of the DssDataManager object
      Parameters:
      newCatalog - The new forceNewCatalog value

    • setMessageLevel

      void setMessageLevel(int level)
      Sets the messageLevel attribute of the DssDataManager object
      Parameters:
      level - The new messageLevel value

    • getMessageLevel

      int getMessageLevel()

    • setUnit

      void setUnit(int unit)
      Sets the unit attribute of the DssDataManager object
      Parameters:
      unit - The new unit value

    • fileStats

      void fileStats()

    • fileAccessInfo

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

    • getLastDeletePathnames

      List<String> getLastDeletePathnames()
      Gets the pasteListPathnames attribute of the DssDataManager object
      Returns:
      The pasteListPathnames value

    • dataManager

      IHecDSSUtilities dataManager()
      Returns either remote or local dataManager
      Returns:
      Returns either HecDSSUtilitiesRemote or HecDSSUtilities

    • setCatalogNeedsUpdate

      void setCatalogNeedsUpdate(boolean catalogNeedsUpdate)

    • getCatalogNeedsUpdate

      boolean getCatalogNeedsUpdate()

    • DssFileManagerStatus

      List<HecDSSFileData> DssFileManagerStatus()

    • checkForSevereError

      boolean checkForSevereError()

    • checkForError

      int checkForError()

    • setDisplayUnitSystem

      void setDisplayUnitSystem(int unitSystem)

    • setTimeZone

      void setTimeZone(TimeZone timeZone)

    • getTimeZone

      TimeZone getTimeZone()

    • createNewCatalog

      int createNewCatalog(int catalogType)

    • getCatalogName

      String getCatalogName(int catalogType)

    • recordsUpdated

      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.

    • recordExists

      boolean recordExists(String pathname)

    • recordsExist

      boolean[] recordsExist(List<String> pathnames)

    • clearSevereError

      void clearSevereError()

    • done

      void done()

    • lastSevereErrorMessage

      DSSErrorMessage lastSevereErrorMessage()

    • lastErrorMessage

      DSSErrorMessage lastErrorMessage()

    • allSevereErrorMessages

      List<DSSErrorMessage> allSevereErrorMessages()

    • cancelProcess

      void cancelProcess()

    • cancelSqueeze

      void cancelSqueeze()

    • getProcessStatus

      void getProcessStatus(int[] numberRecs, int[] currentRec)

    • setInterrupt

      void setInterrupt(boolean interrupt)

    • clearStatus

      void clearStatus()

    • cleanDSSFileName

      boolean cleanDSSFileName(String inName, stringContainer outName)

    • close

      void close()

    • isExplicitlyClosed

      boolean isExplicitlyClosed()

    • checkAllPathnames

      int checkAllPathnames()

    • checkLinks

      int checkLinks()

    • checkPathnameBins

      int checkPathnameBins()

    • copyFile

      int copyFile(DssDataManager dataManager, String secondDSSFilename)

    • copyRecordsFrom

      int copyRecordsFrom(DssDataManager toDataManager, String toDSSFilename, List<String> pathnameList)

    • copyRecordsInto

      int copyRecordsInto(DssDataManager fromDataManager, String fromDSSFilename, List<String> pathnameList)

    • delete

      int delete(List<String> pathnameList)

    • doesDSSFileExist

      boolean doesDSSFileExist(String DSSFileName)

    • duplicateRecords

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

    • getDSSFileName

      String getDSSFileName()
      gets current dss filename
      Returns:
      Returns DSS filename

    • DSSFileName

      String DSSFileName()
      Returns either Remote or local call to DSSFileName()
      Returns:
      Returns DSS filename

    • isSameFile

      boolean isSameFile(String dssFileName)

    • fileOpened

      boolean fileOpened()

    • open

      int open()

    • fileAccessible

      boolean fileAccessible()

    • getTSRecordInfo

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

    • getTimeSeriesExtents

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

    • numberRecords

      int numberRecords()

    • readData

      default int readData(DataReference dataReference, TimeSeriesContainer timeSeriesContainer)

    • readData

      default int[] readData(ArrayList<DataReference> dataReferenceList, ArrayList<TimeSeriesContainer> timeSeriesContainerList, boolean trimMissing)

    • readData

      int readData(DataReference dataReference, TimeSeriesContainer timeSeriesContainer, boolean trimMissing)
      Parameters:
      trimMissing - Trim missing data from start and end of regular time series

    • readData

      int readData(DataReference dataReference, TimeSeriesCollectionContainer timeSeriesCollectionContainer, boolean trimMissing)

    • readData

      int readData(DataReference dataReference, PairedDataContainer pairedDataContainer)

    • readData

      int readData(DataReference dataReference, TextContainer textContainer)

    • readData

      int readData(DataReference dataReference, ArrayContainer arrayContainer)

    • readData

      int readData(DataReference dataReference, DssFileContainer fileContainer)

    • readData

      int readData(DataReference dataReference, GridContainer gridContainer)

    • readData

      int readData(DataReference dataReference, TinContainer tinContainer)

    • readRawShorts

      short[] readRawShorts(String pathname)

    • getRecordInfo

      boolean getRecordInfo(DataReference dataReference, HecDSSRecordInfo recordInfo)

    • writeData

      int writeData(TextContainer textContainer)

    • readGriddedData

      List readGriddedData(DSSIdentifier dssId)

    • recordType

      int recordType(String pathname)

    • recordTypes

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

    • renameRecords

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

    • getPathnameList

      String[] getPathnameList(boolean forceUpdate)

    • getCatalog

      String[] getCatalog(boolean sorted, String pathWithWildChars)

    • searchDSSCatalog

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

    • searchDSSPaths

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

    • getCondensedCatalog

      List<CondensedReference> getCondensedCatalog()

    • getCondensedCatalog

      CondensedReference[] getCondensedCatalog(String pathWithWildChars)

    • forceMultiUserAccess

      int forceMultiUserAccess()

    • squeeze

      int squeeze()

    • convertVersion

      int convertVersion(String convertFileName)

    • undelete

      int undelete(List<String> pathnames)

    • undoLastDelete

      int undoLastDelete()

    • writeAccess

      boolean writeAccess()

    • writeData

      int writeData(PairedDataContainer pairedDataContainer)

    • writeData

      int writeData(GridContainer gridContainer)

    • writeData

      int writeData(DataContainer dataContainer)

    • writeLocation

      int writeLocation(DataContainer dataContainer)

    • writeData

      default int writeData(TimeSeriesContainer timeSeriesContainer)

    • writeData

      int writeData(TimeSeriesContainer timeSeriesContainer, int regularStoreMethod, int irregularStoreMethod)

    • writeFile

      int writeFile(File file, DSSPathname pathname, boolean imageFile) throws Exception
      Throws:
      Exception

    • exportFile

      int exportFile(String pathname, File file, String directory) throws Exception
      Throws:
      Exception

    • readImage

      int readImage(DataReference dataSet, PhotoViewerInfo info) throws Exception
      Throws:
      Exception

    • readLocation

      int readLocation(DataContainer dataContainer) throws Exception
      Throws:
      Exception

    • zinqir

      int zinqir(String parameter)

    • zinqir

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

    • zset

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

    • DSSFileName

      String DSSFileName(int i)

    • zquery

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

    • isRemote

      default boolean isRemote()