UGH (English)
Documentation
  • Documentation UGH Library
  • 1. Introduction
  • 2. Document model
    • 2.1. Structural data
    • 2.2. Content files
    • 2.3. Metadata
    • 2.4. Metadata groups
    • 2.5. Anchor
  • 3. Rule set
    • 3.1. Definition of metadata types
    • 3.2. Definition of metadata groups
    • 3.3. Definition of structure types
  • 4. Serialization
    • 4.1. MARC
      • 4.1.1. Introduction
      • 4.1.2. Configuration
      • 4.1.3. Example configurations
    • 4.2. METS/MODS
      • 4.2.1. Introduction
      • 4.2.2. General configuration
      • 4.2.3. Configuration of the mapping of structure and metadata
      • 4.2.4. Extended METS export options
      • 4.2.5. UghConvert
    • 4.3. PICA+
      • 4.3.1. Introduction
      • 4.3.2. Configuration
    • 4.4. XStream
    • 4.5. RDF/XML
      • 4.5.1. Introduction
      • 4.5.2. Configuration
    • 4.6. AGORA-Database
      • 4.6.1. Introduction
      • 4.6.2. Database configuration
      • 4.6.3. Definition of the Persistent Identifier in the database
      • 4.6.4. Inheritable metadata types
      • 4.6.5. Value lists
      • 4.6.6. Metadata Type Mapping
      • 4.6.7. Structure Type Mapping
  • 5. Outlook
  • 6. Additional details
Powered by GitBook
On this page

Was this helpful?

3. Rule set

The document model described above is quite general, it does not specify any metadata or structure types. To be able to create instances of structural units and metadata at all, it is necessary to define corresponding types in a rule set. The rule set also contains corresponding sections for the serialization information of the respective serialization classes.

Technically, the rule set is loaded by the application during the first API call and only the part that defines the meta and structure types is interpreted. Only when corresponding classes for serializing the data are called is the corresponding section for configuring the serialization interpreted (since this is only implemented in the corresponding serialization classes). This means that if the configuration is incorrect, errors can also occur during runtime. These are thrown as exceptions by the UGH library and must be caught by the application.

The rule set itself is implemented as an XML file. The root node in each ruleset is the element. Within this <Preferences> element are all definitions of the metadata and structure types. It is important to note that metadata types must be defined before groupings and structure types.

Previous2.5. AnchorNext3.1. Definition of metadata types

Last updated 5 years ago

Was this helpful?