• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• HDF5FileFactory.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

generated.docs.javadoc.org.eclipse.dawnsci.hdf5.HDF5FileFactory.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.hdf5
Class HDF5FileFactory



java.lang.Object


org.eclipse.dawnsci.hdf5.HDF5FileFactory









public class HDF5FileFactory
extends java.lang.Object
This contains method to access low level HDF5 file IDs and allows them to
 be held open for a set period (default of 5s) before being closed.











Method Summary

All Methods Static Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


static HDF5File
acquireFile(java.lang.String fileName,
           boolean writeable)
Acquire file



static HDF5File
acquireFile(java.lang.String fileName,
           boolean writeable,
           boolean withLatestVersion)
Acquire file



static HDF5File
acquireFileAsNew(java.lang.String fileName)
Acquire file as a newly created one.



static HDF5File
acquireFileAsNew(java.lang.String fileName,
                boolean withLatestVersion)
Acquire file as a newly created one.



static java.lang.String
canonicalisePath(java.lang.String absolutePath)
Canonicalise path so that we can use it as a standard key



static void
deleteFile(java.lang.String fileName)
Delete file



protected void
finalize() 


static void
flushWrites(java.lang.String fileName)
Flush writes to file associated with file name



static long
getHeldPeriod()
Get period of time a file ID is held open for.



static void
releaseFile(java.lang.String fileName)
Release file



static void
releaseFile(java.lang.String fileName,
           boolean close)
Release file associated with file name



static void
setHeldPeriod(long heldPeriod)
Set period of time a file ID is held open for.



static void
setVerbose(boolean verbose) 






Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Method Detail





setVerbose
public static void setVerbose(boolean verbose)

Parameters:
verbose - if true, print to standard error when opening, closing, creating or deleting files








finalize
protected void finalize()
                 throws java.lang.Throwable

Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable








canonicalisePath
public static java.lang.String canonicalisePath(java.lang.String absolutePath)
                                         throws java.io.IOException
Canonicalise path so that we can use it as a standard key

Parameters:
absolutePath - 
Returns:
Throws:
java.io.IOException








setHeldPeriod
public static void setHeldPeriod(long heldPeriod)
Set period of time a file ID is held open for. The period specified must be greater
 than or equal to 100 ms.

Parameters:
heldPeriod - in milliseconds








getHeldPeriod
public static long getHeldPeriod()
Get period of time a file ID is held open for.

Returns:
period held in milliseconds








acquireFile
public static HDF5File acquireFile(java.lang.String fileName,
                                   boolean writeable)
                            throws ScanFileHolderException
Acquire file

Parameters:
fileName - 
writeable - 
Returns:
file
Throws:
ScanFileHolderException








acquireFile
public static HDF5File acquireFile(java.lang.String fileName,
                                   boolean writeable,
                                   boolean withLatestVersion)
                            throws ScanFileHolderException
Acquire file

Parameters:
fileName - 
writeable - 
withLatestVersion - if true, use latest object format version for writing
Returns:
file
Throws:
ScanFileHolderException








acquireFileAsNew
public static HDF5File acquireFileAsNew(java.lang.String fileName)
                                 throws ScanFileHolderException
Acquire file as a newly created one. This deletes extant files

Parameters:
fileName - 
Returns:
file
Throws:
ScanFileHolderException








acquireFileAsNew
public static HDF5File acquireFileAsNew(java.lang.String fileName,
                                        boolean withLatestVersion)
                                 throws ScanFileHolderException
Acquire file as a newly created one. This deletes extant files

Parameters:
fileName - 
withLatestVersion - if true, use latest object format version for writing
Returns:
file
Throws:
ScanFileHolderException








deleteFile
public static void deleteFile(java.lang.String fileName)
                       throws ScanFileHolderException
Delete file

Parameters:
fileName - 
Throws:
ScanFileHolderException








releaseFile
public static void releaseFile(java.lang.String fileName)
                        throws ScanFileHolderException
Release file

Parameters:
fileName - 
Throws:
ScanFileHolderException








releaseFile
public static void releaseFile(java.lang.String fileName,
                               boolean close)
                        throws ScanFileHolderException
Release file associated with file name

Parameters:
fileName - 
close - if true then close it too
Throws:
ScanFileHolderException








flushWrites
public static void flushWrites(java.lang.String fileName)
                        throws ScanFileHolderException
Flush writes to file associated with file name

Parameters:
fileName - 
Throws:
ScanFileHolderException














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method