|
a |
|
b/src/main/java/org/sba_research/timbus/kb/ToolKnowledgeBase.java |
|
|
1 |
/**
|
|
|
2 |
* Copyright (c) 2013/2014 Verein zur Foerderung der IT-Sicherheit in Oesterreich (SBA).
|
|
|
3 |
* The work has been developed in the TIMBUS Project and the above-mentioned are Members of the TIMBUS Consortium.
|
|
|
4 |
* TIMBUS is supported by the European Union under the 7th Framework Programme for research and technological
|
|
|
5 |
* development and demonstration activities (FP7/2007-2013) under grant agreement no. 269940.
|
|
|
6 |
*
|
|
|
7 |
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
|
|
|
8 |
* the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
|
|
|
9 |
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
|
|
|
10 |
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including without
|
|
|
11 |
* limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTIBITLY, or FITNESS FOR A PARTICULAR
|
|
|
12 |
* PURPOSE. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise,
|
|
|
13 |
* unless required by applicable law or agreed to in writing, shall any Contributor be liable for damages, including
|
|
|
14 |
* any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this
|
|
|
15 |
* License or out of the use or inability to use the Work.
|
|
|
16 |
* See the License for the specific language governing permissions and limitation under the License.
|
|
|
17 |
*/
|
|
|
18 |
package org.sba_research.timbus.kb;
|
|
|
19 |
|
|
|
20 |
import org.apache.commons.lang3.tuple.Pair;
|
|
|
21 |
|
|
|
22 |
import java.util.List;
|
|
|
23 |
|
|
|
24 |
public interface ToolKnowledgeBase {
|
|
|
25 |
/**
|
|
|
26 |
* Returns tools that provide a specific action.
|
|
|
27 |
*
|
|
|
28 |
* @param action The action fragment.
|
|
|
29 |
* @return A list of tool IRIs.
|
|
|
30 |
*/
|
|
|
31 |
List<String> getProvidingTools(String action);
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* Returns a list of alternative tools.
|
|
|
35 |
* Alternatives are all tools that provide at least the same actions as the tool for which an
|
|
|
36 |
* alternative is searched.
|
|
|
37 |
*
|
|
|
38 |
* @param tool The tool fragment.
|
|
|
39 |
* @return A list of tool IRIs.
|
|
|
40 |
*/
|
|
|
41 |
List<String> getAlternativeTools(String tool);
|
|
|
42 |
|
|
|
43 |
/**
|
|
|
44 |
* Returns a list of tools that support the given input and output format.
|
|
|
45 |
*
|
|
|
46 |
* @param format A input (left) /output (right) format pair.
|
|
|
47 |
* @return A list of tool IRIs.
|
|
|
48 |
*/
|
|
|
49 |
List<String> getSupportingTools(Pair<String, String> format);
|
|
|
50 |
|
|
|
51 |
/**
|
|
|
52 |
* @return Returns a list of Pronom IDs of all formats.
|
|
|
53 |
*/
|
|
|
54 |
List<String> getAllFormatIDs();
|
|
|
55 |
|
|
|
56 |
/**
|
|
|
57 |
* Returns the format name of a given ID.
|
|
|
58 |
* @param formatID The Pronom ID of a format.
|
|
|
59 |
* @return A format IRI.
|
|
|
60 |
*/
|
|
|
61 |
List<String> getFormatName(String formatID);
|
|
|
62 |
|
|
|
63 |
/**
|
|
|
64 |
* Returns tools and their output formats that support a specified input format.
|
|
|
65 |
*
|
|
|
66 |
* @param formatID The Pronom ID of a format.
|
|
|
67 |
* @return A list of possible migration options.
|
|
|
68 |
*/
|
|
|
69 |
List<FormatMigrationOption> getFormatMigrationOption(String formatID);
|
|
|
70 |
}
|