Constraint

The Constraint class is an abstract class that is the parent of all other Constraint subclasses. A constraint is a rule or set of rules that a variant must satisfy to qualify as a valid member of the Categorical Variant. Constraint subclasses are only used in Categorical Variant objects.

Trial Use

May change in future releases. See Maturity Model.

Abstract Class — not instantiated directly; concrete subclasses inherit its attributes.

Sealed — Constraint has a closed, exhaustive set of concrete subclasses; every one is listed below. No other subclass is permitted, and a conforming instance must be exactly one of these types.

Computational Definition

Constraints are used to construct an intensional semantics of categorical variant types.

Information Model

Field

Flags

Type

Limits

Description

type

string

1..1

MUST be set to the name of the concrete Constraint subtype.

This class must match one of the following:

Subclasses: Adjacency Constraint, Copy Change Constraint, Copy Count Constraint, Defining Allele Constraint, Defining Location Constraint, Feature Context Constraint, Function Constraint

Used in: Categorical Variant

Examples

This documentation contains several Examples, organized by Constraint. Each Constraint and Recipe also include representative examples inline with their documentation.

Implementation Guidance

Please refer to specific Constraint subclasses for implementation guidance.