Skip to main content
Interwork Corporation
IDR Solutions Product Support Portal
PDF開発用語集 モードの切替 ダーク/ライト/自動 モードの切替 ダーク/ライト/自動 モードの切替 ダーク/ライト/自動

PDAnnotationUnknown

PDAnnotationUnknownは、Apache PDFBox PDModel APIにおける特殊なクラスで、PDFBoxライブラリが明示的に認識またはサポートしていないアノテーション型を表します。

キーワード: pdannotationunknown, PDAnnotationUnknown

概要

PDAnnotationUnknownは、Apache PDFBox PDModel APIにおける特殊なクラスで、PDFBoxライブラリが明示的に認識またはサポートしていないアノテーション型を表します。PDFBoxが定義済みのアノテーションクラスのいずれにも一致しないアノテーションサブタイプに遭遇した場合、PDAnnotationUnknownオブジェクトをインスタンス化し、解釈せずにアノテーションデータを保持します。これにより、 ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) に準拠したPDF文書は、PDFBoxが実装していないカスタムまたは新しいアノテーション型を含む場合でも、読み取りと処理が可能になります。

定義

PDAnnotationUnknownは、Apache PDFBoxのオブジェクト指向アノテーション階層におけるフォールバッククラスです。PDF仕様では多数の標準アノテーションサブタイプ(Text、Link、FreeText、Widgetアノテーションなど)が定義されていますが、カスタムアノテーションサブタイプも許可されており、将来の拡張に対する規定も含まれています。PDFBoxがPDF文書を解析し、認識できないサブタイプを持つアノテーションに遭遇した場合、エラーをスローしたりアノテーションを破棄したりするのではなく、PDAnnotationUnknownインスタンスを作成します。

このクラスは、アノテーション固有のプロパティに対する特殊なgetterおよびsetterメソッドを提供しないという点で、他のPDAnnotationサブクラスとは異なります。代わりに、PDFファイルから取得した生の辞書エントリを保持し、開発者が汎用の辞書メソッドを使用してアノテーションのプロパティにアクセスおよび変更できるようにします。このアプローチにより、後方互換性と前方互換性が確保されます。つまり、PDFBoxは、ライブラリの更新を必要とせずに、PDF仕様の新しいバージョンや独自拡張からのアノテーションを含むPDFを処理できます。

重要性

多様なPDF文書を扱う開発者にとって、PDAnnotationUnknownは文書の整合性を維持し、データ損失を防ぐ上で重要な役割を果たします。カスタムアノテーション、業界固有の特殊なマークアップ、または新しいPDFバージョンの機能を含む可能性のあるPDFを処理する際、このクラスは以下を保証します。

  1. データ損失がない: PDFBoxが特定のサブタイプを理解できない場合でもアノテーションが保持され、文書を破損することなく読み取り、変更、保存できます。

  2. 前方互換性が維持される: PDF仕様が進化する際( ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) など)、既存のPDFBoxアプリケーションは、ライブラリの即時更新なしに新しい文書を適切に処理できます。

  3. カスタムアノテーションへのアクセス: 開発者は、辞書レベルの操作を使用して未知のアノテーション型にプログラム的にアクセスおよび操作でき、回避策やカスタム処理ロジックの実装が可能になります。

  4. デバッグが簡素化される: PDAnnotationUnknownインスタンスに遭遇した場合、開発者はPDFにサポートされていないアノテーション型が含まれていることを明確に認識でき、ライブラリのアップグレードやカスタム処理の実装について、トラブルシューティングと意思決定が容易になります。

仕組み

PDAnnotationUnknownは、PDFBoxのアノテーション解析およびインスタンス化フレームワーク内で動作します。PDFBoxがPDFページのアノテーション配列を読み取る際、各アノテーションの/Subtypeエントリを調べて、どの特殊なPDAnnotationクラスをインスタンス化するかを決定します。プロセスは次のように機能します。

認識フェーズ: PDFBoxは、既知のアノテーションサブタイプ(Text、Link、Highlightなど)とそれに対応するJavaクラスの内部マッピングを保持しています。アノテーション辞書を解析する際、/Subtype値が登録されている型と一致するかどうかを確認します。

フォールバックインスタンス化: 一致するクラスが見つからない場合、PDFBoxは代わりにPDAnnotationUnknownオブジェクトをインスタンス化します。このオブジェクトは、すべてのアノテーションが共有する共通プロパティ(矩形、外観ストリーム、フラグなど)以外の内容を解釈しようとせずに、アノテーションのCOSDictionary(低レベルの辞書表現)をラップします。

プロパティアクセス: PDAnnotationUnknownインスタンスを使用する開発者は、アノテーション固有のプロパティにアクセスするために、基礎となる辞書メソッドを使用する必要があります。例えば、getSubtype()はアノテーションのサブタイプ文字列を返し、getCOSObject()は任意のエントリを読み取りまたは変更するための生の辞書へのアクセスを提供します。

操作中の保持: 未知のアノテーションを含むPDFが保存される際、PDFBoxは、辞書メソッドを通じて行われた明示的な変更を除いて、アノテーション辞書を変更せずにファイルに書き戻し、それらのアノテーション型を理解するアプリケーションのために元のデータ構造が保持されることを保証します。

関連用語

  • PDAnnotation – PDFBoxのPDModel APIにおけるすべてのアノテーション型の抽象基底クラス
  • PDPage – PDF文書内の単一ページを表し、アノテーションのコレクションを含む
  • COSDictionary – すべての高レベルPDModelクラスの基礎となる、PDF辞書オブジェクトを表す低レベルクラス
  • Annotation( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で定義されている、マークアップ、コメント、その他の拡張機能を提供するPDF文書内のインタラクティブオブジェクト
  • PDModel – Apache PDFBoxの高レベルAPIレイヤーで、PDF構造へのオブジェクト指向アクセスを提供

出典

(N.A.) (2020)
(N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html