Package org.codelibs.fess.job

Class HtmlIndexExportFormatter

java.lang.Object

org.codelibs.fess.job.HtmlIndexExportFormatter

All Implemented Interfaces:

IndexExportFormatter

public class HtmlIndexExportFormatter
extends Object
implements IndexExportFormatter

Formatter that outputs index documents as HTML files.

Constructor Summary

Constructors

Constructor	Description
HtmlIndexExportFormatter()	Creates a new HtmlIndexExportFormatter instance.

Method Summary

Modifier and Type	Method	Description
String	format(Map<String,Object> source, Set<String> excludeFields)	Formats a document source map into the target format string.
String	getFileExtension()	Returns the file extension for this format (e.g.
String	getIndexFileName()	Returns the default index file name for this format (e.g.

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlIndexExportFormatter

public HtmlIndexExportFormatter()

Creates a new HtmlIndexExportFormatter instance.

Method Details

getFileExtension

public String getFileExtension()

Description copied from interface: IndexExportFormatter

Returns the file extension for this format (e.g. ".html", ".json").

Specified by:

getFileExtension in interface IndexExportFormatter

Returns:

the file extension including the leading dot

getIndexFileName

public String getIndexFileName()

Description copied from interface: IndexExportFormatter

Returns the default index file name for this format (e.g. "index.html", "index.json").

Specified by:

getIndexFileName in interface IndexExportFormatter

Returns:

the index file name

format

public String format(Map<String,Object> source,
 Set<String> excludeFields)

Description copied from interface: IndexExportFormatter

Formats a document source map into the target format string.

Specified by:

format in interface IndexExportFormatter

Parameters:

source - the document source map

excludeFields - the set of field names to exclude from output

Returns:

the formatted string