Class DesignValidationResult

java.lang.Object

neqsim.process.mechanicaldesign.DesignValidationResult

All Implemented Interfaces:

Serializable

public class DesignValidationResult
extends Object
implements Serializable

Represents validation results from design calculations.

Collects warnings, errors, and info messages during design validation. Provides methods to check overall status and generate reports.

Version:

1.0

Author:

esol

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DesignValidationResult.Severity	Severity levels for validation messages.
static class	DesignValidationResult.ValidationMessage	Represents a single validation message.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	hasRun
private final List<DesignValidationResult.ValidationMessage>	messages
private final Map<String,Object>	metrics
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
DesignValidationResult()	Default constructor.

Method Summary

Modifier and Type	Method	Description
DesignValidationResult	addCritical(String category, String equipmentName, String message, String remediation)	Add a critical error message.
DesignValidationResult	addError(String category, String equipmentName, String message, String remediation)	Add an error message.
DesignValidationResult	addInfo(String equipmentName, String message)	Add an info message.
DesignValidationResult	addMessage(DesignValidationResult.Severity severity, String category, String equipmentName, String message, String remediation)	Add a validation message.
DesignValidationResult	addMetric(String name, Object value)	Add a metric value.
DesignValidationResult	addWarning(String category, String equipmentName, String message, String remediation)	Add a warning message.
int	getCount(DesignValidationResult.Severity severity)	Get count of messages by severity.
List<DesignValidationResult.ValidationMessage>	getMessages()	Get all validation messages.
List<DesignValidationResult.ValidationMessage>	getMessages(DesignValidationResult.Severity severity)	Get messages filtered by severity.
Map<String,Object>	getMetrics()	Get metrics map.
String	getSummary()	Generate a summary string.
Map<DesignValidationResult.Severity, Integer>	getSummaryCounts()	Get summary counts of all severities.
boolean	hasErrors()	Check if there are any errors.
boolean	hasRun()	Check if validation has been run.
boolean	hasWarnings()	Check if there are any warnings.
boolean	isValid()	Check if validation passed (no errors or critical issues).
DesignValidationResult	merge(DesignValidationResult other)	Merge another result into this one.
String	toString()

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

messages

private final List<DesignValidationResult.ValidationMessage> messages

metrics

private final Map<String,Object> metrics

hasRun

private boolean hasRun

Constructor Details

DesignValidationResult

public DesignValidationResult()

Default constructor.

Method Details

addMessage

public DesignValidationResult addMessage(DesignValidationResult.Severity severity,
 String category,
 String equipmentName,
 String message,
 String remediation)

Add a validation message.

Parameters:

severity - message severity

category - message category

equipmentName - affected equipment

message - the message

remediation - suggested fix

Returns:

this instance for chaining

addInfo

public DesignValidationResult addInfo(String equipmentName,
 String message)

Add an info message.

Parameters:

equipmentName - affected equipment

message - the message

Returns:

this instance for chaining

addWarning

public DesignValidationResult addWarning(String category,
 String equipmentName,
 String message,
 String remediation)

Add a warning message.

Parameters:

category - message category

equipmentName - affected equipment

message - the message

remediation - suggested fix

Returns:

this instance for chaining

addError

public DesignValidationResult addError(String category,
 String equipmentName,
 String message,
 String remediation)

Add an error message.

Parameters:

category - message category

equipmentName - affected equipment

message - the message

remediation - suggested fix

Returns:

this instance for chaining

addCritical

public DesignValidationResult addCritical(String category,
 String equipmentName,
 String message,
 String remediation)

Add a critical error message.

Parameters:

category - message category

equipmentName - affected equipment

message - the message

remediation - suggested fix

Returns:

this instance for chaining

addMetric

public DesignValidationResult addMetric(String name,
 Object value)

Add a metric value.

Parameters:

name - metric name

value - metric value

Returns:

this instance for chaining

getMessages

public List<DesignValidationResult.ValidationMessage> getMessages()

Get all validation messages.

Returns:

list of messages

getMessages

public List<DesignValidationResult.ValidationMessage> getMessages(DesignValidationResult.Severity severity)

Get messages filtered by severity.

Parameters:

severity - severity to filter by

Returns:

list of messages with specified severity

getMetrics

public Map<String,Object> getMetrics()

Get metrics map.

Returns:

metrics as map

isValid

public boolean isValid()

Check if validation passed (no errors or critical issues).

Returns:

true if no errors or critical issues

hasWarnings

public boolean hasWarnings()

Check if there are any warnings.

Returns:

true if warnings exist

hasErrors

public boolean hasErrors()

Check if there are any errors.

Returns:

true if errors exist

hasRun

public boolean hasRun()

Check if validation has been run.

Returns:

true if validation has run

getCount

public int getCount(DesignValidationResult.Severity severity)

Get count of messages by severity.

Parameters:

severity - severity level

Returns:

count of messages

getSummaryCounts

public Map<DesignValidationResult.Severity, Integer> getSummaryCounts()

Get summary counts of all severities.

Returns:

map of severity to count

merge

public DesignValidationResult merge(DesignValidationResult other)

Merge another result into this one.

Parameters:

other - the other result to merge

Returns:

this instance for chaining

getSummary

public String getSummary()

Generate a summary string.

Returns:

summary of validation results

toString

public String toString()

Overrides:

toString in class Object