de.cau.cs.kieler.kiml.export
Class AbstractExporter

java.lang.Object
  extended by de.cau.cs.kieler.kiml.export.AbstractExporter
All Implemented Interfaces:
IExporter
Direct Known Subclasses:
DotExporter, GMLExporter, GraphMLExporter, KGraphExporter, OGMLExporter

public abstract class AbstractExporter
extends Object
implements IExporter

The base class for graph exporter.

Rating red

Field Summary
protected static String ERROR_MESSAGE_EXPORT_FAILED
          the message for a failed export.
 
Constructor Summary
AbstractExporter()
           
 
Method Summary
<T> void
addOption(ExporterOption<T> option)
          Adds an option to the exporter.
abstract  String getDefaultExtension()
          Returns the default file extension for this exporter.
abstract  String[] getExtensions()
          Returns the exporters supported file extensions.
abstract  String getName()
          Returns the name of the file format the exporter is exporting to.
 List<ExporterOption<?>> getOptions()
          Returns the options that are available for this exporter.
 String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.cau.cs.kieler.kiml.export.IExporter
doExport
 

Field Detail

ERROR_MESSAGE_EXPORT_FAILED

protected static final String ERROR_MESSAGE_EXPORT_FAILED
the message for a failed export.

Constructor Detail

AbstractExporter

public AbstractExporter()
Method Detail

getName

public abstract String getName()
Returns the name of the file format the exporter is exporting to.

Returns:
the name of the file format

getDefaultExtension

public abstract String getDefaultExtension()
Returns the default file extension for this exporter.

Returns:
the default file extension

getExtensions

public abstract String[] getExtensions()
Returns the exporters supported file extensions.

Returns:
the supported file extensions

getOptions

public List<ExporterOption<?>> getOptions()
Returns the options that are available for this exporter.

Returns:
the exporters options

addOption

public <T> void addOption(ExporterOption<T> option)
Adds an option to the exporter. This option with the chosen values can be received from the configuration that is passed to the export method.

Type Parameters:
T - the option value type
Parameters:
option - the option

toString

public String toString()

Overrides:
toString in class Object