Class DefinitionManager

constructor

• new DefinitionManager(): DefinitionManager

  Returns DefinitionManager

definitions

addDefinition

• addDefinition(definition: Definition): Issue[]

  Add a Definition object to this manager.

  Parameters

  • definition: Definition

    The definition to be added.

  Returns Issue[]

  Issues encountered in adding the definition.

addDefinitions

• addDefinitions(defs: Definition[]): Issue[]

  Add the non-null definitions to this manager.

  Parameters

  • defs: Definition[]

    The list of definitions to add to this manager.

  Returns Issue[]

  Issues encountered in adding the definitions.

evaluateTag

• evaluateTag(
      tag: ParsedHedTag,
      hedSchemas: Schemas,
      placeholderAllowed: boolean,
  ): any[]

  Evaluate the definition based on a parsed HED tag.

  Parameters

  • tag: ParsedHedTag

    The tag to evaluate against the definitions.

  • hedSchemas: Schemas

    The schemas to be used to assist in the evaluation.

  • placeholderAllowed: boolean

    If true then placeholder is allowed in the def tag.

  Returns any[]

  A tuple [string|null, Issue[]] with definition contents for this tag and any issues.

  Note: If the tag is not a Def or Def-expand, this returns null for the string and [] for the issues.

findDefinition

• findDefinition(tag: ParsedHedTag): any[]

  Find the definition associated with a tag, if any.

  Parameters

  • tag: ParsedHedTag

    The parsed HEd tag to be checked.

  Returns any[]

  A tuple [Definition|null, Issue[]] with the definition and any issues found. If no match is found, the first element is null.

validateDefExpands

• validateDefExpands(
      hedString: ParsedHedString,
      hedSchemas: Schemas,
      placeholderAllowed: boolean,
  ): Issue[]

  Check the Def tags in a HED string for missing or incorrectly used Def-expand tags.

  Parameters

  • hedString: ParsedHedString

    A parsed HED string to be checked.

  • hedSchemas: Schemas

    Schemas to validate against.

  • placeholderAllowed: boolean

    If true then placeholder is allowed in the def tag.

  Returns Issue[]

  If there is no matching definition or definition applied incorrectly.

validateDefs

• validateDefs(
      hedString: ParsedHedString,
      hedSchemas: Schemas,
      placeholderAllowed: boolean,
  ): Issue[]

  Check the Def tags in a HED string for missing or incorrectly used Def tags.

  Parameters

  • hedString: ParsedHedString

    A parsed HED string to be checked.

  • hedSchemas: Schemas

    Schemas to validate against.

  • placeholderAllowed: boolean

    If true then placeholder is allowed in the def tag.

  Returns Issue[]

  If there is no matching definition or definition applied incorrectly.

StaticcreateDefinitions

• createDefinitions(defStrings: string[], hedSchemas: Schemas): any[]

  Create a list of Definition objects from a list of strings.

  Parameters

  • defStrings: string[]

    A list of string definitions.

  • hedSchemas: Schemas

    The HED schemas to use in creation.

  Returns any[]

  A tuple [Definition[], Issue[]] with a definition list and any issues found.