How allenrichi/adobe-pdf-library-samples works
Below are detailed guidelines tailored to this project:
Project Type and Purpose
• The purpose of the project is to demonstrate how to use the Adobe PDF Library through sample code.
• It is not a full production system but rather a “sample suite” for Datalogics prospects and customers.
• The repository is structured into three major language directories: CPlusPlus, DotNET, and Java. Each one contains further modules demonstrating specific PDF functionalities.
File Structure
• Notice the top-level directories: “CPlusPlus”, “DotNET”, and “Java”. These represent three different client interfaces to the Adobe PDF Library.
• Within each language directory, there are subdirectories such as “Annotations”, “ContentCreation”, “ContentExtraction”, “ContentModification”, “Display”, “DocumentConversion”, “DocumentOptimization”, “Security”, “Text”, “Images”, etc. These clearly represent functional modules.
• The “Sample_Input” directory contains various PDF and image files used as test data for the samples.
• Each module typically includes project files (e.g., Visual Studio solutions and projects for C++ and .NET, and source folders structured in packages for Java).
Core Components and Their Relationships
• Main Components:
• The language-specific sample applications:
• C++ Samples: Organized by functional modules (Annotations, ContentCreation, etc.) that demonstrate interactions with the Adobe PDF Library.
• .NET Samples: Same functional organization, typically with Windows Forms and other .NET project types.
• Java Samples: Organized in package structures (e.g., “com/datalogics/PDFL/Samples”) for each functionality like annotations, document conversion, and so on.
• The Adobe PDF Library itself is the underlying “service” that these samples demonstrate. Although it is not part of the repository’s code, it is the API that these samples consume.
• Auxiliary Components: The Sample_Input data repository which provides the PDF/documents and images for testing sample functionalities.
• Interactions:
• Each sample application (regardless of language) calls the corresponding API functions in the Adobe PDF Library.
• Within each language stack, the functional modules are self-contained but may share common helper code (for example, the “_Common” folder in C++ and any shared libraries in Java or .NET).
Architectural Patterns and Design Principles
• Reusability: Common code (e.g., _Common in C++) is used across the sample modules; show this as a shared component that supports different modules.
• Demo/Integration Layer: The sample input data is the common resource for testing; include it to indicate input flow to each module.