com.hcl.domino.dxl

Interface DxlExporter

public interface DxlExporter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DxlExporter.DXLExportCharset Specifies output charset
static class	DxlExporter.DXLMIMEOption Specifies rule for exporting native MIME
static class	DxlExporter.DXLRichTextOption Specifies rule for exporting rich text
static class	DxlExporter.DXLValidationStyle Specifies style of validation info emitted by exporter.

Method Summary

Modifier and Type	Method and Description
default void	exportACL(Database db, OutputStream out) Export the ACL of the specified database in XML format.
void	exportACL(Database db, Writer out) Export the ACL of the specified database in XML format.
default void	exportDatabase(Database db, OutputStream out) Export an entire database in XML format.
void	exportDatabase(Database db, Writer out) Export an entire database in XML format.
default void	exportDocument(Document doc, OutputStream out) Export a single document into XML format.
void	exportDocument(Document doc, Writer out) Export a single document into XML format.
boolean	exportErrorWasLogged()
default void	exportIDs(Database db, Collection<Integer> ids, OutputStream out) Export a set of note ids into XML format.
void	exportIDs(Database db, Collection<Integer> ids, Writer out) Export a set of note ids into XML format.
String	getAttachmentOmittedText()
String	getDefaultDoctypeSYSTEM()
String	getDoctypeSYSTEM()
String	getDXLBannerComments()
String	getDxlDefaultSchemaLocation()
String	getDxlExportResultLog()
String	getDxlExportResultLogComment()
String	getDxlSchemaLocation()
DxlExporter.DXLExportCharset	getExportCharset()
Optional<Charset>	getJDKExportCharset()
DxlExporter.DXLMIMEOption	getMIMEOption()
String	getOLEObjectOmittedText()
List<String>	getOmitItemNames()
String	getPictureOmittedText()
List<String>	getRestrictToItemNames()
DxlExporter.DXLRichTextOption	getRichTextOption()
DxlExporter.DXLValidationStyle	getValidationStyle()
boolean	isConvertNotesbitmapsToGIF()
boolean	isForceNoteFormat()
boolean	isOmitMiscFileObjects()
boolean	isOmitOLEObjects()
boolean	isOmitPictures()
boolean	isOmitRichTextAttachments()
boolean	isOutputDoctype()
boolean	isOutputXmlDecl()
boolean	isUncompressAttachments()
void	setAttachmentOmittedText(String txt)
void	setConvertNotesbitmapsToGIF(boolean b)
void	setDoctypeSYSTEM(String docType)
void	setDXLBannerComments(String comments)
void	setDxlExportResultLogComment(String comment)
void	setDxlSchemaLocation(String loc)
void	setExportCharset(DxlExporter.DXLExportCharset charset)
void	setForceNoteFormat(boolean forceNoteFormat)
void	setMIMEOption(DxlExporter.DXLMIMEOption option)
void	setOLEObjectOmittedText(String txt)
void	setOmitItemNames(List<String> itemNames)
void	setOmitMiscFileObjects(boolean b)
void	setOmitOLEObjects(boolean b)
void	setOmitPictures(boolean b)
void	setOmitRichTextAttachments(boolean b)
void	setOutputDoctype(boolean b)
void	setOutputXmlDecl(boolean b)
void	setPictureOmittedText(String txt)
void	setRestrictToItemNames(List<String> itemNames)
void	setRichTextOption(DxlExporter.DXLRichTextOption option)
void	setUncompressAttachments(boolean b)
void	setValidationStyle(DxlExporter.DXLValidationStyle style)

Method Detail

exportErrorWasLogged

boolean exportErrorWasLogged()

exportDocument

void exportDocument(Document doc,
                    Writer out)
             throws IOException

Export a single document into XML format.

Parameters:

doc - document to export

out - result writer

Throws:

IOException - in case of I/O errors

exportDocument

default void exportDocument(Document doc,
                            OutputStream out)
                     throws IOException

Export a single document into XML format.

Parameters:

doc - document to export

out - result stream

Throws:

IOException - in case of I/O errors

exportIDs

void exportIDs(Database db,
               Collection<Integer> ids,
               Writer out)
        throws IOException

Export a set of note ids into XML format.

Parameters:

db - database containing the export ids

ids - ids to export

out - result writer

Throws:

IOException - in case of I/O errors

exportIDs

default void exportIDs(Database db,
                       Collection<Integer> ids,
                       OutputStream out)
                throws IOException

Export a set of note ids into XML format.

Parameters:

db - database containing the export ids

ids - ids to export

out - result stream

Throws:

IOException - in case of I/O errors

exportDatabase

void exportDatabase(Database db,
                    Writer out)
             throws IOException

Export an entire database in XML format.

Parameters:

db - database to export

out - result writer

Throws:

IOException - in case of I/O errors

exportDatabase

default void exportDatabase(Database db,
                            OutputStream out)
                     throws IOException

Export an entire database in XML format.

Parameters:

db - database to export

out - result stream

Throws:

IOException - in case of I/O errors

exportACL

void exportACL(Database db,
               Writer out)
        throws IOException

Export the ACL of the specified database in XML format.

Parameters:

db - database to export

out - result writer

Throws:

IOException - in case of I/O errors

exportACL

default void exportACL(Database db,
                       OutputStream out)
                throws IOException

Export the ACL of the specified database in XML format.

Parameters:

db - database to export

out - result stream

Throws:

IOException - in case of I/O errors

isOutputXmlDecl

boolean isOutputXmlDecl()

setOutputXmlDecl

void setOutputXmlDecl(boolean b)

isOutputDoctype

boolean isOutputDoctype()

setOutputDoctype

void setOutputDoctype(boolean b)

isConvertNotesbitmapsToGIF

boolean isConvertNotesbitmapsToGIF()

setConvertNotesbitmapsToGIF

void setConvertNotesbitmapsToGIF(boolean b)

isOmitRichTextAttachments

boolean isOmitRichTextAttachments()

setOmitRichTextAttachments

void setOmitRichTextAttachments(boolean b)

isOmitOLEObjects

boolean isOmitOLEObjects()

setOmitOLEObjects

void setOmitOLEObjects(boolean b)

isOmitMiscFileObjects

boolean isOmitMiscFileObjects()

setOmitMiscFileObjects

void setOmitMiscFileObjects(boolean b)

isOmitPictures

boolean isOmitPictures()

setOmitPictures

void setOmitPictures(boolean b)

isUncompressAttachments

boolean isUncompressAttachments()

setUncompressAttachments

void setUncompressAttachments(boolean b)

getDxlExportResultLog

String getDxlExportResultLog()

getDefaultDoctypeSYSTEM

String getDefaultDoctypeSYSTEM()

getDoctypeSYSTEM

String getDoctypeSYSTEM()

setDoctypeSYSTEM

void setDoctypeSYSTEM(String docType)

getDXLBannerComments

String getDXLBannerComments()

setDXLBannerComments

void setDXLBannerComments(String comments)

getDxlExportResultLogComment

String getDxlExportResultLogComment()

setDxlExportResultLogComment

void setDxlExportResultLogComment(String comment)

getDxlDefaultSchemaLocation

String getDxlDefaultSchemaLocation()

getDxlSchemaLocation

String getDxlSchemaLocation()

setDxlSchemaLocation

void setDxlSchemaLocation(String loc)

getAttachmentOmittedText

String getAttachmentOmittedText()

setAttachmentOmittedText

void setAttachmentOmittedText(String txt)

getOLEObjectOmittedText

String getOLEObjectOmittedText()

setOLEObjectOmittedText

void setOLEObjectOmittedText(String txt)

getPictureOmittedText

String getPictureOmittedText()

setPictureOmittedText

void setPictureOmittedText(String txt)

getOmitItemNames

List<String> getOmitItemNames()

setOmitItemNames

void setOmitItemNames(List<String> itemNames)

getRestrictToItemNames

List<String> getRestrictToItemNames()

setRestrictToItemNames

void setRestrictToItemNames(List<String> itemNames)

getExportCharset

DxlExporter.DXLExportCharset getExportCharset()

getJDKExportCharset

Optional<Charset> getJDKExportCharset()

Returns:

an Optional describing the export character set as a Charset or an empty one if the charset cannot be mapped

setExportCharset

void setExportCharset(DxlExporter.DXLExportCharset charset)

getRichTextOption

DxlExporter.DXLRichTextOption getRichTextOption()

setRichTextOption

void setRichTextOption(DxlExporter.DXLRichTextOption option)

getValidationStyle

DxlExporter.DXLValidationStyle getValidationStyle()

setValidationStyle

void setValidationStyle(DxlExporter.DXLValidationStyle style)

getMIMEOption

DxlExporter.DXLMIMEOption getMIMEOption()

setMIMEOption

void setMIMEOption(DxlExporter.DXLMIMEOption option)

isForceNoteFormat

boolean isForceNoteFormat()

Returns:

whether this exporter is configured to use raw note format

Since:

1.0.26

setForceNoteFormat

void setForceNoteFormat(boolean forceNoteFormat)

Parameters:

forceNoteFormat - whether this exporter should use raw note format

Since:

1.0.26