eu.etaxonomy.cdm.format.occurrences

Class DefaultCdmFormatter

java.lang.Object

eu.etaxonomy.cdm.format.occurrences.AbstractCdmFormatter

eu.etaxonomy.cdm.format.occurrences.DefaultCdmFormatter

All Implemented Interfaces:

ICdmFormatter

public class DefaultCdmFormatter
extends AbstractCdmFormatter

Since:

Nov 30, 2015

Author:

pplitzner

Nested Class Summary

Nested classes/interfaces inherited from interface eu.etaxonomy.cdm.format.ICdmFormatter

ICdmFormatter.FormatKey

Field Summary

Fields inherited from class eu.etaxonomy.cdm.format.occurrences.AbstractCdmFormatter

formatKeyMap, formatKeys

Constructor Summary

Constructors

Constructor and Description
DefaultCdmFormatter(java.lang.Object object, ICdmFormatter.FormatKey[] formatKeys)

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.lang.Object object) Returns a string representation of the given object. Note: Only use this method if the formatKeys for this ICdmFormatter have been set before.
java.lang.String	format(java.lang.Object object, ICdmFormatter.FormatKey... formatKeys) Returns a string representation of the given object. The is built according to the formatKeys passed as arguments. E.g.

Methods inherited from class eu.etaxonomy.cdm.format.occurrences.AbstractCdmFormatter

initFormatKeys

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCdmFormatter

public DefaultCdmFormatter(java.lang.Object object,
                           ICdmFormatter.FormatKey[] formatKeys)

Method Detail

format

public java.lang.String format(java.lang.Object object,
                               ICdmFormatter.FormatKey... formatKeys)

Description copied from interface: ICdmFormatter

Returns a string representation of the given object.
The is built according to the formatKeys passed as arguments.
E.g. format(derivedUnit, GATHERING_COUNTRY, COMMA, GATHERING_COLLECTOR, COMMA, OPEN_BRACKET, COLLECTION_CODE, CLOSE_BRACKET will result in something like Peru, L. (B)

Specified by:

format in interface ICdmFormatter

Overrides:

format in class AbstractCdmFormatter

Parameters:

object - the object which should be formatted as a string representation

formatKeys - a list of enum values specifying the parts of which the string consists

Returns:

a string representation of the given object according to the chosen enum values

format

public java.lang.String format(java.lang.Object object)

Description copied from interface: ICdmFormatter

Returns a string representation of the given object.
Note: Only use this method if the formatKeys for this ICdmFormatter have been set before. Otherwise the string might be empty.

Specified by:

format in interface ICdmFormatter

Overrides:

format in class AbstractCdmFormatter

Parameters:

object - the object which should be formatted as a string representation

Returns:

a string representation of the given object