Structured Document Validation With Cross-Document Error Mapping
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Existing error diagnostic features in source code editors like VS Code are impaired when interacting code is spread across multiple documents, making it difficult to diagnose errors effectively.
Innovation Solution
A system and method for validating structured electronic documents by parsing schema files to determine structures and data formats, identifying document fragments, inserting them into references, and generating diagnostic arrays that are converted to match the original documents, allowing error locations to be presented in the context of the original documents.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Measurement precision
If error diagnostic features are used in source code editors, then errors in single source code documents can be detected, but errors in interacting code spread across multiple source code documents cannot be effectively diagnosed
Solution Approach 1:
The validation system segments the validation process into distinct phases: local validation of individual documents, identification of cross-document references, and global validation that synthesizes results across multiple documents. This segmentation allows the system to maintain precision for single-document errors while adding capability for multi-document validation.
Solution Approach 2:
The validation system is designed with multi-functionality to handle both single-document validation and multi-document validation. It can validate individual source code documents independently while also tracking references across document boundaries, providing universal error diagnostic capability that adapts to different validation scenarios.
2Ease of manufacture
If code is distributed across multiple source code documents, then code organization is improved, but error diagnosis capability is impaired
Solution Approach 1:
The system introduces an intermediary validation mechanism that tracks references between documents. This intermediary layer maintains a mapping of cross-document references and propagates validation results back to the original document contexts, allowing errors to be diagnosed in their original location even when code is distributed across multiple files.
Solution Approach 2:
The validation system creates copies of reference information and validation results across document boundaries. When a document references another, the system copies the reference metadata and validation context, allowing error diagnostics to be presented in the context of the original document while validating distributed code structures.
Data Source
AI summary
Embodiments of the present disclosure include techniques for validating structured electronic documents. In one embodiment, a structured electronic document comprises a reference to a fragment in another structure electronic document. The documents are combined to replace reference with the fragment. The resulting combined document may be validated to generate a first diagnostic array corresponding to the combined document. The first diagnostic array is converted to a second diagnostic array corresponding to the original document. A validation result may specify where in the original documents an error occurred.