Class SchemaEntryParser<T>`Abstract`

A parser for a specific SchemaEntry subtype, run over every schema of a merge group.

Template: T

Type Parameters

T

Hierarchy (View Summary)

SchemaEntryParser

Index

Constructors

Properties

entryTypeMap xmlCollection

Methods

_addCustomEntries _parseSchema _preprocessSchemas addEntry parse

Constructors

constructor

new SchemaEntryParser<T>(
xmlCollection: HedSchemaXMLCollection,
): SchemaEntryParser<T>
Constructor.
Type Parameters
- T
Parameters
- xmlCollection: HedSchemaXMLCollection
  A collection of XML data for a given prefix.
Returns SchemaEntryParser<T>
- Defined in src/schema/parser/schemaEntry.js:57

Properties

entryTypeMap

entryTypeMap: Map<string, T>

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

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
- Defined in src/schema/parser/schemaEntry.js:121

`Protected` `Abstract`_parseSchema

_parseSchema(schemaXml: Object): void
Protected
Parse this entry type for a specific schema.
Parameters
- schemaXml: Object
  The XML for a specific schema.
Returns void
- Defined in src/schema/parser/schemaEntry.js:113

`Protected`_preprocessSchemas

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

addEntry

addEntry(newEntryName: string, newEntry: T): 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: T
  The new entry object to add.
Returns void

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

parse

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

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

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