Class: TextValidationSchema

Extends schema to define a string/text-specific set of validation rules that can be used.

 classDiagram
    class TextValidationSchema
    click TextValidationSchema href "../TextValidationSchema/"
      Schema <|-- TextValidationSchema
        click Schema href "../Schema/"

      TextValidationSchema : allowEmpty

      TextValidationSchema : dataType

      TextValidationSchema : maxLength

      TextValidationSchema : minLength

      TextValidationSchema : name

      TextValidationSchema : regexMatch

Inheritance

• Schema
  • TextValidationSchema

Attributes

Name	Cardinality and Range	Description	Inheritance
allowEmpty	0..1 boolean	If true, indicates a value must be provided	direct
minLength	0..1 integer	If set, indicates the minimum number of characters the value must have to be ...	direct
maxLength	0..1 integer	If set, indicates the maximum number of characters the value must have to be ...	direct
regexMatch	0..1 string	If set, indicates a regular expression to use to validate the value	direct
name	1 string	The name of the schema rule	Schema
dataType	1 string	Indicates the expected data type for the user provided value	Schema

---

This section is only relevant for contributors of the specification

LinkML Source

Direct

Details

name: TextValidationSchema
description: Extends schema to define a string/text-specific set of validation rules
  that can be used.
from_schema: https://specification.margo.org/data-model
is_a: Schema
attributes:
  allowEmpty:
    name: allowEmpty
    description: If true, indicates a value must be provided. Default is false if
      not provided.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - TextValidationSchema
    - BooleanValidationSchema
    - NumericIntegerValidationSchema
    - NumericDoubleValidationSchema
    - SelectValidationSchema
    range: boolean
    required: false
  minLength:
    name: minLength
    description: If set, indicates the minimum number of characters the value must
      have to be considered valid.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - TextValidationSchema
    range: integer
    required: false
  maxLength:
    name: maxLength
    description: If set, indicates the maximum number of characters the value must
      have to be considered valid.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - TextValidationSchema
    range: integer
    required: false
  regexMatch:
    name: regexMatch
    description: If set, indicates a regular expression to use to validate the value.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - TextValidationSchema
    range: string
    required: false

Induced

Details

name: TextValidationSchema
description: Extends schema to define a string/text-specific set of validation rules
  that can be used.
from_schema: https://specification.margo.org/data-model
is_a: Schema
attributes:
  allowEmpty:
    name: allowEmpty
    description: If true, indicates a value must be provided. Default is false if
      not provided.
    from_schema: https://specification.margo.org/application-schema
    alias: allowEmpty
    owner: TextValidationSchema
    domain_of:
    - TextValidationSchema
    - BooleanValidationSchema
    - NumericIntegerValidationSchema
    - NumericDoubleValidationSchema
    - SelectValidationSchema
    range: boolean
    required: false
  minLength:
    name: minLength
    description: If set, indicates the minimum number of characters the value must
      have to be considered valid.
    from_schema: https://specification.margo.org/application-schema
    alias: minLength
    owner: TextValidationSchema
    domain_of:
    - TextValidationSchema
    range: integer
    required: false
  maxLength:
    name: maxLength
    description: If set, indicates the maximum number of characters the value must
      have to be considered valid.
    from_schema: https://specification.margo.org/application-schema
    alias: maxLength
    owner: TextValidationSchema
    domain_of:
    - TextValidationSchema
    range: integer
    required: false
  regexMatch:
    name: regexMatch
    description: If set, indicates a regular expression to use to validate the value.
    from_schema: https://specification.margo.org/application-schema
    alias: regexMatch
    owner: TextValidationSchema
    domain_of:
    - TextValidationSchema
    range: string
    required: false
  name:
    name: name
    description: The name of the schema rule. This used in the [setting](#setting-attributes)
      to link the setting to the schema rule.
    from_schema: https://specification.margo.org/application-schema
    identifier: true
    alias: name
    owner: TextValidationSchema
    domain_of:
    - Component
    - Parameter
    - DeploymentMetadata
    - ApplicationMetadata
    - Author
    - Organization
    - Section
    - Setting
    - Schema
    - ComponentStatus
    range: string
    required: true
  dataType:
    name: dataType
    description: Indicates the expected data type for the user provided value. Accepted
      values are string, integer, double, boolean, array[string], array[integer],
      array[double], array[boolean]. At a minimum, the provided parameter value MUST
      match the schema's data type if no other validation rules are provided.
    from_schema: https://specification.margo.org/application-schema
    alias: dataType
    owner: TextValidationSchema
    domain_of:
    - Schema
    range: string
    required: true