types¶
- class SchemaEntries(schemaParser)¶
SchemaEntries class
Constructor.
- Arguments:
schemaParser (Hed3SchemaParser) – A constructed schema parser.
- SchemaEntries.SchemaEntries¶
Constructor.
- SchemaEntries.SIUnitModifiers¶
Get the schema’s SI unit modifiers.
- SchemaEntries.SIUnitSymbolModifiers¶
Get the schema’s SI unit symbol modifiers.
- SchemaEntries.allUnits¶
Get a map of all of this schema’s units.
- SchemaEntries.attributes¶
type: SchemaEntryManager
The schema’s attributes.
- SchemaEntries.definitions¶
type: Map.<string, SchemaEntryManager>
The schema’s definitions.
- SchemaEntries.properties¶
type: SchemaEntryManager
The schema’s properties.
- SchemaEntries.unitClassMap¶
Get the schema’s unit classes.
- SchemaEntries.tagHasAttribute(tag, tagAttribute)¶
Determine if a HED tag has a particular attribute in this schema.
- Arguments:
tag (string) – The HED tag to check.
tagAttribute (string) – The attribute to check for.
- Returns:
boolean – Whether this tag has this attribute.
- class SchemaEntryManager(definitions)¶
A manager of {@link SchemaEntry} objects.
Constructor.
- Arguments:
definitions (Map.<string, T>) – A map of schema entry definitions.
- SchemaEntryManager.SchemaEntryManager¶
Constructor.
- SchemaEntryManager._definitions¶
type: Map.<string, T>
The definitions managed by this entry manager.
- SchemaEntryManager.keys()¶
Iterator over the entry manager’s keys.
- Returns:
IterableIterator.<string> –
- SchemaEntryManager.values()¶
Iterator over the entry manager’s keys.
- Returns:
IterableIterator.<T> –
- class SchemaEntry()¶
SchemaEntry class
- SchemaEntry.SchemaEntry¶
- SchemaEntry._name¶
type: string
The name of this schema entry.
- SchemaEntry.name¶
The name of this schema entry.
- SchemaEntry.hasAttributeName(attributeName)¶
Whether this schema entry has this attribute (by name).
This method is a stub to be overridden in {@link SchemaEntryWithAttributes}.
- Arguments:
attributeName (string) – The attribute to check for.
- Returns:
boolean – Whether this schema entry has this attribute.
- class SchemaProperty()¶
A schema property.
- SchemaProperty.SchemaProperty¶
- SchemaProperty._propertyType¶
type: string
The type of the property.
- SchemaProperty.isCategoryProperty¶
Whether this property describes a schema category.
- SchemaProperty.isRoleProperty¶
Whether this property describes a role.
- SchemaProperty.isTypeProperty¶
Whether this property describes a data type.
- class SchemaAttribute(name, properties)¶
A schema attribute.
Constructor.
- Arguments:
name (string) – The name of the schema attribute.
properties (Array.<SchemaProperty>) – The properties assigned to this schema attribute.
- SchemaAttribute.SchemaAttribute¶
Constructor.
- SchemaAttribute._categoryProperties¶
type: Set.<SchemaProperty>
The categories of elements this schema attribute applies to.
- SchemaAttribute._roleProperties¶
type: Set.<SchemaProperty>
The set of role properties for this schema attribute.
- SchemaAttribute._typeProperty¶
type: SchemaProperty
The data type of this schema attribute.
- SchemaAttribute.categoryProperty¶
The categories of elements this schema attribute applies to.
- SchemaAttribute.roleProperties¶
The set of role properties for this schema attribute.
- SchemaAttribute.typeProperty¶
The data type property of this schema attribute.
- class SchemaEntryWithAttributes(name, booleanAttributes, valueAttributes)¶
SchemaEntryWithAttributes class
- SchemaEntryWithAttributes.booleanAttributeNames¶
type: Set.<string>
The set of boolean attribute names this schema entry has.
- SchemaEntryWithAttributes.booleanAttributes¶
type: Set.<SchemaAttribute>
The set of boolean attributes this schema entry has.
- SchemaEntryWithAttributes.valueAttributeNames¶
type: Map.<string, *>
The collection of value attribute names this schema entry has.
- SchemaEntryWithAttributes.valueAttributes¶
type: Map.<SchemaAttribute, *>
The collection of value attributes this schema entry has.
- SchemaEntryWithAttributes.getAttributeValue(attribute, alwaysReturnArray=false)¶
Retrieve the value of an attribute on this schema entry.
- Arguments:
attribute (SchemaAttribute) – The attribute whose value should be returned.
alwaysReturnArray (boolean) – Whether to return a singleton array instead of a scalar value.
- Returns:
* – The value of the attribute.
- SchemaEntryWithAttributes.getNamedAttributeValue(attributeName, alwaysReturnArray=false)¶
Retrieve the value of an attribute (by name) on this schema entry.
- Arguments:
attributeName (string) – The attribute whose value should be returned.
alwaysReturnArray (boolean) – Whether to return a singleton array instead of a scalar value.
- Returns:
* – The value of the attribute.
- SchemaEntryWithAttributes.hasAttribute(attribute)¶
Whether this schema entry has this attribute.
- Arguments:
attribute (SchemaAttribute) – The attribute to check for.
- Returns:
boolean – Whether this schema entry has this attribute.
- SchemaEntryWithAttributes.hasAttributeName(attributeName)¶
Whether this schema entry has this attribute (by name).
- Arguments:
attributeName (string) – The attribute to check for.
- Returns:
boolean – Whether this schema entry has this attribute.
- class SchemaUnit()¶
SchemaUnit class
- SchemaUnit.SchemaUnit¶
- SchemaUnit._derivativeUnits¶
type: Array.<string>
The legal derivatives of this unit.
- class SchemaUnitClass(name, booleanAttributes, valueAttributes, units)¶
SchemaUnitClass class
Constructor.
- Arguments:
name (string) – The name of this unit class.
booleanAttributes (Set.<SchemaAttribute>) – The boolean attributes for this unit class.
valueAttributes (Map.<SchemaAttribute, *>) – The value attributes for this unit class.
units (Map.<string, SchemaUnit>) – The units for this unit class.
- SchemaUnitClass.SchemaUnitClass¶
Constructor.
- SchemaUnitClass._units¶
type: Map.<string, SchemaUnit>
The units for this unit class.
- SchemaUnitClass.defaultUnit¶
Get the default unit for this unit class.
- SchemaUnitClass.units¶
Get the units for this unit class.
- class SchemaTag(name, booleanAttributes, valueAttributes, unitClasses)¶
A tag in a HED schema.
Constructor.
- Arguments:
name (string) – The name of this tag.
booleanAttributes (Set.<SchemaAttribute>) – The boolean attributes for this tag.
valueAttributes (Map.<SchemaAttribute, *>) – The value attributes for this tag.
unitClasses (Map.<string, SchemaUnit>) – The unit classes for this tag.
- SchemaTag.SchemaTag¶
Constructor.
- SchemaTag._parent¶
type: SchemaTag
This tag’s parent tag.
- SchemaTag._unitClasses¶
type: Array.<SchemaUnitClass>
This tag’s unit classes.
- SchemaTag.hasUnitClasses¶
Whether this tag has any unit classes.
- SchemaTag.parent¶
type: SchemaTag
This tag’s parent tag.
- SchemaTag.unitClasses¶
type: Array.<SchemaUnitClass>
This tag’s unit classes.