org.codice.ddf.catalog.ui.query.monitor.impl

Class BaseMetacardFormatter

java.lang.Object

org.codice.ddf.catalog.ui.query.monitor.impl.BaseMetacardFormatter

All Implemented Interfaces:

MetacardFormatter

Direct Known Subclasses:

AttributeMetacardFormatter, HitCountFormatter, ListMetacardFormatter

public abstract class BaseMetacardFormatter
extends Object
implements MetacardFormatter

Base class that ensures arguments to format(String, WorkspaceMetacardImpl, Long) are checked.

Constructor Summary

Constructors

Constructor and Description
BaseMetacardFormatter()

Method Summary

Modifier and Type	Method and Description
protected abstract String	doFormat(String template, WorkspaceMetacardImpl workspaceMetacard, Long hitCount) The arguments are guaranteed to be non-null.
String	format(String template, WorkspaceMetacardImpl workspaceMetacard, Long hitCount) Transform a template string based on a workspace metacard and a hit count.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseMetacardFormatter

public BaseMetacardFormatter()

Method Detail

format

public final String format(String template,
                           WorkspaceMetacardImpl workspaceMetacard,
                           Long hitCount)

Description copied from interface: MetacardFormatter

Transform a template string based on a workspace metacard and a hit count.

Specified by:

format in interface MetacardFormatter

Parameters:

template - must be non-null

workspaceMetacard - must be non-null

hitCount - must be non-null

Returns:

formatted string (non-null)

doFormat

protected abstract String doFormat(String template,
                                   WorkspaceMetacardImpl workspaceMetacard,
                                   Long hitCount)

The arguments are guaranteed to be non-null.

Parameters:

template - non-null

workspaceMetacard - non-null

hitCount - non-null

Returns:

formatted string