1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
|
/*
* Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ch.systemsx.cisd.hdf5;
import java.io.File;
/**
* A factory for creating writers and readers of HDF5 files. For straight-forward creation, see
* methods {@link #open(File)} and {@link #openForReading(File)}. If you need full control over the
* creation process, see the methods {@link #configure(File)} and {@link #configureForReading(File)}.
* <p>
* Obtain an object implementing this interface by calling {@link HDF5FactoryProvider#get()}.
*
* @author Bernd Rinn
*/
public interface IHDF5Factory
{
/**
* Opens an HDF5 <var>file</var> for writing and reading. If the file does not yet exist, it
* will be created.
*/
public IHDF5Writer open(File file);
/**
* Opens an HDF5 <var>file</var> for reading. It is an error if the file does not exist.
*/
public IHDF5Reader openForReading(File file);
/**
* Opens a configurator for an HDF5 <var>file</var> for writing and reading. Configure the
* writer as you need and then call {@link IHDF5WriterConfigurator#writer()} in order to start
* reading and writing the file.
*/
public IHDF5WriterConfigurator configure(File file);
/**
* Opens a configurator for an HDF5 <var>file</var> for reading. Configure the reader as you
* need and then call {@link IHDF5ReaderConfigurator#reader()} in order to start reading the
* file.
*/
public IHDF5ReaderConfigurator configureForReading(File file);
/**
* Returns <code>true</code>, if the <var>file</var> is an HDF5 file and <code>false</code>
* otherwise.
*/
public boolean isHDF5File(File file);
/**
* Returns <code>true</code> if the HDF5 file has a metadata cache image.
*/
public boolean hasMDCImage(File file);
}
|