graph LR
EPUB_Reader_Orchestrator_["EPUB Reader (Orchestrator)"]
Container_Parser["Container Parser"]
OPF_Parser["OPF Parser"]
Metadata_Parser["Metadata Parser"]
Manifest_Parser["Manifest Parser"]
Spine_Parser["Spine Parser"]
Navigation_TOC_Parser["Navigation/TOC Parser"]
File_Reader["File Reader"]
EPUB_Reader_Orchestrator_ -- "calls to locate the OPF file" --> Container_Parser
EPUB_Reader_Orchestrator_ -- "calls to process the main package file" --> OPF_Parser
Container_Parser -- "reads files using" --> File_Reader
OPF_Parser -- "reads files using" --> File_Reader
OPF_Parser -- "delegates to for metadata extraction" --> Metadata_Parser
OPF_Parser -- "delegates to for content item identification" --> Manifest_Parser
OPF_Parser -- "delegates to for reading order definition" --> Spine_Parser
OPF_Parser -- "delegates to for table of contents creation" --> Navigation_TOC_Parser
Manifest_Parser -- "accesses files via to process content items" --> File_Reader
Spine_Parser -- "accesses files via to resolve spine items" --> File_Reader
Navigation_TOC_Parser -- "accesses files via to read navigation documents" --> File_Reader
The EPUB Parser subsystem is the core engine responsible for transforming raw EPUB file data into the structured in-memory EpubBook Object Model. It orchestrates the parsing of various EPUB components, including the container, OPF (Open Packaging Format), manifest, spine, and navigation structures.
The primary interface for initiating the EPUB parsing process. It orchestrates the high-level flow, coordinating calls to other specialized parsers to build the EpubBook object from the EPUB archive.
Related Classes/Methods:
Responsible for parsing the container.xml file within the EPUB archive. Its main task is to locate the path of the crucial OPF (Open Packaging Format) file, which serves as the central metadata and content manifest for the EPUB.
Related Classes/Methods:
The central dispatcher for parsing the OPF file. This component interprets the core structure of the EPUB, defining its metadata, manifest (content items), and spine (reading order). It delegates the parsing of specific sections to dedicated sub-parsers.
Related Classes/Methods:
Extracts and processes Dublin Core metadata elements (e.g., title, author, language, publisher) from the OPF file. It populates the EpubBook object's metadata attributes, providing essential descriptive information about the EPUB.
Related Classes/Methods:
Identifies and creates EpubItem objects for all content files (HTML, CSS, images, fonts) listed in the OPF manifest section. These items represent the individual assets and resources that constitute the EPUB's content.
Related Classes/Methods:
Interprets the spine section of the OPF, which defines the linear reading order of the EPUB's main content documents. This component determines the sequence in which content should be presented to the reader, crucial for sequential reading experiences.
Related Classes/Methods:
Handles the parsing of navigation structures within the EPUB. This includes parsing the NCX (Navigation Control file for XML) for EPUB2 files and the nav.xhtml document for EPUB3, both of which are used to construct the EPUB's table of contents and other navigational aids.
Related Classes/Methods:
Provides a low-level utility to read raw byte content from specific files within the EPUB archive (which is essentially a ZIP file). It abstracts the underlying file access, serving as a foundational service for all higher-level parsers.
Related Classes/Methods: