de.smartics.properties.report.data
Interface PropertyReport

All Known Implementing Classes:

AbstractPropertyReport, InMemoryPropertyReport, PropertiesPropertyReport, XmlPropertyReport

public interface PropertyReport

Sink to accept report items. Implementations may either store that information in memory or write it to a store.

Method Summary

void	addProblem(ReportProblem problem) Reports a problem encountered while analyzing for report items.
List<ReportProblem>	getProblems() Returns the list of problems encountered while parsing sources and fetching report information.
void	handle(PropertyReportItem item) Passes a report item to the report.
void	handle(PropertyReportSet reportSet) Passes a report set document information to the report.
boolean	hasProblems() Checks if there are reported problems.
void	traverseAliases(de.smartics.properties.api.core.context.alias.AliasTraverser traverser) Allows to traverse the collected aliases.

Method Detail

handle

void handle(PropertyReportSet reportSet)
            throws ReportException

Passes a report set document information to the report.

Parameters:

reportSet - the report set to handle.

Throws:

ReportException - on any problem that prevents the report to digest the given set.

handle

void handle(PropertyReportItem item)
            throws ReportException

Passes a report item to the report.

Parameters:

item - the report item to handle.

Throws:

ReportException - on any problem that prevents the report to digest the given item.

addProblem

void addProblem(ReportProblem problem)

Reports a problem encountered while analyzing for report items.

Parameters:

problem - a description to the problem encountered.

hasProblems

boolean hasProblems()

Checks if there are reported problems.

Returns:

true if at least one report problem is reported, false if there are none.

getProblems

List<ReportProblem> getProblems()

Returns the list of problems encountered while parsing sources and fetching report information.

Returns:

the list of problems encountered while parsing sources and fetching report information.

traverseAliases

void traverseAliases(de.smartics.properties.api.core.context.alias.AliasTraverser traverser)

Allows to traverse the collected aliases.

Parameters:

traverser - the traverser to traverse the aliases.