org.ginsim.common.document

Class GenericDocumentFormat

java.lang.Object

org.ginsim.common.utils.FileFormatDescription

org.ginsim.common.document.GenericDocumentFormat

public class GenericDocumentFormat
extends FileFormatDescription

This class contain metadata about each kind of document like id, extension, filter and its class.

Author:

Aurelien Naldi, Duncan Berenguier

Field Summary

Fields

Modifier and Type	Field and Description
DocumentWriterFactory	factory The documentWriter to instanciate to write a document of this type (eg.
static GenericDocumentFormat	OOoDocumentFormat
static GenericDocumentFormat	XHTMLDocumentFormat

Fields inherited from class org.ginsim.common.utils.FileFormatDescription

extension, id

Constructor Summary

Constructors

Constructor and Description
GenericDocumentFormat(DocumentWriterFactory factory, String id, String extension) Define a new generic document format.

Method Summary

Modifier and Type	Method and Description
static List<GenericDocumentFormat>	getAllFormats()
DocumentWriter	getWriter()
String	toString()

Methods inherited from class org.ginsim.common.utils.FileFormatDescription

equals, getFormat, getFormat, getFormats

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

XHTMLDocumentFormat

public static final GenericDocumentFormat XHTMLDocumentFormat

OOoDocumentFormat

public static final GenericDocumentFormat OOoDocumentFormat

factory

public final DocumentWriterFactory factory

The documentWriter to instanciate to write a document of this type (eg. XHTMLDocumentWriter)

Constructor Detail

GenericDocumentFormat

public GenericDocumentFormat(DocumentWriterFactory factory,
                             String id,
                             String extension)

Define a new generic document format.

Parameters:

factory - : The DocumentWriterFactory to create the instance

id - : The name of the format (for the dropdown menu)

extension - : the extension to add to the exported file

Method Detail

getWriter

public DocumentWriter getWriter()

getAllFormats

public static List<GenericDocumentFormat> getAllFormats()

toString

public String toString()

Overrides:

toString in class FileFormatDescription