de.smartics.properties.reports
Class AbstractPropertyReport

java.lang.Object
  de.smartics.properties.reports.AbstractPropertyReport

All Implemented Interfaces:

PropertyReport

Direct Known Subclasses:

InMemoryPropertyReport, PropertiesPropertyReport, XmlPropertyReport

@NotThreadSafe
public abstract class AbstractPropertyReport
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      PropertyReport
     
     

Writes each report to a file.

Constructor Summary

protected

AbstractPropertyReport() Default constructor.

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.
boolean	hasProblems() Checks if there are reported problems.
protected void	register(PropertyReportItem item) Registers a report item to manage the alias mapping and check for uniqueness constraint violations.
void	traverseAliases(de.smartics.properties.api.core.context.alias.AliasTraverser traverser) Allows to traverse the collected aliases.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.smartics.properties.report.data.PropertyReport

handle

Constructor Detail

AbstractPropertyReport

protected AbstractPropertyReport()

Default constructor.

Method Detail

getProblems

public final List<ReportProblem> getProblems()

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

Specified by:

getProblems in interface PropertyReport

Returns:

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

See Also:

PropertyReport.getProblems()

addProblem

public final void addProblem(ReportProblem problem)

Reports a problem encountered while analyzing for report items.

Specified by:

addProblem in interface PropertyReport

Parameters:

problem - a description to the problem encountered.

See Also:

PropertyReport.addProblem(de.smartics.properties.report.data.ReportProblem)

hasProblems

public final boolean hasProblems()

Checks if there are reported problems.

Specified by:

hasProblems in interface PropertyReport

Returns:

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

See Also:

PropertyReport.hasProblems()

traverseAliases

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

Allows to traverse the collected aliases.

Specified by:

traverseAliases in interface PropertyReport

Parameters:

traverser - the traverser to traverse the aliases.

See Also:

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

handle

public void handle(PropertyReportItem item)
            throws ReportException

Passes a report item to the report.

Registers a report item to manage the alias mapping and check for uniqueness constraint violations.

Specified by:

handle in interface PropertyReport

Parameters:

item - the report item to handle.

Throws:

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

See Also:

PropertyReport.handle(de.smartics.properties.report.data.PropertyReportItem)

register

protected final void register(PropertyReportItem item)

Registers a report item to manage the alias mapping and check for uniqueness constraint violations.

Parameters:

item - the report item to manage.