org.deckfour.xes.out.XSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SEWOL Show documentation

SEWOL provides support for the handling of workflow traces. Specifically it allows to specify the shape and content of process traces in terms of entries representing the execution of a specific workflow activity. SEWOL also allows to write these traces on disk as a log file with the help of a special file writer for process logs. Currently it supports plain text, Petrify, MXML and XES log file types. In order to specify security-related context information, SEWOL provides access control models such as access control lists (ACL) and role-based access control models (RBAC). All types of models can be conveniently edited with the help of appropriate dialogs.

The newest version!

/*
 * OpenXES
 * 
 * The reference implementation of the XES meta-model for event 
 * log data management.
 * 
 * Copyright (c) 2008 Christian W. Guenther ([email protected])
 * 
 * 
 * LICENSE:
 * 
 * This code is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 * 
 * EXEMPTION:
 * 
 * The use of this software can also be conditionally licensed for
 * other programs, which do not satisfy the specified conditions. This
 * requires an exemption from the general license, which may be
 * granted on a per-case basis.
 * 
 * If you want to license the use of this software with a program
 * incompatible with the LGPL, please contact the author for an
 * exemption at the following email address: 
 * [email protected]
 * 
 */
package org.deckfour.xes.out;

import java.io.IOException;
import java.io.OutputStream;

import org.deckfour.xes.model.XLog;

/**
 * This interfaces defines the capabilities of a serialization for
 * the XES format, into a given representation.
 * 
 * @author Christian W. Guenther ([email protected])
 *
 */
public interface XSerializer {
	
	/**
	 * Returns the human-readable name of this serialization.
	 */
	public String getName();
	
	/**
	 * Returns a brief description of this serialization.
	 */
	public String getDescription();
	
	/**
	 * Returns the name of this serialization's author.
	 */
	public String getAuthor();
	
	/**
	 * Returns an array of possible file suffices for
	 * this serialization.
	 */
	public String[] getSuffices();
	
	/**
	 * Serializes a given log to the given output stream.
	 * 
	 * @param log Log to be serialized.
	 * @param out OutputStream for serialization.
	 */
	public void serialize(XLog log, OutputStream out)
		throws IOException;

}