Class SchemaTag

A tag in a HED schema.

Hierarchy (View Summary)

SchemaEntryWithAttributes
- SchemaTag
  - SchemaValueTag

Index

Constructors

Properties

_name booleanAttributeNames booleanAttributes valueAttributeNames valueAttributes

Accessors

ancestors hasUnitClasses longName name parent unitClasses valueClasses valueTag

Methods

_memoize extend getAttributeValue hasAttribute hasBooleanAttribute longExtend

Constructors

constructor

new SchemaTag(
    name: string,
    booleanAttributes: Set<SchemaAttribute>,
    valueAttributes: Map<SchemaAttribute, any>,
    unitClasses: SchemaUnitClass[],
    valueClasses: SchemaValueClass[],
): SchemaTag
Constructor.
Parameters
- name: string
  The name of this tag.
- booleanAttributes: Set<SchemaAttribute>
  The boolean attributes for this tag.
- valueAttributes: Map<SchemaAttribute, any>
  The value attributes for this tag.
- unitClasses: SchemaUnitClass[]
  The unit classes for this tag.
- valueClasses: SchemaValueClass[]
  The value classes for this tag.
Returns SchemaTag
Overrides SchemaEntryWithAttributes.constructor
- Defined in src/schema/entries.js:704

Properties

_name

_name: string

The name of this schema entry.

booleanAttributeNames

booleanAttributeNames: Set<string>

The set of boolean attribute names this schema entry has.

booleanAttributes

booleanAttributes: Set<SchemaAttribute>

The set of boolean attributes this schema entry has.

valueAttributeNames

valueAttributeNames: Map<string, any>

The collection of value attribute names this schema entry has.

valueAttributes

valueAttributes: Map<SchemaAttribute, any>

The collection of value attributes this schema entry has.

Accessors

ancestors

get ancestors(): any[]
Return all of this tag's ancestors.

Returns any[]
- Defined in src/schema/entries.js:792

hasUnitClasses

get hasUnitClasses(): boolean
Whether this tag has any unit classes.

Returns boolean
- Defined in src/schema/entries.js:722

longName

get longName(): string
This tag's long name.

Returns string
- Defined in src/schema/entries.js:805

name

get name(): string
The name of this schema entry.

Returns string
Inherited from SchemaEntryWithAttributes.name
- Defined in src/schema/entries.js:199

parent

get parent(): SchemaTag
This tag's parent tag.

Returns SchemaTag
- Defined in src/schema/entries.js:756
set parent(newParent: SchemaTag): void
Set the tag's parent tag.
Parameters
- newParent: SchemaTag
  The new parent tag.
Returns void
- Defined in src/schema/entries.js:764

unitClasses

get unitClasses(): SchemaUnitClass[]
This tag's unit classes.

Returns SchemaUnitClass[]
- Defined in src/schema/entries.js:714

valueClasses

get valueClasses(): SchemaValueClass[]
This tag's value classes.

Returns SchemaValueClass[]
- Defined in src/schema/entries.js:730

valueTag

get valueTag(): SchemaValueTag
This tag's value-taking child tag.

Returns SchemaValueTag
- Defined in src/schema/entries.js:738
set valueTag(newValueTag: SchemaValueTag): void
Set the tag's value-taking child tag.
Parameters
- newValueTag: SchemaValueTag
  The new value-taking child tag.
Returns void
- Defined in src/schema/entries.js:746

Methods

`Protected`_memoize

_memoize<T>(propertyName: string, valueComputer: () => T): T
Protected
Memoize a property.
Type Parameters
- T
Parameters
- propertyName: string
  The property name.
- valueComputer: () => T
  A function to compute the property's value.
Returns T
The computed value.
Inherited from SchemaEntryWithAttributes._memoize
- Defined in src/utils/memoizer.js:33

extend

extend(extension: string): string
Extend this tag's short name.
Parameters
- extension: string
  The extension.
Returns string
The extended short string.
- Defined in src/schema/entries.js:817

getAttributeValue

getAttributeValue(attributeName: string, alwaysReturnArray?: boolean): any
Retrieve the value of a value attribute (by name) on this schema entry.
Parameters
- attributeName: string
  The attribute whose value should be returned.
- alwaysReturnArray: boolean = false
  Whether to return a singleton array instead of a scalar value.
Returns any
The value of the attribute.
Inherited from SchemaEntryWithAttributes.getAttributeValue
- Defined in src/schema/entries.js:415

hasAttribute

hasAttribute(attributeName: string): boolean
Whether this schema entry has this attribute (by name).
Parameters
- attributeName: string
  The attribute to check for.
Returns boolean
Whether this schema entry has this attribute.
Inherited from SchemaEntryWithAttributes.hasAttribute
- Defined in src/schema/entries.js:396

hasBooleanAttribute

hasBooleanAttribute(attributeName: string): boolean
Whether this schema entry has this boolean attribute (by name).
Parameters
- attributeName: string
  The attribute to check for.
Returns boolean
Whether this schema entry has this attribute.
Inherited from SchemaEntryWithAttributes.hasBooleanAttribute
- Defined in src/schema/entries.js:405

longExtend

longExtend(extension: string): string
Extend this tag's long name.
Parameters
- extension: string
  The extension.
Returns string
The extended long string.
- Defined in src/schema/entries.js:831