Package com.inet.problemfinder
Class ProblemFinder
java.lang.Object
com.inet.problemfinder.ProblemFinder
This is the i-net Clear Reports Problem Finder.
The Problem Finder is a debug tool. It checks i-net Clear Reports reports for design flaws.
Use
To check an Engine, use the Method
This Method needs the
For a complete check the type should be
The
The
The
With
The Problem Finder is a debug tool. It checks i-net Clear Reports reports for design flaws.
Use
getInstance() to get ProblemFinder instance for checking reports.To check an Engine, use the Method
check(Engine, int).This Method needs the
Engine to check and a specific type which defines the kind of checks that will be run. For a complete check the type should be
CHECK_ALL.The
ProblemFinder provides two Methods to get the result. The
getWarningList() returns a list of ProblemFinderWarnings found in the given main Engine.The
getSubreportWarningMap() returns a Map over all Subreport-Engines with their own list of ProblemFinderWarnings.With
clearAll() the list and the map will be empty.
Attention: The ProblemFinderWarning AutoFix-Actions manipulate the Engine, use it carefully or back up your reports
if you plan on replacing your report files.
ProblemFinder problemFinder = ProblemFinder.getInstance();
Engine mainEngine = new Engine( Engine.NO_EXPORT );
URL source = this.getClass().getResource( "myReport.rpt" );
mainEngine.setReportFile( source );
problemFinder.check( mainEngine, ProblemFinder.CHECK_ALL );
List<ProblemFinderWarning> warningListMain = problemFinder.getWarningList();
for( ProblemFinderWarning warning : warningListMain ) {
System.out.println(warning.getMessage());
// ..do something else
}
HashMap<Engine, List<ProblemFinderWarning>> warningMap = problemFinder.getSubreportWarningMap();
for( Engine subEngine : warningMap.keySet() ) {
List<ProblemFinderWarning> warningListSub = warningMap.get( subEngine );
for( ProblemFinderWarning warning : warningListSub ) {
System.out.println(warning.getMessage());
// ..do something else
}
}
- Since:
- 11.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intCHECK_ALLtype to check allstatic final intCHECK_ELEMENTtype to checkElementsstatic final intCHECK_FIELD_FORMULAtype to checkFormulaFieldsstatic final intCHECK_FIELD_PROMPTtype to checkPromptFieldsstatic final intCHECK_FIELD_SQLtype to checkSQLFieldsstatic final intCHECK_FIELD_SUMMARYtype to checkSummaryFieldsstatic final intCHECK_FIELDStype to check allFieldsstatic final intCHECK_PROPERTYFORMULAtype to check propertyFormulaFieldsstatic final intCHECK_REPORTtype to check property executed reportsstatic final intCHECK_SECTIONtype to checkSections -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRules(ProblemFinderRule rule) Add a new rules to the problem finder from a plugin.booleanStart aEngine-check by a given type.voidclearAll()Removes all of theProblemFinderWarnings from the warnings list and the subreport warnings map.static ProblemFinderReturns theProblemFindersingleton instance.Returns a list ofProblemFinderWarnings found in the given main Engine.voidsetUserProperties(Properties userProperties) Sets user properties for the engine to check.
-
Field Details
-
CHECK_FIELD_FORMULA
public static final int CHECK_FIELD_FORMULACHECK_FIELD_FORMULAtype to checkFormulaFields- See Also:
-
CHECK_FIELD_SQL
public static final int CHECK_FIELD_SQLCHECK_FIELD_SQLtype to checkSQLFields- See Also:
-
CHECK_FIELD_SUMMARY
public static final int CHECK_FIELD_SUMMARYCHECK_FIELD_SUMMARYtype to checkSummaryFields- See Also:
-
CHECK_FIELD_PROMPT
public static final int CHECK_FIELD_PROMPTCHECK_FIELD_PROMPTtype to checkPromptFields- See Also:
-
CHECK_FIELDS
public static final int CHECK_FIELDSCHECK_FIELDStype to check allFields- See Also:
-
CHECK_ELEMENT
public static final int CHECK_ELEMENTCHECK_ELEMENTtype to checkElements- See Also:
-
CHECK_SECTION
public static final int CHECK_SECTIONCHECK_SECTIONtype to checkSections- See Also:
-
CHECK_PROPERTYFORMULA
public static final int CHECK_PROPERTYFORMULACHECK_PROPERTYFORMULAtype to check propertyFormulaFields- See Also:
-
CHECK_REPORT
public static final int CHECK_REPORTCHECK_REPORTtype to check property executed reports- See Also:
-
CHECK_ALL
public static final int CHECK_ALLCHECK_ALLtype to check all- See Also:
-
-
Method Details
-
getInstance
Returns theProblemFindersingleton instance.- Returns:
- the static ProblemFinder instance.
- Since:
- 11.0
-
addRules
Add a new rules to the problem finder from a plugin.- Parameters:
rule- the new rules to be add- Since:
- 20.10
-
setUserProperties
Sets user properties for the engine to check. The properties could have for example prompt values that the engine needs to render.- Parameters:
userProperties- the properties for the engine to set- Since:
- 20.10
-
clearAll
public void clearAll()Removes all of theProblemFinderWarnings from the warnings list and the subreport warnings map. The list and the map will be empty after this call returns.- Since:
- 11.0
-
check
Start aEngine-check by a given type.- Parameters:
engine- givenEnginethat has to be checked.type- the type that says what to be checked.- Returns:
trueif the check was succeed,falseif the check-thread was interrupted- Since:
- 11.0
- See Also:
-
getWarningList
Returns a list ofProblemFinderWarnings found in the given main Engine.- Returns:
- The main
ProblemFinderWarninglist with the current warnings. - Since:
- 11.0
-
getSubreportWarningMap
- Returns:
- The
ProblemFinderWarninglist of the current warnings for each Subreport-Engine. - Since:
- 11.0
-