|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aurigalogic.aurigadoc.core.Driver
This class is the main driver class that takes care of conversion to
various output format. Use this class for doing the conversion.
e.g.
Driver driver = new Driver(); // intantiate a driver
driver.setFormat(Driver.FORMAT_HTML); // set the output format
driver.setInputFile(String inputFile); // set the input file path
driver.setOutputFile(String outputFile); // set teh output file/dir
path
driver.setLogger(Logger logger); //optional
driver.run(); // run the driver
Field Summary | |
static int |
FORMAT_AWT
Constant for the AWT output format |
static int |
FORMAT_CHM
Constant for the CHM output format |
static int |
FORMAT_DHTML
Constant for the DHTML output format |
static int |
FORMAT_FO
Constant for the FO output format |
static int |
FORMAT_HTML
Constant for the XML output format |
static int |
FORMAT_JHELP
Constant for the JHELP output format |
static int |
FORMAT_MAN
Constant for the man source output format |
static int |
FORMAT_MHT
Constant for the mht output format |
static int |
FORMAT_MHTML
Constant for the MULTI-HTML output format |
static int |
FORMAT_OHJ
Constant for the Oracle Help For Java (OHJ) output format |
static int |
FORMAT_PDF
Constant for the PDF output format |
static int |
FORMAT_PS
Constant for the PS output format |
static int |
FORMAT_RTF
Constant for the RTF output format |
Constructor Summary | |
Driver()
Default constructor. |
Method Summary | |
void |
run()
Run the converter. |
void |
setFormat(int format)
Set the output format. |
void |
setInputFile(java.lang.String inFile)
Set the input file. |
void |
setLogger(Logger logger)
Set the logger. |
void |
setOutputFile(java.lang.String outFile)
Set the output file. |
void |
setParameters(java.util.Properties parameters)
Set additional parameters. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int FORMAT_HTML
public static final int FORMAT_MHTML
public static final int FORMAT_DHTML
public static final int FORMAT_PDF
public static final int FORMAT_PS
public static final int FORMAT_RTF
public static final int FORMAT_AWT
public static final int FORMAT_FO
public static final int FORMAT_JHELP
public static final int FORMAT_CHM
public static final int FORMAT_MAN
public static final int FORMAT_MHT
public static final int FORMAT_OHJ
Constructor Detail |
public Driver()
Method Detail |
public void setFormat(int format)
format
- the output format.public void setOutputFile(java.lang.String outFile)
outFile
- the output file path.public void setInputFile(java.lang.String inFile)
inFile
- the input file path.public void setLogger(Logger logger)
logger
- the logger to use for logging.public void setParameters(java.util.Properties parameters)
parameters
- additional parameters for the specific
converter.public void run() throws java.lang.Exception
java.lang.Exception
- in case of an error.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |