de.cismet.commons.converter

Interface FormatHint

public interface FormatHint

Interface to be implemented by Converter implementations to hint the user about the supported format so that they can decide which Converter to use for import or export of their data.

Version:

1.0

Author:

martin.scholl@cismet.de

Method Summary

Modifier and Type	Method and Description
String	getFormatDescription() Shall return a human readable description of the supported format.
String	getFormatDisplayName() Shall return a human readable display name for the format.
Object	getFormatExample() Shall return a depiction of the format so that the user may see on a concrete example what the supported format looks like.
String	getFormatHtmlDescription() Shall return a human readable HTML String or null if there is no HTML formatted description String.
String	getFormatHtmlName() Shall return the format name as HTML String or null if there is no HTML formatted name String.
String	getFormatName() The name of the format, usually a machine readable format identifier.

Method Detail

getFormatName

String getFormatName()

The name of the format, usually a machine readable format identifier.

Returns:

the name of the format

getFormatDisplayName

String getFormatDisplayName()

Shall return a human readable display name for the format.

Returns:

a human readable display name for the format

getFormatHtmlName

String getFormatHtmlName()

Shall return the format name as HTML String or null if there is no HTML formatted name String.

Returns:

the HTML display name or null if there is none available

getFormatDescription

String getFormatDescription()

Shall return a human readable description of the supported format.

Returns:

a human readable description of the supported format

getFormatHtmlDescription

String getFormatHtmlDescription()

Shall return a human readable HTML String or null if there is no HTML formatted description String.

Returns:

a human readable HTML description or null if there is none available

getFormatExample

Object getFormatExample()

Shall return a depiction of the format so that the user may see on a concrete example what the supported format looks like.

Returns:

a format example or null if no example is available