public interface ConverterResult
ConverterResult
represent a document, which is the result
of a conversion performed by a Converter
implementation.Modifier and Type | Method and Description |
---|---|
ContentEntry |
getBibliographyFile()
Get the entry which contains the bibliography
|
java.util.List<ContentEntry> |
getContent()
Get the content table (based on headings) for this
ConverterResult |
ContentEntry |
getCoverFile()
Get the entry which contains the cover (which usually will contain a cover image)
|
ContentEntry |
getCoverImageFile()
Get the entry which contains the actual cover image
|
ContentEntry |
getIndexFile()
Get the entry which contains the alphabetical index
|
ContentEntry |
getLofFile()
Get the entry which contains the list of figures
|
ContentEntry |
getLotFile()
Get the entry which contains the list of tables
|
OutputFile |
getMasterDocument()
Deprecated.
|
MetaData |
getMetaData()
Get the meta data associated with the source document
|
ContentEntry |
getTextFile()
Get the entry which contains the start of the actual text (the first chapter, or simply the start of
the document if there are no headings)
|
ContentEntry |
getTitlePageFile()
Get the entry which contains the table page
|
ContentEntry |
getTocFile()
Get the entry which contains the table of contents
|
java.util.Iterator<OutputFile> |
iterator()
Gets an
Iterator to access all files in the
ConverterResult . |
void |
write(java.io.File dir)
Write all files of the
ConverterResult to a directory. |
@Deprecated OutputFile getMasterDocument()
iterator
OutputFile
the master documentjava.util.Iterator<OutputFile> iterator()
Iterator
to access all files in the
ConverterResult
. The iterator will return the master documents first
in logical order (starting with the primary master document)Iterator
of all filesMetaData getMetaData()
java.util.List<ContentEntry> getContent()
ConverterResult
ContentEntry getTitlePageFile()
ContentEntry getTextFile()
ContentEntry getTocFile()
ContentEntry getLotFile()
ContentEntry getLofFile()
ContentEntry getIndexFile()
ContentEntry getBibliographyFile()
ContentEntry getCoverFile()
ContentEntry getCoverImageFile()
void write(java.io.File dir) throws java.io.IOException
ConverterResult
to a directory.
Subdirectories are created as required by the individual
OutputFile
s.dir
- the directory to write to (this directory must exist).
If the parameter is null, the default directory is usedjava.io.IOException
- if the directory does not exist or one or more files
could not be written