Package com.pnfsoftware.jeb.core.output

Class UnitFormatterUtil

java.lang.Object

com.pnfsoftware.jeb.core.output.UnitFormatterUtil

public class UnitFormatterUtil
extends Object

Utility methods for unit formatters.

Method Summary

Modifier and Type	Method	Description
static void	addAllPresentations(IUnitFormatter formatter, Collection<IUnitDocumentPresentation> presentations, boolean persisted)	Append a collection of presentations to the provided formatter.
static IUnitDocumentPresentation	getPresentationByDocument(IUnitFormatter formatter, IGenericDocument doc)	Retrieve a presentation by document.
static IUnitDocumentPresentation	getPresentationByIdentifier(IUnitFormatter formatter, long id)	Retrieve a presentation by document identifier.
static IUnitDocumentPresentation	getPresentationByName(IUnitFormatter formatter, String documentLabel)	Retrieve a presentation by document label.

Methods inherited from class java.lang.Object

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

Method Details

addAllPresentations

public static void addAllPresentations(IUnitFormatter formatter,
 Collection<IUnitDocumentPresentation> presentations,
 boolean persisted)

Append a collection of presentations to the provided formatter.

Parameters:

formatter - target formatter

presentations - presentations to append

persisted - true to add them as persisted presentations

getPresentationByIdentifier

public static IUnitDocumentPresentation getPresentationByIdentifier(IUnitFormatter formatter,
 long id)

Retrieve a presentation by document identifier.

Parameters:

formatter - source formatter

id - presentation identifier

Returns:

the matching presentation, or null if none exists

getPresentationByName

public static IUnitDocumentPresentation getPresentationByName(IUnitFormatter formatter,
 String documentLabel)

Retrieve a presentation by document label.

Parameters:

formatter - source formatter

documentLabel - presentation label to match

Returns:

the matching presentation, or null if none exists

getPresentationByDocument

public static IUnitDocumentPresentation getPresentationByDocument(IUnitFormatter formatter,
 IGenericDocument doc)

Retrieve a presentation by document.

Parameters:

formatter - source formatter

doc - backing document instance to match by identity

Returns:

the matching presentation, or null if none exists