org.pathvisio.libgpml.io.PathwayModelImporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.pathvisio.libgpml Show documentation

libGPML is a library for reading, writing, manipulation, and conversion of files and data streams in the GPML (Graphical Pathway Markup Language) format.

The newest version!

/*******************************************************************************
 * PathVisio, a tool for data visualization and analysis using biological pathways
 * Copyright 2006-2022 BiGCaT Bioinformatics, WikiPathways
 * 
 * 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 org.pathvisio.libgpml.io;

import java.io.File;

import org.pathvisio.libgpml.model.PathwayModel;

/**
 * Implemented by classes that can import a pathway from various different
 * types.
 * 
 * @author unknown
 */
public interface PathwayModelImporter extends PathwayModelIO {
	/**
	 * Inspects the file and determine if the file is suitable for import using this
	 * importer. For example, files ending in .xml could be examined for the local
	 * name and namespace of the root element. This function is invoked when
	 * multiple importers apply to a given file.
	 * 
	 * Implementations should check the file only superficially if at all. This
	 * function is merely a "tie-breaker" in case there are conflicting importers. A
	 * return value of true doesn't automatically mean that the file is guaranteed
	 * to be valid, so no complex validation is required. For naive implementations,
	 * it's always OK to simply return "true".
	 * 
	 * @param f the file to check
	 * @return true if the file appears superficially to be of the correct file
	 *         type.
	 */
	public boolean isCorrectType(File f);

	/**
	 * Imports the pathway model from given file.
	 * 
	 * @param file the file that contains pathway model information
	 * @return the result of the import, a fresh Pathway instance
	 * @throws ConverterException if the input file could not be read or parsed, or
	 *                            doesn't contain correct pathway information.
	 */
	public PathwayModel doImport(File file) throws ConverterException;
}