/
DatasetIOService.java
163 lines (141 loc) · 5.08 KB
/
DatasetIOService.java
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
/*
* #%L
* SCIFIO library for reading and converting scientific file formats.
* %%
* Copyright (C) 2011 - 2024 SCIFIO developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package io.scif.services;
import io.scif.Metadata;
import io.scif.SCIFIOService;
import io.scif.config.SCIFIOConfig;
import java.io.IOException;
import java.util.List;
import net.imagej.Dataset;
import org.scijava.io.location.Location;
/**
* A service for opening and saving {@link Dataset}s using SCIFIO.
*
* @author Mark Hiner
*/
public interface DatasetIOService extends SCIFIOService {
/**
* Determines whether the given source can be opened as a {@link Dataset}
* using the {@link #open(Location)} method.
*/
boolean canOpen(Location source);
/**
* Determines whether the given source can be opened as a {@link Dataset}
* using the {@link #open(Location)} method.
*/
boolean canOpen(String source);
/**
* Determines whether the given destination can be used to save a
* {@link Dataset} using the {@link #save(Dataset, Location)} method.
*/
boolean canSave(Location destination);
/**
* Loads a dataset from a source (such as a file on disk).
*/
Dataset open(Location source) throws IOException;
/**
* @see #open(Location)
*/
Dataset open(String source) throws IOException;
/**
* As {@link #open(Location)}, with the given
* {@code io.scif.config.SCIFIOConfig}.
*/
Dataset open(Location source, SCIFIOConfig config) throws IOException;
/**
* Loads a dataset from a source (such as a file on disk).
*/
Dataset open(String source, SCIFIOConfig config) throws IOException;
/**
* Load all the datasets from a given source. (Useful for files containing
* image series)
*
* @param source the source location of the images
* @return a list of all datasets contained by the image file.
* @throws IOException
*/
List<Dataset> openAll(Location source) throws IOException;
/**
* @see #openAll(Location)
*/
List<Dataset> openAll(String source) throws IOException;
/**
* As {@link #openAll(Location)}, with a given
* {@code io.scif.config.SCIFIOConfig}.
*
* @param source path on the disk
* @param config SCIFIOConfig file
* @return a list of all datasets contained by the image file.
* @throws IOException
*/
List<Dataset> openAll(Location source, SCIFIOConfig config)
throws IOException;
/**
* @see #openAll(Location)
*/
List<Dataset> openAll(String source, SCIFIOConfig config) throws IOException;
/**
* Saves a dataset to a destination (such as a file on disk).
*
* @param dataset The dataset to save.
* @param destination Where the dataset should be saved (e.g., a file path on
* disk).
*/
Metadata save(Dataset dataset, Location destination) throws IOException;
/**
* Saves a dataset to a destination (such as a file on disk).
*
* @param dataset The dataset to save.
* @param destination Where the dataset should be saved (e.g., a file path on
* disk).
* @param config The {@code io.scif.config.SCIFIOConfig} describing how the
* data should be saved.
*/
Metadata save(Dataset dataset, Location destination, SCIFIOConfig config)
throws IOException;
/**
* Saves a dataset to a destination (such as a file on disk).
*
* @param dataset The dataset to save.
* @param destination Where the dataset should be saved (e.g., a file path on
* disk).
* @param config The {@code io.scif.config.SCIFIOConfig} describing how the
* data should be saved.
*/
Metadata save(Dataset dataset, String destination, SCIFIOConfig config)
throws IOException;
/**
* Saves a dataset to a destination (such as a file on disk).
*
* @param dataset The dataset to save.
* @param destination Where the dataset should be saved (e.g., a file path on
* disk).
*/
Metadata save(Dataset dataset, String destination) throws IOException;
}