com.jcoverage.reporting
Interface Collator

All Known Subinterfaces:
MultiViewCollator
All Known Implementing Classes:
AbstractCollator, StaticFileCollator

public interface Collator

An object that collects pages and sends them to format object for formatting. Since a collator knows about all the pages, it can provide formats with information based on the overall report structure, such as file organization. Formats get access to a collator through a FormattingContext.


Method Summary
 void addOutputter(Format format, Serializer serializer)
          Cause the pages to be output using the given format and serializer.
 java.lang.String getPathToPage(FormattingContext ctx, Page page)
           
 java.lang.String getPathToPage(FormattingContext ctx, Page page, Page from)
           
 java.lang.String getPathToResource(FormattingContext ctx, java.lang.String resource, Page from)
           
 void pageClosed(Page page)
          This method is called evertime a page is closed and ready to be rendered.
 

Method Detail

pageClosed

public void pageClosed(Page page)
                throws ReportingException
This method is called evertime a page is closed and ready to be rendered.

Throws:
ReportingException

getPathToPage

public java.lang.String getPathToPage(FormattingContext ctx,
                                      Page page)

getPathToPage

public java.lang.String getPathToPage(FormattingContext ctx,
                                      Page page,
                                      Page from)

getPathToResource

public java.lang.String getPathToResource(FormattingContext ctx,
                                          java.lang.String resource,
                                          Page from)

addOutputter

public void addOutputter(Format format,
                         Serializer serializer)
Cause the pages to be output using the given format and serializer.