com.imsweb.validation.entities.Rule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of validation Show documentation
Show all versions of validation Show documentation
Java implemenation of the SEER edits.
/*
* Copyright (C) 2007 Information Management Services, Inc.
*/
package com.imsweb.validation.entities;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Pattern;
import org.codehaus.groovy.control.CompilationFailedException;
import com.imsweb.validation.ConstructionException;
import com.imsweb.validation.ValidationServices;
import com.imsweb.validation.runtime.ParsedContexts;
import com.imsweb.validation.runtime.ParsedLookups;
import com.imsweb.validation.runtime.ParsedProperties;
import com.imsweb.validation.runtime.RuntimeUtils;
/**
* A Rule is the smallest entity in the validation engine. It defines
* an expression that is evaluated and reported if it fails. Rules are wrapped into
* {@link Validator}; they can be tied to a {@link Condition}.
*
* Created on Nov 9, 2007 by depryf
*/
public class Rule {
private static final Pattern _MESSAGE_PATTERN = Pattern.compile("\r?\n");
/**
* DB ID for this rule
*/
protected Long _ruleId;
/**
* Application ID (like a display ID) for this rule
*/
protected String _id;
/**
* Name for this rule
*/
protected String _name;
/**
* tag for this rule (tags are used in the Genedits framework)
*/
protected String _tag;
/**
* Java path for this rule
*/
protected String _javaPath;
/**
* Severity for this rule
*/
protected Integer _severity;
/**
* Failure message for this rule
*/
protected String _message;
/**
* Expression to evaluate for this rule
*/
protected String _expression;
/**
* Description for this rule
*/
protected String _description;
/**
* History for this rule
*/
protected Set _histories;
/**
* Parent Validator
*/
protected Validator _validator;
/**
* Category ID.
*/
protected String _category;
/**
* Condition IDs.
*/
protected Set _conditions;
/**
* Operator (AND or OR) to use for the set of conditions.
*/
protected Boolean _useAndForConditions;
/**
* Rule IDs on which this rule depends
*/
protected Set _dependencies;
/**
* Rule IDs that depends on this rule
*/
protected Set _invertedDependencies;
/**
* Set of properties contained in this rule; as their appear in the textual expression of the rule
*/
protected Set _rawProperties;
/**
* Set of lookup IDs used in this rule; as their appear in the textual expression of the rule
*/
protected Set _usedLookupIds;
/**
* Set of potential context entries (they are potential because they might not all be context entries;
* but if a context entry is used, it will be in this list...
*/
protected Set _potentialContextEntries;
/**
* If set to true, the rule won't be executed when validating a validatable, unless the rule is explicitly forced (default to false, should never be null)
*/
protected Boolean _ignored;
/**
* Agency (used for translated edits only)
*/
protected String _agency;
/**
* Whether the failures from this rule can be overridden or not; this field is not used in this library and was added for other projects using the library.
*/
protected Boolean _allowOverride;
/**
* Whether this rule needs to be reviewed or not; this field is not used in this library and was added for other projects using the library.
*/
protected Boolean _needsReview;
/**
* Constructor.
*
* Created on Nov 9, 2007 by depryf
*/
public Rule() {
_conditions = new HashSet<>();
_histories = new HashSet<>();
_dependencies = new HashSet<>();
_invertedDependencies = new HashSet<>();
_rawProperties = new HashSet<>();
_usedLookupIds = new HashSet<>();
_potentialContextEntries = new HashSet<>();
_ignored = Boolean.FALSE;
_useAndForConditions = Boolean.TRUE;
_allowOverride = Boolean.FALSE;
_needsReview = Boolean.FALSE;
}
/**
* Getter for the rule persistence ID. Must be unique within the validation engine.
*
* In a system persisting the rules in a database, that would represent a database primary key.
* In a system using only memory objects loaded from XML, it should be assigned using the
* getNextRuleSequence() method in ValidationServices.
*
* Created on Mar 10, 2011 by depryf
* @return the rule persistence ID
*/
public Long getRuleId() {
return _ruleId;
}
/**
* Setter for the rule persistence ID. Must be unique within the validation engine.
*
* In a system persisting the rules in a database, that would represent a database primary key.
* In a system using only memory objects loaded from XML, it should be assigned using the
* getNextRuleSequence() method in ValidationServices.
*
* Created on Mar 10, 2011 by depryf
* @param ruleId rule persistence ID
*/
public void setRuleId(Long ruleId) {
_ruleId = ruleId;
}
/**
* Getter for the ID. The rule ID must be unique within the validation engine.
*
* Created on Mar 10, 2011 by depryf
* @return the rule ID
*/
public String getId() {
return _id;
}
/**
* Setter for the ID. The rule ID must be unique within the validation engine.
*
* Created on Mar 10, 2011 by depryf
* @param id the rule ID
*/
public void setId(String id) {
_id = id;
}
/**
* Getter for the name.
*
* Created on Mar 10, 2011 by depryf
* @return the rule name
*/
public String getName() {
return _name;
}
/**
* Setter for the name.
*
* Created on Mar 10, 2011 by depryf
* @param name the rule name
*/
public void setName(String name) {
_name = name;
}
/**
* Getter for the tag.
*
* Created on May 19, 2017 by depryf
* @return the rule tag
*/
public String getTag() {
return _tag;
}
/**
* Setter for the tag.
*
* Created on May 19, 2017 by depryf
* @param tag the rule tag
*/
public void setTag(String tag) {
_tag = tag;
}
/**
* Getter for the java path.
*
* Created on Mar 10, 2011 by depryf
* @return the rule java path
*/
public String getJavaPath() {
return _javaPath;
}
/**
* Setter for the java path.
*
* Created on Mar 10, 2011 by depryf
* @param path the java path, cannot be null or blank
*/
public void setJavaPath(String path) {
_javaPath = path;
}
/**
* Getter for the severity (the meaning of the severity is application-dependent; the severity is not used by the validation engine).
*
* Created on Mar 10, 2011 by depryf
* @return the rule severity
*/
public Integer getSeverity() {
return _severity;
}
/**
* Setter for the severity (the meaning of the severity is application-dependent; the severity is not used by the validation engine).
*
* Created on Mar 10, 2011 by depryf
* @param severity the rule severity
*/
public void setSeverity(Integer severity) {
_severity = severity;
}
/**
* Getter for the failure message.
*
* Created on Mar 10, 2011 by depryf
* @return the rule failure message
*/
public String getMessage() {
return _message;
}
/**
* Setter for the failure message.
*
* Created on Mar 10, 2011 by depryf
* @param message the rule failure message
*/
public void setMessage(String message) {
if (message != null)
message = _MESSAGE_PATTERN.matcher(message).replaceAll(" ").trim();
_message = message;
}
/**
* Getter for the expression (Groovy script).
*
* Created on Mar 10, 2011 by depryf
* @return the rule expression
*/
public String getExpression() {
return _expression;
}
/**
* Setter for the expression (Groovy script).
*
* This method will compile the script and gather the used properties, context entries and lookup IDs.
*
* Created on Mar 10, 2011 by depryf
* @param expression the rule expression
* @throws ConstructionException if the expression is not valid Groovy
*/
public void setExpression(String expression) throws ConstructionException {
if (!Objects.equals(expression, _expression)) {
_expression = expression;
synchronized (this) {
try {
_rawProperties.clear();
_potentialContextEntries.clear();
_usedLookupIds.clear();
ValidationServices.getInstance().parseExpression("rule", _expression, _rawProperties, _potentialContextEntries, _usedLookupIds);
}
catch (CompilationFailedException e) {
throw new ConstructionException("Unable to parse rule " + getId(), e);
}
}
}
}
/**
* Setter for the expression taking pre-parsed objects for optimization.
*/
public void setExpression(String expression, ParsedProperties parsedProperties, ParsedContexts parsedContexts, ParsedLookups parsedLookups) throws ConstructionException {
// we are going to use the pre-parsed stuff only if they are all available, otherwise we don't use any of them...
Set properties = RuntimeUtils.getParsedProperties(parsedProperties, _id);
Set contexts = RuntimeUtils.getParsedContexts(parsedContexts, _id);
Set lookups = RuntimeUtils.getParsedLookups(parsedLookups, _id);
if (properties != null && contexts != null && lookups != null) {
_expression = expression;
_rawProperties = properties;
_potentialContextEntries = contexts;
_usedLookupIds = lookups;
}
else
setExpression(expression);
}
/**
* Getter for the description.
*
* Created on Mar 10, 2011 by depryf
* @return the rule description
*/
public String getDescription() {
return _description;
}
/**
* Setter for the description.
*
* Created on Mar 10, 2011 by depryf
* @param description the rule description
*/
public void setDescription(String description) {
_description = description;
}
/**
* Getter for the RuleHistorys.
*
* Created on Mar 10, 2011 by depryf
* @return the set of RuleHistory, maybe empty but never null
*/
public Set getHistories() {
return _histories;
}
/**
* Setter for the RuleHistorys.
*
* Created on Mar 10, 2011 by depryf
* @param histories the set of RuleHistory
*/
public void setHistories(Set histories) {
_histories = histories == null ? new HashSet<>() : histories;
}
/**
* Getter for the category.
*
* Created on Mar 10, 2011 by depryf
* @return the category, maybe null
*/
public String getCategory() {
return _category;
}
/**
* Setter for the category.
*
* Created on Mar 10, 2011 by depryf
* @param category category
*/
public void setCategory(String category) {
_category = category;
}
/**
* Getter for the conditions.
*
* Created on Mar 10, 2011 by depryf
* @return the conditions, maybe null
*/
public Set getConditions() {
return _conditions;
}
/**
* Setter for the conditions.
*
* Created on Mar 10, 2011 by depryf
* @param conditions conditions
*/
public void setConditions(Set conditions) {
_conditions = conditions;
}
/**
* Getter for the properties used in the expression.
*
* Created on Mar 10, 2011 by depryf
* @return the set of properties, maybe empty but never null
*/
public Set getRawProperties() {
return _rawProperties;
}
/**
* Getter for the lookup IDs used in the expression.
*
* Created on Mar 10, 2011 by depryf
* @return the set of used lookup IDs, maybe empty but never null
*/
public Set getUsedLookupIds() {
return _usedLookupIds;
}
/**
* Getter for the dependencies (the rule IDs on which this rule depends).
*
* Created on Mar 10, 2011 by depryf
* @return the set of dependencies, maybe empty but never null
*/
public Set getDependencies() {
return _dependencies;
}
/**
* Setter for the dependencies (the rule IDs on which this rule depends).
*
* Created on Mar 10, 2011 by depryf
* @param dependencies the set of dependencie
*/
public void setDependencies(Set dependencies) {
_dependencies = dependencies == null ? new HashSet<>() : dependencies;
}
/**
* Getter for the inverted dependencies (the rule IDs that depend on this rule).
*
* Created on Mar 10, 2011 by depryf
* @return the set of inverted dependencies, maybe empty but never null
*/
public Set getInvertedDependencies() {
return _invertedDependencies;
}
/**
* Setter for the inverted dependencies (the rule IDs that depend on this rule).
*
* Created on Mar 10, 2011 by depryf
* @param invertedDependencies the set of inverted dependencies
*/
public void setInvertedDependencies(Set invertedDependencies) {
_invertedDependencies = invertedDependencies == null ? new HashSet<>() : invertedDependencies;
}
/**
* Setter for the parent Validator.
* @param validator validator
*/
public void setValidator(Validator validator) {
_validator = validator;
}
/**
* Getter for the parent Validator.
*
* Created on Mar 10, 2011 by depryf
* @return a Validator
*/
public Validator getValidator() {
return _validator;
}
/**
* Getter for the ignored flag.
*
* Created on Mar 10, 2011 by depryf
* @return true if the rule is ignored
*/
public Boolean getIgnored() {
return _ignored;
}
/**
* Setter for the ignored flag.
*
* Created on Mar 10, 2011 by depryf
* @param ignored the ignored flag to set
*/
public void setIgnored(Boolean ignored) {
_ignored = ignored == null ? Boolean.FALSE : ignored;
}
/**
* Getter for the condition operator.
*
* Created on Mar 10, 2011 by depryf
* @return true if the conditions should be AND'ed, false otherwise
*/
public Boolean getUseAndForConditions() {
return _useAndForConditions;
}
/**
* Setter for the condition operator.
*
* Created on Mar 10, 2011 by depryf
* @param useAndForConditions true if the conditions should be AND'ed, false otherwise
*/
public void setUseAndForConditions(Boolean useAndForConditions) {
_useAndForConditions = useAndForConditions == null ? Boolean.TRUE : useAndForConditions;
}
/**
* Getter for the potential context entries referenced in the expression.
*
* Created on Mar 10, 2011 by depryf
* @return the set of potential context entries, maybe empty but never null
*/
public Set getPotentialContextEntries() {
return _potentialContextEntries;
}
/**
* Getter
*
* Created on Mar 10, 2011 by depryf
* @return the agency
*/
public String getAgency() {
return _agency;
}
/**
* Setter
*
* Created on Mar 10, 2011 by depryf
* @param agency the agency
*/
public void setAgency(String agency) {
_agency = agency;
}
/**
* Getter
*
* Created on Mar 10, 2011 by depryf
* @return whether override is allowed
*/
public Boolean getAllowOverride() {
return _allowOverride;
}
/**
* Setter
*
* Created on Mar 10, 2011 by depryf
* @param allowOverride whether override is allowed
*/
public void setAllowOverride(Boolean allowOverride) {
_allowOverride = allowOverride;
}
/**
* Getter
*
* Created on Mar 10, 2011 by depryf
* @return whether this rule needs to be reviewed
*/
public Boolean getNeedsReview() {
return _needsReview;
}
/**
* Setter
*
* Created on Mar 10, 2011 by depryf
* @param needsReview whether this rule needs to be reviewed
*/
public void setNeedsReview(Boolean needsReview) {
_needsReview = needsReview;
}
@Override
public String toString() {
return getId() + " {" + getMessage() + "}";
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Rule)) return false;
Rule rule = (Rule)o;
if (_ruleId != null && rule._ruleId != null)
return Objects.equals(_ruleId, rule._ruleId);
return Objects.equals(_id, rule._id);
}
@Override
public int hashCode() {
if (_ruleId != null)
return Objects.hash(_ruleId);
return Objects.hash(_id);
}
}