org.pathvisio.libgpml.model.GPMLFormatWriter 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.model;

import java.io.File;
import java.io.OutputStream;

import org.jdom2.Document;
import org.pathvisio.libgpml.io.ConverterException;

/**
 * Interface for GPML writing.
 *
 * @author unknown
 */
public interface GPMLFormatWriter extends GPMLFormatVersion {

	/**
	 * Creates a Jdom document from pathway model.
	 * 
	 * @param pathwayModel the pathway model.
	 * @return
	 * @throws ConverterException
	 */
	Document createJdom(PathwayModel pathwayModel) throws ConverterException;

	/**
	 * Write pathway model to file.
	 * 
	 * @param pathwayModel the pathway model.
	 * @param file         the file to write to.
	 * @param validate     if true, validate.
	 * @throws ConverterException
	 */
	void writeToXml(PathwayModel pathwayModel, File file, boolean validate) throws ConverterException;

	/**
	 * Writes pathway model to outputstream.
	 * 
	 * @param pathwayModel the pathway model.
	 * @param out          the output stream.
	 * @param validate     if true, validate.
	 * @throws ConverterException
	 */
	void writeToXml(PathwayModel pathwayModel, OutputStream out, boolean validate) throws ConverterException;

}