Package org.harctoolbox.irscrutinizer.exporter

Class Exporter

java.lang.Object

org.harctoolbox.irscrutinizer.exporter.Exporter

Direct Known Subclasses:

CommandExporter, RemoteSetExporter

public abstract class Exporter
extends Object

This class is a common base class of all the exporters.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Exporter()

Method Summary

Modifier and Type	Method	Description
boolean	considersRepetitions()
File	export(String payload, boolean automaticFilenames, Component parent, File exportDir, String charsetName)
void	export(String payload, File file, String charsetName)
File	export(org.harctoolbox.girr.Command command, String source, String title, int noRepeats, boolean automaticFilenames, Component component, File exportDir, String charsetName)
protected abstract void	export(org.harctoolbox.girr.Command command, String source, String title, int noRepeats, File file, String charsetName)
void	export(Document document, File file, String charsetName)
File	exportFilename(boolean automatic, Component parent, File exportDir)
static Charset	getCharset()
static String	getCreatingUser()
String	getDateFormatString()
protected static String	getDateString()
Document	getDocument()
static Document	getDocument(DocumentFragment fragment)
abstract DocumentFragment	getDocumentation()
static final String	getEncoding()
abstract String[][]	getFileExtensions()
static File	getLastSaveFileOrCopy()
abstract String	getName()
abstract String	getPreferredFileExtension()
protected static DocumentFragment	parseToDocumentFragment(String str)
protected void	possiblyMakeExecutable(File file)
static void	setCreatingUser(String newCreatingUser)
static void	setDateFormatFileString(String aDateFormatFileString)
static void	setDateFormatString(String aDateFormatString)
static void	setEncoding(String newEncoding)

Methods inherited from class java.lang.Object

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

Constructor Details

Exporter

protected Exporter()

Method Details

setDateFormatString

public static void setDateFormatString(String aDateFormatString)

Parameters:

aDateFormatString - the dateFormatString to set

setDateFormatFileString

public static void setDateFormatFileString(String aDateFormatFileString)

Parameters:

aDateFormatFileString - the dateFormatFileString to set

getDateString

protected static String getDateString()

getLastSaveFileOrCopy

public static File getLastSaveFileOrCopy()
                                  throws IOException

Throws:

IOException

getCreatingUser

public static String getCreatingUser()

setCreatingUser

public static void setCreatingUser(String newCreatingUser)

getEncoding

public static final String getEncoding()

getCharset

public static Charset getCharset()

setEncoding

public static void setEncoding(String newEncoding)

getDocument

public static Document getDocument(DocumentFragment fragment)

parseToDocumentFragment

protected static DocumentFragment parseToDocumentFragment(String str)

possiblyMakeExecutable

protected void possiblyMakeExecutable(File file)

getDateFormatString

public String getDateFormatString()

getFileExtensions

public abstract String[][] getFileExtensions()

getPreferredFileExtension

public abstract String getPreferredFileExtension()

getName

public abstract String getName()

getDocumentation

public abstract DocumentFragment getDocumentation()

getDocument

public Document getDocument()

exportFilename

public File exportFilename(boolean automatic,
 Component parent,
 File exportDir)
                    throws IOException

Throws:

IOException

considersRepetitions

public boolean considersRepetitions()

export

public void export(Document document,
 File file,
 String charsetName)
            throws FileNotFoundException,
UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

export

public void export(String payload,
 File file,
 String charsetName)
            throws FileNotFoundException,
UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

export

public File export(String payload,
 boolean automaticFilenames,
 Component parent,
 File exportDir,
 String charsetName)
            throws IOException

Throws:

IOException

export

public File export(org.harctoolbox.girr.Command command,
 String source,
 String title,
 int noRepeats,
 boolean automaticFilenames,
 Component component,
 File exportDir,
 String charsetName)
            throws IOException,
TransformerException,
org.harctoolbox.ircore.IrCoreException,
org.harctoolbox.irp.IrpException,
org.harctoolbox.girr.GirrException

Throws:

IOException

TransformerException

org.harctoolbox.ircore.IrCoreException

org.harctoolbox.irp.IrpException

org.harctoolbox.girr.GirrException

export

protected abstract void export(org.harctoolbox.girr.Command command,
 String source,
 String title,
 int noRepeats,
 File file,
 String charsetName)
                        throws IOException,
TransformerException,
org.harctoolbox.ircore.IrCoreException,
org.harctoolbox.irp.IrpException,
org.harctoolbox.girr.GirrException

Throws:

IOException

TransformerException

org.harctoolbox.ircore.IrCoreException

org.harctoolbox.irp.IrpException

org.harctoolbox.girr.GirrException