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
|
/*
* Copyright 2020-2022 KRR Oxford
*
* 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 uk.ac.ox.cs.rsacomb
import scala.collection.mutable.Map
import util.Logger
case class RSAOption[+T](opt: T) {
def get[T]: T = opt.asInstanceOf[T]
}
object RSAConfig {
type Config = Map[Symbol, RSAOption[Any]]
private implicit def toRSAOption[T](opt: T) = RSAOption[T](opt)
/** Help message */
private val help: String = """
rsacomb - combined approach for CQ answering for RSA ontologies.
USAGE
rsacomb [OPTIONS] <ontology> [<data> ...]
-h | -? | --help
print this help message
-l | --logger <level>
specify the logger verbosity. Values are: quiet, normal (default),
debug, verbose.
-a | --answers <file>
path to the output file for the answers to the query (in JSON
format)
-q | --queries <file>
path to a file containing a single SPARQL query. If no query
is provided, only the approximation to RSA will be performed.
-o | --ontology <file>
ontology file in OWL format.
-d | --data <file>
data files to be used alongside the ontology file. If a
directory is provided, all files in the directory (recursively)
will be considered.
-x | --approximation <string>
values available are "lowerupper" or "upperbound" corresponding
to the two algorithms for ontology approximation shipping by
default with RSAComb. You will need to change the source code to
expose custom approximation modules through the CLI.
-t | --transitive
"upperbound" approximation specific option. Include property chain
axioms (and hence the more common transitive properties) when
computing the canonical model.
"""
/** Default config values */
private val default: Config = Map(
'transitive -> false,
'data -> List.empty[os.Path],
'approximation -> 'lowerbound
)
/** Parse a string into a path.
*
* @throws an [[IllegalArgumentException]] on malformed path.
*/
private def getPath(str: String): os.Path =
try {
os.Path(str, base = os.pwd)
} catch {
case e: IllegalArgumentException =>
exit(s"'$str' is not a well formed path.")
}
/** Utility to exit the program with a custom message on stderr.
*
* The program will exit with error after printing the help message.
*
* @param msg message printed to stderr.
* @param errno error code number (defaults to 1)
*/
private def exit(msg: String, errno: Int = 1): Nothing = {
System.err.println(msg)
System.err.println(help)
sys.exit(errno)
}
/** Parse arguments with default options.
*
* @param args arguments list
* @return map of config options
*/
def parse(args: List[String]): Config = parse(args, default)
/** Parse arguments.
*
* @param args arguments list
* @param config default configuration
* @return map of config options
*/
def parse(args: List[String], config: Config): Config = {
args match {
case Nil => finalise(config)
case flag @ ("-h" | "-?" | "--help") :: _ => {
println(help)
sys.exit(0)
}
case flag @ ("-l" | "--logger") :: _level :: tail => {
val level = _level match {
case "quiet" => Logger.QUIET
case "debug" => Logger.DEBUG
case "verbose" => Logger.VERBOSE
case _ => Logger.NORMAL
}
parse(tail, config += ('logger -> level))
}
case flag @ ("-a" | "--answers") :: answers :: tail =>
parse(tail, config += ('answers -> getPath(answers)))
case flag @ ("-x" | "--approximation") :: approx :: tail => {
parse(tail, config += ('approximation -> Symbol(approx)))
}
case flag @ ("-t" | "--transitive") :: tail =>
parse(tail, config += ('transitive -> true))
case flag @ ("-q" | "--queries") :: _query :: tail => {
val query = getPath(_query)
val files =
if (os.isFile(query))
List(query)
else if (os.isDir(query))
os.walk(query).filter(os.isFile).toList
else
exit(s"'${_query}' is not a valid path.")
parse(tail, config += ('queries -> files))
}
case flag @ ("-o" | "--ontology") :: _ontology :: tail => {
val ontology = getPath(_ontology)
if (!os.isFile(ontology))
exit(s"'${_ontology}' is not a valid filename.")
parse(tail, config += ('ontology -> ontology))
}
case flag @ ("-d" | "--data") :: _data :: tail => {
val data = getPath(_data)
val files =
if (os.isFile(data))
List(data)
else if (os.isDir(data)) {
os.walk(data).filter(os.isFile).toList
}else
exit(s"'${_data}' is not a valid path.")
parse(tail, config += ('data -> files))
}
case a => exit(s"Invalid sequence of arguments '${a.mkString(" ")}'.")
}
}
/** Perform final checks on parsed options.
*
* @param config a parsed configuration
* @returns the input configuration, unchanged
*/
private def finalise(config: Config): Config = {
if (!config.contains('ontology))
exit("The following flag is mandatory: '-o' or '--ontology'.")
config
}
/** Generate summary of a config object suitable for printing
*
* @param config a parsed configuration
* @returns a string describing the configuration
*/
def describe(config: Config): Unit = {
config foreach { case (k,v) => k match {
case 'logger => Logger print s"Logger level: ${v.get[Logger.Level]}"
case 'ontology => Logger print s"Ontology file: ${v.get[os.Path]}"
case 'data => {
val paths = v.get[List[os.Path]]
val ellipsis = if (paths.length > 1) " [...]" else ""
Logger print s"Data files: ${paths.head}$ellipsis"
}
case 'queries => {
val paths = v.get[List[os.Path]]
val ellipsis = if (paths.length > 1) " [...]" else ""
Logger print s"Query files: ${paths.head}$ellipsis"
}
case 'answers => Logger print s"Path to answers: ${v.get[os.Path]}"
case 'approximation => Logger print s"Applied approximation: ${v.get[Symbol].name}"
case 'transitive => Logger print s"Include property chain axioms: ${v.get[Boolean]}"
}}
}
}
|
