com.jcoverage.reporting
Interface Page

All Superinterfaces:
Closeable
All Known Implementing Classes:
AbstractPage, JavaFilePage, PackageSummaryPage, ReportSummaryPage

public interface Page
extends Closeable

A page containing information at the same report level.


Method Summary
 void addCategory(LineCategory category)
           
 void addLineReference(Line line, LineCategory category)
          Add a reference to a line.
 Line createLine(LineCategory category)
          Create a new line in the page.
 LineCategory[] getCategories()
          Get the line categories that are valid for this page.
 java.lang.String getLabel()
           
 java.util.Set getLines(LineCategory category)
          The page can 'contain' any number of categories (tables) which, in turn, contain any number of lines.
 Line getMasterLine()
           
 Line lookupLineByField(LineCategory category, Column column, java.lang.Object value)
           
 void setMasterLine(Line masterLine)
           
 void setReport(Report report)
           
 
Methods inherited from interface com.jcoverage.reporting.Closeable
close, isClosed
 

Method Detail

createLine

public Line createLine(LineCategory category)
Create a new line in the page. Lines can fall into categories, used for tables and sectioning. This information is used by formats, so they can request lines by category.


addLineReference

public void addLineReference(Line line,
                             LineCategory category)
Add a reference to a line. Unlike the createLine(LineCategory) method, no connections are made between this page and line.


lookupLineByField

public Line lookupLineByField(LineCategory category,
                              Column column,
                              java.lang.Object value)

getLines

public java.util.Set getLines(LineCategory category)
The page can 'contain' any number of categories (tables) which, in turn, contain any number of lines. This method provides access to those lines.

Returns:
the lines stored in this page against the category, or an empty set. Should never return null.

setReport

public void setReport(Report report)

getMasterLine

public Line getMasterLine()
Returns:
the line that summarizes this detail page, null if this is not a detail page. The terminology of master and detail comes from the database world where heirarchical reports which show information in a parent-child format are often referred to as master-detail reports.

setMasterLine

public void setMasterLine(Line masterLine)
See Also:
getMasterLine()

getCategories

public LineCategory[] getCategories()
Get the line categories that are valid for this page.


addCategory

public void addCategory(LineCategory category)

getLabel

public java.lang.String getLabel()