/**
* Copyright (c) 2013/2014 Verein zur Foerderung der IT-Sicherheit in Oesterreich (SBA).
* The work has been developed in the TIMBUS Project and the above-mentioned are Members of the TIMBUS Consortium.
* TIMBUS is supported by the European Union under the 7th Framework Programme for research and technological
* development and demonstration activities (FP7/2007-2013) under grant agreement no. 269940.
*
* 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, including without
* limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTIBITLY, or FITNESS FOR A PARTICULAR
* PURPOSE. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law or agreed to in writing, shall any Contributor be liable for damages, including
* any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this
* License or out of the use or inability to use the Work.
* See the License for the specific language governing permissions and limitation under the License.
*/
package org.sba_research.timbus.kb;
import org.apache.commons.lang3.tuple.Pair;
import java.util.List;
public interface ToolKnowledgeBase {
/**
* Returns tools that provide a specific action.
*
* @param action The action fragment.
* @return A list of tool IRIs.
*/
List<String> getProvidingTools(String action);
/**
* Returns a list of alternative tools.
* Alternatives are all tools that provide at least the same actions as the tool for which an
* alternative is searched.
*
* @param tool The tool fragment.
* @return A list of tool IRIs.
*/
List<String> getAlternativeTools(String tool);
/**
* Returns a list of tools that support the given input and output format.
*
* @param format A input (left) /output (right) format pair.
* @return A list of tool IRIs.
*/
List<String> getSupportingTools(Pair<String, String> format);
/**
* @return Returns a list of Pronom IDs of all formats.
*/
List<String> getAllFormatIDs();
/**
* Returns the format name of a given ID.
* @param formatID The Pronom ID of a format.
* @return A format IRI.
*/
List<String> getFormatName(String formatID);
/**
* Returns tools and their output formats that support a specified input format.
*
* @param formatID The Pronom ID of a format.
* @return A list of possible migration options.
*/
List<FormatMigrationOption> getFormatMigrationOption(String formatID);
}