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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* 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.h5ar;
import java.io.File;
import ch.systemsx.cisd.base.exceptions.IErrorStrategy;
import ch.systemsx.cisd.hdf5.IHDF5Reader;
import ch.systemsx.cisd.hdf5.IHDF5Writer;
import ch.systemsx.cisd.hdf5.IHDF5WriterConfigurator.FileFormatVersionBounds;
/**
* A factory for {@link IHDF5Archiver}
*
* @author Bernd Rinn
*/
public class HDF5ArchiverFactory
{
/**
* Opens an HDF5 archive <var>file</var> for writing and reading.
*
* @param file The archive file to open. If the archive file does not yet exist, it will be
* created.
*/
public static IHDF5Archiver open(File file)
{
return new HDF5Archiver(file, false);
}
/**
* Opens an HDF5 archive <var>file</var> for writing and reading.
*
* @param file The archive file to open. If the archive file does not yet exist, it will be
* created.
* @param errorStrategyOrNull The {@link IErrorStrategy} to use on errors when accessing the
* archive. May be <code>null</code>, in which case every error just causes an
* exception.
*/
public static IHDF5Archiver open(File file, IErrorStrategy errorStrategyOrNull)
{
return new HDF5Archiver(file, false, false, FileFormatVersionBounds.V1_8_V1_8, errorStrategyOrNull);
}
/**
* Opens an HDF5 archive <var>file</var> for writing and reading.
*
* @param file The archive file to open. If the archive file does not yet exist, it will be
* created.
* @param noSync if <code>true</code>, no <code>sync</code> call will be performed on closing
* the file.
* @param fileFormat The HDF5 file format to use for the archive.
* @param errorStrategyOrNull The {@link IErrorStrategy} to use on errors when accessing the
* archive. May be <code>null</code>, in which case every error just causes an
* exception.
*/
public static IHDF5Archiver open(File file, boolean noSync, FileFormatVersionBounds fileFormat,
IErrorStrategy errorStrategyOrNull)
{
return new HDF5Archiver(file, false, noSync, fileFormat, errorStrategyOrNull);
}
/**
* Opens an HDF5 archive file named <var>filePath</var> for writing and reading.
*
* @param filePath The path of the archive file to open. If the archive file does not yet exist,
* it will be created.
*/
public static IHDF5Archiver open(String filePath)
{
return new HDF5Archiver(new File(filePath), false);
}
/**
* Opens an HDF5 archive file named <var>filePath</var> for writing and reading.
*
* @param filePath The path of the archive file to open. If the archive file does not yet exist,
* it will be created.
* @param errorStrategyOrNull The {@link IErrorStrategy} to use on errors when accessing the
* archive. May be <code>null</code>, in which case every error just causes an
* exception.
*/
public static IHDF5Archiver open(String filePath, IErrorStrategy errorStrategyOrNull)
{
return new HDF5Archiver(new File(filePath), false, false, FileFormatVersionBounds.V1_8_V1_8,
errorStrategyOrNull);
}
/**
* Opens an HDF5 archive file named <var>filePath</var> for writing and reading.
*
* @param filePath The path of the archive file to open. If the archive file does not yet exist,
* it will be created.
* @param noSync if <code>true</code>, no <code>sync</code> call will be performed on closing
* the file.
* @param fileFormat The HDF5 file format to use for the archive.
* @param errorStrategyOrNull The {@link IErrorStrategy} to use on errors when accessing the
* archive. May be <code>null</code>, in which case every error just causes an
* exception.
*/
public static IHDF5Archiver open(String filePath, boolean noSync, FileFormatVersionBounds fileFormat,
IErrorStrategy errorStrategyOrNull)
{
return new HDF5Archiver(new File(filePath), false, noSync, fileFormat, errorStrategyOrNull);
}
/**
* Opens an HDF5 archive file based on an HDF writer for writing and reading.
*
* @param writer The HDF5 writer to base the archive file on. Closing the archive writer will
* not close the HDF5 <var>writer</var>.
*/
public static IHDF5Archiver open(IHDF5Writer writer)
{
return new HDF5Archiver(writer, false, null);
}
/**
* Opens an HDF5 archive file based on an HDF writer for writing and reading.
*
* @param writer The HDF5 writer to base the archive file on. Closing the archive writer will
* not close the HDF5 <var>writer</var>. It is recommended that you configure the
* writer with <code>IHDF5WriterConfigurator.houseKeepingNameSuffix("\\1\\0)")</code>
* so that internal house-keeping files cannot overwrite archived files. .
* @param errorStrategy The {@link IErrorStrategy} to use on errors when accessing the archive.
*/
public static IHDF5Archiver open(IHDF5Writer writer, IErrorStrategy errorStrategy)
{
return new HDF5Archiver(writer, false, errorStrategy);
}
/**
* Opens an HDF5 archive <var>file</var> for reading.
*
* @param file The archive file to open. It is an error if the archive file does not exist.
*/
public static IHDF5ArchiveReader openForReading(File file)
{
return new HDF5Archiver(file, true);
}
/**
* Opens an HDF5 archive <var>file</var> for reading.
*
* @param file The archive file to open. It is an error if the archive file does not exist.
* @param errorStrategy The {@link IErrorStrategy} to use on errors when accessing the archive.
*/
public static IHDF5ArchiveReader openForReading(File file, IErrorStrategy errorStrategy)
{
return new HDF5Archiver(file, true, true, FileFormatVersionBounds.V1_8_V1_8, errorStrategy);
}
/**
* Opens an HDF5 archive file named <var>filePath</var> for reading.
*
* @param filePath The path of the archive file to open. It is an error if the archive file does
* not exist.
*/
public static IHDF5ArchiveReader openForReading(String filePath)
{
return new HDF5Archiver(new File(filePath), true);
}
/**
* Opens an HDF5 archive file named <var>filePath</var> for reading.
*
* @param filePath The path of the archive file to open. It is an error if the archive file does
* not exist.
* @param errorStrategy The {@link IErrorStrategy} to use on errors when accessing the archive.
*/
public static IHDF5ArchiveReader openForReading(String filePath, IErrorStrategy errorStrategy)
{
return new HDF5Archiver(new File(filePath), true, true, FileFormatVersionBounds.V1_8_V1_8,
errorStrategy);
}
/**
* Opens an HDF5 archive file based on an HDF5 reader.
*
* @param reader The HDF5 reader to use as the source of the archive. Closing the archive reader
* will not close the HDF5 <var>reader</var>.
* @param errorStrategy The {@link IErrorStrategy} to use on errors when accessing the archive.
*/
public static IHDF5ArchiveReader openForReading(IHDF5Reader reader, IErrorStrategy errorStrategy)
{
return new HDF5Archiver(reader, true, errorStrategy);
}
/**
* Opens an HDF5 archive file based on an HDF5 reader.
*
* @param reader The HDF5 reader to use as the source of the archive. Closing the archive reader
* will not close the HDF5 <var>reader</var>.
*/
public static IHDF5ArchiveReader openForReading(IHDF5Reader reader)
{
return new HDF5Archiver(reader, true, null);
}
}
|
