Class SchemaValueClass

SchemaValueClass class

Hierarchy (View Summary)

SchemaEntryWithAttributes
- SchemaValueClass

Index

Constructors

Properties

_name booleanAttributeNames booleanAttributes valueAttributeNames valueAttributes

Accessors

Methods

_memoize getAttributeValue hasAttribute hasBooleanAttribute validateValue

Constructors

constructor

new SchemaValueClass(
    name: string,
    booleanAttributes: Set<SchemaAttribute>,
    valueAttributes: Map<SchemaAttribute, any>,
    charClassRegex: RegExp,
    wordRegex: RegExp,
): SchemaValueClass
Constructor.
Parameters
- name: string
  The name of this value class.
- booleanAttributes: Set<SchemaAttribute>
  The boolean attributes for this value class.
- valueAttributes: Map<SchemaAttribute, any>
  The value attributes for this value class.
- charClassRegex: RegExp
  The character class-based regular expression for this value class.
- wordRegex: RegExp
  The "word form"-based regular expression for this value class.
Returns SchemaValueClass
Overrides SchemaEntryWithAttributes.constructor
- Defined in src/schema/entries.js:646

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

name

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

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

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

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

validateValue

validateValue(value: string): boolean
Determine if a value is valid according to this value class.
Parameters
- value: string
  A HED value.
Returns boolean
Whether the value conforms to this value class.
- Defined in src/schema/entries.js:658