Class ReservedChecker

constructor

• new ReservedChecker(): ReservedChecker

  Returns ReservedChecker

noExtensionTags

requiresDefTags

requireValueTags

reservedNames

timelineTags

StaticreservedMap

_checkGroupRequirements

• _checkGroupRequirements(
      group: ParsedHedGroup,
      reservedTag: ParsedHedTag,
  ): Issue[]

  Check the group tag requirements of a reserved Tag.

  Parameters

  • group: ParsedHedGroup

    The group to check for tag requirements.
  • reservedTag: ParsedHedTag

    A top-level reserved tag in group.

  Returns Issue[]

  • Returns an issue if the group requirements for this tag are not met.

_initializeReservedTags

• _initializeReservedTags(): void

  Returns void

checkHedString

• checkHedString(hedString: ParsedHedString, fullValidation: boolean): Issue[]

  Perform syntactical checks on the provided HED string to detect violations.

  Parameters

  • hedString: ParsedHedString

    The HED string to be checked.
  • fullValidation: boolean

    If true, perform full validation; otherwise, perform a quick check.

  Returns Issue[]

  • An array of issues if violations are found otherwise, an empty array.

checkNonTopGroups

• checkNonTopGroups(hedString: ParsedHedString): Issue[]

  Verify that there are no group tags at the top level of the string.

  Parameters

  • hedString: ParsedHedString

    The HED string to be checked.

  Returns Issue[]

  • Returns issue list if there are top level tags that are group tags.

checkTagGroupLevels

• checkTagGroupLevels(
      hedString: ParsedHedString,
      fullValidation: boolean,
  ): Issue[]

  Check whether tags are not in groups -- or top-level groups as required

  Parameters

  • hedString: ParsedHedString

    The HED string to be checked for reserved tag syntax.
  • fullValidation: boolean

    If true, perform full validation; otherwise, perform a quick check.

  Returns Issue[]

  An array of Issue objects if there are violations; otherwise, an empty array.

checkTopGroupRequirements

• checkTopGroupRequirements(hedString: ParsedHedString): Issue[]

  Check the group conditions of the reserved tags. The top-level has already been verified.

  Parameters

  • hedString: ParsedHedString

    The HED string to check for group conflicts.

  Returns Issue[]

  An array of Issue objects if there are violations; otherwise, an empty array.

  Notes: These include the number of groups and top tag compatibility in the group

checkUnique

• checkUnique(hedString: ParsedHedString): Issue[]

  Check for tags with the unique attribute.

  Parameters

  • hedString: ParsedHedString

    The HED string to be checked for tags with the unique attribute.

  Returns Issue[]

  An array of Issue objects if there are violations; otherwise, an empty array.

Static_getReservedTagsByProperty

• _getReservedTagsByProperty(property: any): Set<any>

  Parameters

  • property: any

  Returns Set<any>

StaticgetInstance

• getInstance(): ReservedChecker

  Returns ReservedChecker

StatichasGroupAttribute

• hasGroupAttribute(tag: ParsedHedTag): boolean

  Return a boolean indicating whether a tag is required to be in a tag group.

  Parameters

  • tag: ParsedHedTag

    The HED tag to be checked.

  Returns boolean

  If true, this indicates that tag must be in a tag group.

  Note: This checks both reserved and schema tag requirements.

StatichasTopLevelTagGroupAttribute

• hasTopLevelTagGroupAttribute(tag: ParsedHedTag): boolean

  Indicate whether a tag should be a top-level tag.

  Parameters

  • tag: ParsedHedTag

    HED tag to check for top-level requirements.

  Returns boolean

  If true, the tag is required to be at the top level.

  Note: This check both the reserved requirements and the 'topLevelTagGroup' attribute in the schema.