com.communote.server.core.blog.export

Interface NoteWriter

All Known Implementing Classes:

RssNoteWriter, RtfNoteWriter

public interface NoteWriter

Interface for exporters.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
String	getContentType()
String	getFileExtension()
boolean	isAttachment()
boolean	supportsHtmlContent()
boolean	valid(String exportFormat)
void	write(NoteQueryParameters queryInstance, OutputStream outputStream, Collection<NoteData> noteItems, String originalRequestUrl) Writes the exported content into the output stream.

Method Detail

getContentType

String getContentType()

Returns:

the content type for this format.

getFileExtension

String getFileExtension()

Returns:

The extension of files for this format.

isAttachment

boolean isAttachment()

Returns:

True, if the content dispositon for this is attachment, else it will be threated as inline.

supportsHtmlContent

boolean supportsHtmlContent()

Returns:

whether the writer supports HTML as content or only plain text

valid

boolean valid(String exportFormat)

Parameters:

exportFormat - The format to be used for export.

Returns:

True, if this exporter is valid for the given exporter.

write

void write(NoteQueryParameters queryInstance,
           OutputStream outputStream,
           Collection<NoteData> noteItems,
           String originalRequestUrl)
    throws NoteWriterException

Writes the exported content into the output stream.

Parameters:

queryInstance - The query instance.

outputStream - The outputstream.

noteItems - Teh note items.

originalRequestUrl - The original request url

Throws:

NoteWriterException - Exception.