-
-
Notifications
You must be signed in to change notification settings - Fork 321
/
FileParameter.java
179 lines (168 loc) · 4.86 KB
/
FileParameter.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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
* This file is part of ELKI:
* Environment for Developing KDD-Applications Supported by Index-Structures
*
* Copyright (C) 2019
* ELKI Development Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package elki.utilities.optionhandling.parameters;
import java.io.File;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.function.Consumer;
import elki.utilities.io.FileUtil;
import elki.utilities.optionhandling.OptionID;
import elki.utilities.optionhandling.ParameterException;
import elki.utilities.optionhandling.UnspecifiedParameterException;
import elki.utilities.optionhandling.WrongParameterValueException;
import elki.utilities.optionhandling.parameterization.Parameterization;
/**
* Parameter class for a parameter specifying a file.
*
* @author Steffi Wanka
* @author Erich Schubert
* @since 0.3
*/
// TODO: turn FileType into a Constraint?
public class FileParameter extends AbstractParameter<FileParameter, URI> {
/**
* Available file types: {@link #INPUT_FILE} denotes an input file,
* {@link #OUTPUT_FILE} denotes an output file.
*/
public enum FileType {
/**
* Input files (i.e. read only)
*/
INPUT_FILE,
/**
* Output files
*/
OUTPUT_FILE
}
/**
* The file type of this file parameter. Specifies if the file is an input of
* output file.
*/
private FileType fileType;
/**
* Constructs a file parameter with the given optionID, and file type.
*
* @param optionID optionID the unique id of the option
* @param fileType the file type of this file parameter
*/
public FileParameter(OptionID optionID, FileType fileType) {
super(optionID);
this.fileType = fileType;
}
@Override
public String getValueAsString() {
final URI v = getValue();
return "file".equals(v.getScheme()) ? Paths.get(v).toString() : v.normalize().toString();
}
@Override
protected URI parseValue(Object obj) throws ParameterException {
if(obj == null) {
throw new UnspecifiedParameterException(this);
}
if(obj instanceof URI) {
return (URI) obj;
}
if(obj instanceof URL) {
try {
return ((URL) obj).toURI();
}
catch(URISyntaxException e) {
throw new WrongParameterValueException(this, obj.toString(), e.getMessage());
}
}
if(obj instanceof Path) {
return ((Path) obj).toUri();
}
if(obj instanceof File) {
return ((File) obj).toURI();
}
if(obj instanceof String) {
String str = (String) obj;
if(!str.isEmpty() && str.charAt(0) != '/') {
try {
URI u = new URI(str);
if(u.getScheme() != null) {
return u;
}
}
catch(URISyntaxException e) {
// Fallback to path-based parsing below.
}
}
return Paths.get(str).toUri();
}
throw new WrongParameterValueException(this, obj.toString(), "Unsupported value");
}
@Override
protected boolean validate(URI obj) throws ParameterException {
if(!super.validate(obj)) {
return false;
}
if(fileType.equals(FileType.INPUT_FILE)) {
try {
if(FileUtil.exists(obj)) {
return true;
}
throw new WrongParameterValueException("Given file " + obj + " for parameter \"" + getOptionID().getName() + "\" does not exist!");
}
catch(SecurityException e) {
throw new WrongParameterValueException("Given file \"" + obj + "\" cannot be read, access denied!\n" + e.getMessage());
}
}
return true;
}
/**
* Returns a string representation of the parameter's type.
*
* @return "<file_>"
*/
@Override
public String getSyntax() {
return "<file>";
}
/**
* Get the file type (input / output)
*
* @return file type
*/
public FileType getFileType() {
return fileType;
}
/**
* Get the parameter.
*
* @param config Parameterization
* @param consumer Output consumer
* @return {@code true} if valid
*/
public boolean grab(Parameterization config, Consumer<URI> consumer) {
if(config.grab(this)) {
if(consumer != null) {
consumer.accept(getValue());
}
return true;
}
return false;
}
}