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

COSOutputStream

COSOutputStreamは、Apache PDFBoxに含まれる低レベルのJavaクラスで、で定義されているPDFファイル構造の基礎を形成するCOS(Carousel Object Structure)オブジェクトの書き込み操作を提供します。

キーワード: cosoutputstream, COSOutputStream

概要

COSOutputStreamは、Apache PDFBoxに含まれる低レベルのJavaクラスで、 ( 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ファイル構造の基礎を形成するCOS(Carousel Object Structure)オブジェクトの書き込み操作を提供します。このアウトプットストリームは、ディクショナリ、配列、ストリーム、その他の基本的な構成要素を含むプリミティブなPDFオブジェクトのシリアライゼーションを処理します。生のPDFオブジェクト操作やカスタムPDF生成ワークフローを扱う開発者にとって、重要なコンポーネントとなります。

定義

COSOutputStreamは、Apache PDFBoxのCOS層の一部であり、 ( 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 ) のオブジェクト構造仕様を直接実装しています。COS(Carousel Object Structure)という名称は、Adobe社がPDF開発時に使用した内部コードネームに由来します。このクラスは、JavaのOutputStream標準クラスを拡張し、PDF固有のデータ型と構造を適切なエンコーディングとフォーマットで書き込むための特殊なメソッドを提供します。

PDFの複雑さを抽象化する高レベルのPDFBoxクラスとは異なり、COSOutputStreamは最も基本的なレベルで動作し、PDF構文要件に準拠した生のバイトを書き込みます。開発者に使いやすいAPIを提供するPDDocumentPDPageクラスとは異なり、PDFオブジェクトがディスクやメモリストリームにシリアライズされる方法を正確に制御することに重点を置いています。開発者は通常、カスタムPDF機能の実装、PDF構造の問題のデバッグ、または特定の要件に対するPDF生成の最適化を行う際に、このクラスを使用します。

重要性

Apache PDFBoxを使用する開発者にとって、高レベルAPIが十分な制御を提供しない場合や、標準的なPDFBox操作でサポートされていないカスタムPDF機能を実装する場合に、COSOutputStreamの理解は不可欠です。これは特に以下のような場合に重要となります:

  • ( Citation: N.A., (N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html ) 規格に準拠したアクセシブルなPDFなど、特殊な文書のためのカスタムPDF構造の作成
  • 直接的なストリーム書き込みを必要とするパフォーマンス最適化の実装
  • 生のオブジェクトシリアライゼーションを調査することによるPDF生成問題のデバッグ
  • オブジェクトレベルで文書構造を操作するカスタムPDFプロセッサの構築
  • オブジェクトエンコーディングの正確な制御を必要とするPDF検証または修復ツールの開発

このクラスは、PDFBoxにおけるすべてのPDF書き込み操作の基盤を提供するため、開発者が高レベルの抽象化を使用する場合でも重要なコンポーネントです。その役割を理解することで、開発者は問題の診断、パフォーマンスの最適化、および標準的なユースケースを超えたPDFBox機能の拡張が可能になります。

仕組み

COSOutputStreamは、 ( 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仕様規則に従って、COSオブジェクトをバイトストリーム表現に変換することによって動作します。ワークフローには、いくつかの重要な操作が含まれます:

オブジェクトシリアライゼーション:ストリームはCOSオブジェクト(COSDictionaryCOSArray、COSName、COSStringなど)を受け取り、それらをテキストまたはバイナリのPDF表現に変換します。例えば、COSDictionaryは<<>>の区切り文字で囲まれた一連のキーと値のペアになります。

エンコーディング管理:このクラスは、特定のオブジェクトタイプに対するASCIIエンコーディング、バイナリ文字列に対する16進数エンコーディング、PDF文字列内の特殊文字に対する適切なエスケープシーケンスなど、さまざまなエンコーディング要件を処理します。

ストリームフィルタリング:PDFストリームオブジェクトを書き込む際、COSOutputStreamはフィルタ実装と連携して、ストリームディクショナリで指定されている圧縮(FlateDecodeなど)またはエンコーディング(ASCII85Encodeなど)を適用します。

相互参照サポート:ストリームは書き込まれたオブジェクトのバイトオフセットを追跡し、PDFリーダーがファイル内のオブジェクトを効率的に見つけることができる相互参照テーブルとストリームの生成を可能にします。

空白とフォーマット:適切な空白の挿入と改行を管理し、デバッグ目的で適度な可読性を維持しながら、出力がPDF構文規則に準拠することを保証します。

開発者は通常、COSOutputStreamを直接インスタンス化することはありませんが、PDFBoxの文書保存メカニズムを通じて、または特殊なPDF生成タスクのためのカスタムCOSWriterサブクラスを実装する際に遭遇します。

関連用語

  • COS(Carousel Object Structure) – PDF仕様で定義されているPDFファイルの内部構造を表す低レベルのオブジェクトモデル
  • COSDictionary – キーと値のペアを表すCOSオブジェクトタイプで、PDF構造の基本であり、Tagged PDF ( Citation: , (). Retrieved from https://pdfa.org/resource/tagged-pdf-best-practice-guide-syntax/ ) で広く使用される
  • COSStream – メタデータとフィルタリングのための関連ディクショナリを持つ、バイナリまたはテキストデータを含むCOSオブジェクト
  • PDDocument – 完全なPDF文書を表すApache PDFBoxの高レベルクラス
  • 相互参照テーブル – 効率的なランダムアクセスのためにオブジェクト番号とバイトオフセットをマッピングする、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
PDF Association (2023)
(). Retrieved from https://pdfa.org/resource/tagged-pdf-best-practice-guide-syntax/
(N.A.) (2014)
(N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html