Package com.inet.problemfinder
Class ProblemFinder
- java.lang.Object
-
- com.inet.problemfinder.ProblemFinder
-
public class ProblemFinder extends java.lang.Object
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.
UsegetInstance()
to get ProblemFinder instance for checking reports.
To check an Engine, use the Methodcheck(Engine, int)
.
This Method needs theEngine
to check and a specific type which defines the kind of checks that will be run.
For a complete check the type should beCHECK_ALL
.
TheProblemFinder
provides two Methods to get the result.
ThegetWarningList()
returns a list ofProblemFinderWarning
s found in the given main Engine.
ThegetSubreportWarningMap()
returns a Map over allSubreport
-Engines with their own list ofProblemFinderWarning
s.
WithclearAll()
the list and the map will be empty.Attention: The
Example:ProblemFinderWarning
AutoFix-Actions manipulate theEngine
, 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:
ProblemFinderWarning
-
-
Field Summary
Fields Modifier and Type Field Description static int
CHECK_ALL
CHECK_ALL
type to check allstatic int
CHECK_ELEMENT
CHECK_ELEMENT
type to checkElement
sstatic int
CHECK_FIELD_FORMULA
CHECK_FIELD_FORMULA
type to checkFormulaField
sstatic int
CHECK_FIELD_PROMPT
CHECK_FIELD_PROMPT
type to checkPromptField
sstatic int
CHECK_FIELD_SQL
CHECK_FIELD_SQL
type to checkSQLField
sstatic int
CHECK_FIELD_SUMMARY
CHECK_FIELD_SUMMARY
type to checkSummaryField
sstatic int
CHECK_FIELDS
CHECK_FIELDS
type to check allField
sstatic int
CHECK_PROPERTYFORMULA
CHECK_PROPERTYFORMULA
type to check propertyFormulaField
sstatic int
CHECK_REPORT
CHECK_REPORT
type to check property executed reportsstatic int
CHECK_SECTION
CHECK_SECTION
type to checkSection
s
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRules(ProblemFinderRule rule)
Add a new rules to the problem finder from a plugin.boolean
check(Engine engine, int type)
Start aEngine
-check by a given type.void
clearAll()
Removes all of theProblemFinderWarning
s from the warnings list and the subreport warnings map.static ProblemFinder
getInstance()
Returns theProblemFinder
singleton instance.java.util.HashMap<Engine,java.util.List<ProblemFinderWarning>>
getSubreportWarningMap()
java.util.List<ProblemFinderWarning>
getWarningList()
Returns a list ofProblemFinderWarning
s found in the given main Engine.void
setUserProperties(java.util.Properties userProperties)
Sets user properties for the engine to check.
-
-
-
Field Detail
-
CHECK_FIELD_FORMULA
public static final int CHECK_FIELD_FORMULA
CHECK_FIELD_FORMULA
type to checkFormulaField
s- See Also:
- Constant Field Values
-
CHECK_FIELD_SQL
public static final int CHECK_FIELD_SQL
CHECK_FIELD_SQL
type to checkSQLField
s- See Also:
- Constant Field Values
-
CHECK_FIELD_SUMMARY
public static final int CHECK_FIELD_SUMMARY
CHECK_FIELD_SUMMARY
type to checkSummaryField
s- See Also:
- Constant Field Values
-
CHECK_FIELD_PROMPT
public static final int CHECK_FIELD_PROMPT
CHECK_FIELD_PROMPT
type to checkPromptField
s- See Also:
- Constant Field Values
-
CHECK_FIELDS
public static final int CHECK_FIELDS
CHECK_FIELDS
type to check allField
s- See Also:
- Constant Field Values
-
CHECK_ELEMENT
public static final int CHECK_ELEMENT
CHECK_ELEMENT
type to checkElement
s- See Also:
- Constant Field Values
-
CHECK_SECTION
public static final int CHECK_SECTION
CHECK_SECTION
type to checkSection
s- See Also:
- Constant Field Values
-
CHECK_PROPERTYFORMULA
public static final int CHECK_PROPERTYFORMULA
CHECK_PROPERTYFORMULA
type to check propertyFormulaField
s- See Also:
- Constant Field Values
-
CHECK_REPORT
public static final int CHECK_REPORT
CHECK_REPORT
type to check property executed reports- See Also:
- Constant Field Values
-
CHECK_ALL
public static final int CHECK_ALL
CHECK_ALL
type to check all- See Also:
- Constant Field Values
-
-
Method Detail
-
getInstance
public static ProblemFinder getInstance()
Returns theProblemFinder
singleton instance.- Returns:
- the static ProblemFinder instance.
- Since:
- 11.0
-
addRules
public void addRules(ProblemFinderRule rule)
Add a new rules to the problem finder from a plugin.- Parameters:
rule
- the new rules to be add- Since:
- 20.10
-
setUserProperties
public void setUserProperties(java.util.Properties userProperties)
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 theProblemFinderWarning
s 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
public boolean check(Engine engine, int type)
Start aEngine
-check by a given type.- Parameters:
engine
- givenEngine
that has to be checked.type
- the type that says what to be checked.- Returns:
true
if the check was succeed,false
if the check-thread was interrupted- Since:
- 11.0
- See Also:
CHECK_ALL
,CHECK_ELEMENT
,CHECK_FIELD_FORMULA
,CHECK_FIELD_PROMPT
,CHECK_FIELD_SQL
,CHECK_FIELD_SUMMARY
,CHECK_FIELDS
,CHECK_PROPERTYFORMULA
,CHECK_SECTION
-
getWarningList
public java.util.List<ProblemFinderWarning> getWarningList()
Returns a list ofProblemFinderWarning
s found in the given main Engine.- Returns:
- The main
ProblemFinderWarning
list with the current warnings. - Since:
- 11.0
-
getSubreportWarningMap
public java.util.HashMap<Engine,java.util.List<ProblemFinderWarning>> getSubreportWarningMap()
- Returns:
- The
ProblemFinderWarning
list of the current warnings for each Subreport-Engine. - Since:
- 11.0
-
-