Contingent values are a data design feature that allow you to make values in one field dependent upon values in another field. In other words, contingent values are how you define a set of attributevoltage level for a pole determines what material values are valid; each material might have a set of appropriate heights from which to choose. Contingent values let you define all valid combinations of values for two or more attribute fields within a dataset.
What contingent values look like
You can author contingent values using ArcGIS Pro
Contingent values are defined in one or more field groups. A field group is a named collection of attribute
For each field group, contingent values define all combinations of appropriate values for the participating fields. The value you provide for each field depends on the type of domain associated with it (coded value or range). You can also provide special values to indicate that any value in the domain is considered valid or that a null value is valid (for fields that accept null values). Note that the any value also includes null.
The following image shows a field group that defines a set of contingent values for power poles. The fields Voltage, Material, and Height use coded value domains for their values, while Diameter uses a range domain. Poles that have a value of Wood for the Material field can have any value for Height that’s in the associated domain (or null) without violating the contingent values.
Access contingent values in your app
Classes and helper methods are provided for reading contingent value definitions for a dataset and for determining contingent value violations for a specific feature
Contingent values can be read from an ArcGISFeatureTable. Here are some of the classes used to represent contingent values:
ContingentValuesDefinition—Contains all the field groups that define contingent values for the dataset. The contingent values definition is exposed as a property onArcGISFeatureTable.
-
FieldGroup—Defines all possible contingent values for a set of fields. The contingent values definition contains a collection of field groups. -
Contingency—Defines a set of contingent values for a field group. -
ContingentValue—A base class that defines a possible value for a field participating in a field group. A contingent value can be one of the following:ContingentCodedValue—A value from a coded value domain.ContingentRangeValue—Defines a minimum and maximum range of values.ContingentAnyValue—Indicates that any value in the field’s domain is considered valid (as well asnull).ContingentNullValue—Indicates that anullvalue is valid for the field.
In addition to these classes, the API provides the following helper methods on ArcGISFeatureTable. In many cases, these helper methods are all you need to provide contingent value support when editing the table
-
ArcGISFeatureTable.getContingentValues()—Returns contingent values for a provided featureA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes. and attributeAttributes are fields and values for a single feature or non-spatial record. They are typically stored in a database or service such as a feature service. field. -
ArcGISFeatureTable.validateContingencyConstraints()—Validates a featureA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes. against contingent values defined for the dataset.
Edit with contingent values
Contingent values do not enforce data integrity or attribute
Get contingent values
Contingent values are derived from values in an attribute
To get the contingent values for a field, use the ArcGISFeatureTable.getContingentValues()helper method and pass the current feature
The following code gets all contingent coded values for the specified field based on the other attribute
// Store a hashmap of values from the contingent values definition.HashMap<String, Object> availableValues = new HashMap<>();
// Get all contingent values defined for a specified field name.// The attribute values of the feature determine which contingent values are returned.// Assume that inFeature has these attribute values:// Voltage="Low"; Material="Composite"; Height="35"; and Diameter=7 .// If the field name is "Material", the resulting contingent values are:// Composite; Wood; Carbon fiber.fieldName = "Material";
ContingentValuesResult contingentValuesResult = polesFeatureTable.getContingentValues(inFeature, fieldName);
// Get a list of contingent values for a specified field group.Map<String, List<ContingentValue>> contingentVals = contingentValuesResult.getContingentValuesByFieldGroup();
String fieldGroupName = "pole_contingent_values";
List<ContingentValue> fieldGroupContingentVals = contingentVals.get(fieldGroupName);
//Get the contingent values for a specified field group.if (fieldGroupContingentVals != null) { // Loop through all contingent values. for (ContingentValue cv : fieldGroupContingentVals) { // Add coded values to the hashmap (name and code). if (cv instanceof ContingentCodedValue contingentCodedValue) { availableValues.put( contingentCodedValue.getCodedValue().getName(), contingentCodedValue.getCodedValue().getCode() );
}If the contingent values are from a range domain, you can return the minimum and maximum values for the valid range.
// (continued from above)
// A contingent range value has a minimum and a maximum value. else if (cv instanceof ContingentRangeValue contingentRangeValue) { availableValues.put("min", contingentRangeValue.getMinValue()); availableValues.put("max", contingentRangeValue.getMaxValue()); }If a ContingentAnyValue is defined for the field, you can provide all values from the field’s domain as valid edit choices.
// (continued from above)
else if (cv instanceof ContingentAnyValue) { // Get the domain for this field. Domain domain = polesFeatureTable.getField(fieldName).getDomain();
if (domain instanceof CodedValueDomain codedValueDomain) { // Add all values from the field's domain. List<CodedValue> codedValuesList = codedValueDomain.getCodedValues();
for (CodedValue codedValue : codedValuesList) { availableValues.put(codedValue.getName(), codedValue.getCode()); } } } } // end for (ContingentValue cv : fieldGroupContingentVals).} // end if (fieldGroupContingentVals != null).Validate edits against contingent values
To see if a feature’s attributeArcGISFeatureTable.validateContingencyConstraints() helper method and pass a featureContingencyConstraintViolation that you can use to enforce edit restrictions or provide warnings to the user.
Each contingency constraint violation will indicate if it is a warning or an error, and which field group contained the violated contingent value. A violation is considered an error if the field group is marked as restrictive. A restrictive field group means that edits to any of the participating fields should conform to previously defined contingent values. If a field group is not restrictive, then a violation alert is considered a warning.
// Get any contingency constraint violations for the new feature.List<ContingencyConstraintViolation> contingencyValueViolations = polesFeatureTable.validateContingencyConstraints(inFeature);
// If there are no violations, let the user save.if (contingencyValueViolations.isEmpty()) { saveFeatureButton.setDisable(false);
new Alert(Alert.AlertType.INFORMATION,"Contingent values validated").showAndWait();
return;}
// Loop through contingency violations and show messages for errors and warnings.// Include the name of the field group that had the violation.String msg = "Contingency value violation for field group(s): ";
for (ContingencyConstraintViolation violation : contingencyValueViolations) { msg = msg + "'" + violation.getFieldGroup().getName() + "' ";}
new Alert(Alert.AlertType.WARNING,msg).showAndWait();