Class default

A parser for schema attributes.

Hierarchy (View Summary)

SchemaEntryParser
- default

Index

Constructors

Properties

entryTypeMap properties xmlCollection

Methods

_addCustomEntries _parseSchema _preprocessSchemas addEntry parse

Constructors

constructor

new default(
xmlCollection: HedSchemaXMLCollection,
properties: SchemaEntryManager<default>,
): default
Constructor.
Parameters
- xmlCollection: HedSchemaXMLCollection
  A collection of XML data for a given prefix.
- properties: SchemaEntryManager<default>
  The parsed mapping of schema properties.
Returns default
Overrides SchemaEntryParser.constructor
- Defined in src/schema/parser/attribute.js:24

Properties

entryTypeMap

entryTypeMap: Map<string, any>

The map of names to entry objects for this entry type.

properties

properties: SchemaEntryManager<default>

The schema properties.

xmlCollection

xmlCollection: HedSchemaXMLCollection

The collection of XML data for a given prefix.

Methods

`Protected`_addCustomEntries

_addCustomEntries(): void
Protected
Add any custom entries required by the platform to support old versions.

Returns void
Inherited from SchemaEntryParser._addCustomEntries
- Defined in src/schema/parser/schemaEntry.js:121

`Protected`_parseSchema

_parseSchema(schemaXml: Object): void
Protected
Parse attributes in a specific schema.

A property with a value (inLibrary) marks the library that declares the attribute and is not one of its properties. A property name the schema does not define is kept as an unregistered property of that name, so that two declarations are compared by the names as written (specification 3.1.2.4).
Parameters
- schemaXml: Object
  The XML for a specific schema.
Returns void
Overrides SchemaEntryParser._parseSchema
- Defined in src/schema/parser/attribute.js:39

`Protected`_preprocessSchemas

_preprocessSchemas(schemaXml: HedSchemaXMLCollection): void
Protected
Preprocess the schema collection.
Parameters
- schemaXml: HedSchemaXMLCollection
  The XML collection.
Returns void
Inherited from SchemaEntryParser._preprocessSchemas
- Defined in src/schema/parser/schemaEntry.js:103

addEntry

addEntry(newEntryName: string, newEntry: any): void
Add a new entry while checking for duplicates.

An existing declaration of the same name is kept if the new one is equivalent to it.
Parameters
- newEntryName: string
  The entry name.
- newEntry: any
  The new entry object to add.
Returns void

Throws
If an entry of that name exists and is not equivalent.
Inherited from SchemaEntryParser.addEntry
- Defined in src/schema/parser/schemaEntry.js:86

parse

parse(): default<any>
Parse this entry type across all schemas in the collection.

Returns default<any>
An entry manager for this entry type.

Throws
If two schemas declare an element incompatibly.
Inherited from SchemaEntryParser.parse
- Defined in src/schema/parser/schemaEntry.js:68