Structuring recognized text on a document
At a glance
| Item | Summary |
|---|---|
| Purpose | Detect, recognize, and structure text on a business card or receipt using Vision and VisionKit. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → BusinessCardContentsViewController → Vision / VisionKit APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks |
| Project style | 7 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
Project structure
Source bundle/
├── BusinessCompanion/
│ ├── AppDelegate.swift
│ ├── BusinessCardContentsViewController.swift
│ ├── DataGatheringViewController.swift
│ ├── DocumentScanningViewController.swift
│ ├── ReceiptContentsViewController.swift
│ ├── OtherContentsViewController.swift
│ ├── RecognizedTextDataSource.swift
│ ├── Base.lproj/
│ │ ├── LaunchScreen.storyboard
│ │ └── Main.storyboard
│ └── Info.plist
└── BusinessCompanion.xcodeproj/
├── .xcodesamplecode.plist
└── project.pbxproj
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 6 project/configuration file(s) and 11 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["BusinessCardContentsViewController"]
N3["Vision / VisionKit APIs"]
N1 --> N2
N2 --> N3
Reference code
BusinessCompanion/AppDelegate.swift:10 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into VisionKit.
Ownership and state
classDiagram
AppDelegate o-- UIWindow : window
BusinessCardContents *-- String : name
BusinessCardContents *-- String : website
BusinessCardContents *-- String : address
Ownership evidence
BusinessCompanion/AppDelegate.swift:13 — stored dependency or nearest verified ownership anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
BusinessCardContents |
String (name) |
owns value state | App/module collaborators |
BusinessCardContents |
String (website) |
owns value state | App/module collaborators |
BusinessCardContents |
String (address) |
owns value state | App/module collaborators |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Class and protocol design
BusinessCompanion/RecognizedTextDataSource.swift:11 — representative type boundary
protocol RecognizedTextDataSource: AnyObject {
func addRecognizedText(recognizedText: [VNRecognizedTextObservation])
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
RecognizedTextDataSource |
Defines a capability or collaboration contract | AnyObject |
BusinessCardContentsViewController |
View lifecycle, callbacks, and feature coordination | UITableViewController |
DataGatheringViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
DocumentScanningViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
ReceiptContentsViewController |
View lifecycle, callbacks, and feature coordination | UITableViewController |
OtherContentsViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
BusinessCardContents |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
ScanMode |
Defines a closed set of feature states or choices | Int |
ScanMode |
Defines a closed set of feature states or choices | Int |
The source explicitly defines local protocol relationships: BusinessCardContentsViewController → RecognizedTextDataSource, OtherContentsViewController → RecognizedTextDataSource, ReceiptContentsViewController → RecognizedTextDataSource.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
AppDelegate (BusinessCompanion/AppDelegate.swift:11) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
RecognizedTextDataSource (BusinessCompanion/RecognizedTextDataSource.swift:11) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
BusinessCardContentsViewController (BusinessCompanion/BusinessCardContentsViewController.swift:11) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
Reference code
BusinessCompanion/AppDelegate.swift:11 — representative boundary
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | BusinessCardContentsViewController, DataGatheringViewController, DocumentScanningViewController, OtherContentsViewController |
The source’s Controller suffix makes this role explicit. |
| Supplies data through a callback contract | RecognizedTextDataSource |
The source’s DataSource suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | BusinessCompanion/BusinessCardContentsViewController.swift:11 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | BusinessCompanion/BusinessCardContentsViewController.swift:68 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | BusinessCompanion/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: BusinessCardContentsViewController, DataGatheringViewController, DocumentScanningViewController, OtherContentsViewController, ReceiptContentsViewController; DataSource: RecognizedTextDataSource; Delegate: AppDelegate.
- Protocols:
RecognizedTextDataSource. - Methods:
availableContents,tableView,addRecognizedText,parseTextContents,viewDidLoad,scan,processImage,documentCameraViewController. - Files:
BusinessCompanion/AppDelegate.swift,BusinessCompanion/BusinessCardContentsViewController.swift,BusinessCompanion/DataGatheringViewController.swift,BusinessCompanion/DocumentScanningViewController.swift,BusinessCompanion/ReceiptContentsViewController.swift,BusinessCompanion/OtherContentsViewController.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches UIKit, Vision, VisionKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
BusinessCompanion/AppDelegate.swift |
AppDelegate |
BusinessCompanion/BusinessCardContentsViewController.swift |
BusinessCardContentsViewController, BusinessCardContents |
BusinessCompanion/DataGatheringViewController.swift |
DataGatheringViewController, ScanMode |
BusinessCompanion/DocumentScanningViewController.swift |
DocumentScanningViewController, ScanMode |
BusinessCompanion/ReceiptContentsViewController.swift |
ReceiptContentsViewController, ReceiptContents |
BusinessCompanion/OtherContentsViewController.swift |
OtherContentsViewController |
BusinessCompanion/RecognizedTextDataSource.swift |
RecognizedTextDataSource |