org.hkijena.jipipe.api

Class JIPipeIssueReport

java.lang.Object

org.hkijena.jipipe.api.JIPipeIssueReport

public class JIPipeIssueReport
extends Object

Report about the validity of an object, usually a JIPipeValidatable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeIssueReport.Issue A validity report message

Constructor Summary

Constructors

Constructor and Description
JIPipeIssueReport() Creates a new report instance

Method Summary

Modifier and Type	Method and Description
void	checkIfWithin(Object source, double value, double min, double max, boolean includeMin, boolean includeMax) Reports as invalid if the value is not within the limits
void	checkNonEmpty(Object value, Object source) Reports as invalid if the string value is null or empty
void	checkNonNull(Object value, Object source) Reports as invalid if the value is null
void	clearAll() Clears all the issues in this report and all related reports
void	clearCurrentPath() Clears issues of the current path
Multimap<String,JIPipeIssueReport.Issue>	getIssues() Gets the map of all issues
String	getPath() Gets the current path (formatted)
List<String>	getPathComponents() Gets the current path components
boolean	isInvalid() Returns true if there is at least one issue
boolean	isValid() Returns true if there are no issues
void	print() Prints messages to the standard error
void	report(JIPipeIssueReport.Issue issue) Reports an issue
void	report(JIPipeValidatable validatable) Reports a JIPipeValidatable into this report
void	reportIsInvalid(String what, String why, String how, Object source) Reports that this report is invalid
JIPipeIssueReport	resolve(String pathComponent) Returns a report for the specified category

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeIssueReport

public JIPipeIssueReport()

Creates a new report instance

Method Detail

clearAll

public void clearAll()

Clears all the issues in this report and all related reports

clearCurrentPath

public void clearCurrentPath()

Clears issues of the current path

getIssues

public Multimap<String,JIPipeIssueReport.Issue> getIssues()

Gets the map of all issues

Returns:

the issues (modifiable)

isValid

public boolean isValid()

Returns true if there are no issues

Returns:

if there are no issues

isInvalid

public boolean isInvalid()

Returns true if there is at least one issue

Returns:

if there are issues

getPathComponents

public List<String> getPathComponents()

Gets the current path components

Returns:

the path components

getPath

public String getPath()

Gets the current path (formatted)

Returns:

the path

resolve

public JIPipeIssueReport resolve(String pathComponent)

Returns a report for the specified category

Parameters:

pathComponent - the category

Returns:

the sub-report

report

public void report(JIPipeIssueReport.Issue issue)

Reports an issue

Parameters:

issue - the issue

report

public void report(JIPipeValidatable validatable)

Reports a JIPipeValidatable into this report

Parameters:

validatable - the validatable

reportIsInvalid

public void reportIsInvalid(String what,
                            String why,
                            String how,
                            Object source)

Reports that this report is invalid

Parameters:

what - explanation what happened

why - explanation why it happened

how - explanation how to solve the issue

source - the source that triggers the check. passed to details

checkIfWithin

public void checkIfWithin(Object source,
                          double value,
                          double min,
                          double max,
                          boolean includeMin,
                          boolean includeMax)

Reports as invalid if the value is not within the limits

Parameters:

source - the source that triggers the check. passed to details

value - the value

min - interval start

max - interval end

includeMin - if the interval start is included

includeMax - if the interval end is included

checkNonNull

public void checkNonNull(Object value,
                         Object source)

Reports as invalid if the value is null

Parameters:

value - the value

source - the source that triggers the check. passed to details

checkNonEmpty

public void checkNonEmpty(Object value,
                          Object source)

Reports as invalid if the string value is null or empty

Parameters:

value - the value

source - the source that triggers the check. passed to details

print

public void print()

Prints messages to the standard error