com.marklogic.client.example.handle

Class HTMLCleanerHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<OperationNotSupported,OutputStreamSender>

com.marklogic.client.example.handle.HTMLCleanerHandle

All Implemented Interfaces:

ContentDescriptor, AbstractWriteHandle, TriplesWriteHandle, XMLWriteHandle, OutputStreamSender

public class HTMLCleanerHandle
extends BaseHandle<OperationNotSupported,OutputStreamSender>
implements OutputStreamSender, XMLWriteHandle

An HTMLCleaner Handle writes an HTML document to the database as an XHTML document.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
HTMLCleanerHandle()
HTMLCleanerHandle(org.htmlcleaner.TagNode content)

Method Summary

Modifier and Type	Method and Description
org.htmlcleaner.TagNode	get()
org.htmlcleaner.CleanerProperties	getConfiguration()
org.htmlcleaner.HtmlCleaner	getParser()
org.htmlcleaner.ITagInfoProvider	getRulesProvider()
org.htmlcleaner.XmlSerializer	getSerializer()
void	set(File content, String charset)
void	set(InputStream content, String charset)
void	set(Reader content)
void	set(String content)
void	set(org.htmlcleaner.TagNode content)
void	setConfiguration(org.htmlcleaner.CleanerProperties configuration)
void	setFormat(Format format) Specifies the format of the content as binary, JSON, text, or XML.
void	setParser(org.htmlcleaner.HtmlCleaner parser)
void	setRulesProvider(org.htmlcleaner.ITagInfoProvider rulesProvider)
void	setSerializer(org.htmlcleaner.XmlSerializer serializer)
HTMLCleanerHandle	with(File content, String charset)
HTMLCleanerHandle	with(InputStream content, String charset)
HTMLCleanerHandle	with(Reader content)
HTMLCleanerHandle	with(String content)
HTMLCleanerHandle	with(org.htmlcleaner.TagNode content)
void	write(OutputStream out) Implements a callback to write content to the provided output stream for sending to the database server.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

Methods inherited from class com.marklogic.client.impl.HandleImplementation

getPointInTimeQueryTimestamp, setPointInTimeQueryTimestamp, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLCleanerHandle

public HTMLCleanerHandle()

HTMLCleanerHandle

public HTMLCleanerHandle(org.htmlcleaner.TagNode content)

Method Detail

getConfiguration

public org.htmlcleaner.CleanerProperties getConfiguration()

setConfiguration

public void setConfiguration(org.htmlcleaner.CleanerProperties configuration)

getRulesProvider

public org.htmlcleaner.ITagInfoProvider getRulesProvider()

setRulesProvider

public void setRulesProvider(org.htmlcleaner.ITagInfoProvider rulesProvider)

getParser

public org.htmlcleaner.HtmlCleaner getParser()

setParser

public void setParser(org.htmlcleaner.HtmlCleaner parser)

getSerializer

public org.htmlcleaner.XmlSerializer getSerializer()

setSerializer

public void setSerializer(org.htmlcleaner.XmlSerializer serializer)

get

public org.htmlcleaner.TagNode get()

set

public void set(org.htmlcleaner.TagNode content)

with

public HTMLCleanerHandle with(org.htmlcleaner.TagNode content)

set

public void set(File content,
                String charset)
         throws IOException

Throws:

IOException

with

public HTMLCleanerHandle with(File content,
                              String charset)
                       throws IOException

Throws:

IOException

set

public void set(InputStream content,
                String charset)
         throws IOException

Throws:

IOException

with

public HTMLCleanerHandle with(InputStream content,
                              String charset)
                       throws IOException

Throws:

IOException

set

public void set(Reader content)
         throws IOException

Throws:

IOException

with

public HTMLCleanerHandle with(Reader content)
                       throws IOException

Throws:

IOException

set

public void set(String content)
         throws IOException

Throws:

IOException

with

public HTMLCleanerHandle with(String content)
                       throws IOException

Throws:

IOException

setFormat

public void setFormat(Format format)

Description copied from interface: ContentDescriptor

Specifies the format of the content as binary, JSON, text, or XML.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<OperationNotSupported,OutputStreamSender>

Parameters:

format - the format of the content

write

public void write(OutputStream out)
           throws IOException

Description copied from interface: OutputStreamSender

Implements a callback to write content to the provided output stream for sending to the database server.

Specified by:

write in interface OutputStreamSender

Parameters:

out - the output stream receiving the content

Throws:

IOException - if io problems arise