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

PDUserProperty

PDUserPropertyは、Apache PDFBox PDModel APIのクラスで、PDF文書内のコンテンツに関連付けられたユーザープロパティを表します。

キーワード: pduserproperty, PDUserProperty

概要

PDUserPropertyは、Apache PDFBox PDModel APIのクラスで、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 ) で定義されているように、文書のアクセシビリティとセマンティック情報を向上させます。このクラスを使用することで、開発者はTagged PDF構造を扱う際に、これらのプロパティをプログラムで読み取り、操作できます。

定義

PDUserPropertyは、Apache PDFBoxのPDModelパッケージに含まれる高レベルなJavaクラスで、PDF文書内にあるユーザープロパティ辞書構造をカプセル化します。ユーザープロパティは、Tagged PDFの構造要素に添付できるキーと値のペアで、標準的なPDFタグを超えた追加のセマンティック情報や記述情報を提供します。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 ) とは異なり、ユーザープロパティを使用することで、文書作成者はPDF仕様への準拠を損なうことなく、文書のセマンティクスを強化するカスタムメタデータフィールドを定義できます。

PDUserPropertyクラスは、PDFユーザープロパティ辞書で定義されているプロパティ名、値、値の型、その他の属性にアクセスするためのメソッドを提供します。これは一般的なメタデータや文書プロパティとは異なり、ユーザープロパティは文書の論理構造ツリー内の個別の構造要素に特定的に関連付けられているため、アクセシビリティやコンテンツ抽出のシナリオにおいて特に価値があります。

重要性

アクセシブルなPDFや構造化コンテンツを扱う開発者にとって、PDUserPropertyは基本的な文書構造を超えたセマンティック情報を保持および抽出するための重要な機能を提供します。 ( 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 ) 標準に準拠した文書を作成または処理する際、ユーザープロパティは、略語の展開形、言語インジケータ、支援技術が利用できるカスタムロール記述など、重要なアクセシビリティ情報を保持できます。

ユーザープロパティは、他の形式(HTMLやXMLなど)からPDFへ文書を変換する際に、カスタムセマンティック情報を保持する必要がある場合に特に重要です。PDUserPropertyを活用することで、開発者は文書ワークフロー全体を通じて豊富なメタデータを維持でき、PDF生成や操作の過程で重要な文脈情報が失われないことを保証できます。この機能は、包括的なアクセシビリティ機能を維持する必要がある組織や、高度な文書処理パイプラインを実装する組織にとって不可欠です。

仕組み

Apache PDFBoxでPDUserPropertyを使用する際、開発者は通常、Tagged PDF内の構造要素を通じてユーザープロパティにアクセスします。このクラスは、ユーザープロパティ辞書の中核コンポーネントに対するゲッターとセッターメソッドを提供しており、プロパティ名(N)、値(V)、フォーマット済み値(F)、およびプロパティが非表示かどうか(H)などが含まれます。

典型的なワークフローでは、PDFBoxの構造要素クラスを使用して文書の構造ツリーをナビゲートし、特定の構造要素からユーザープロパティ配列を取得します。配列内の各ユーザープロパティはPDUserPropertyオブジェクトとして表現され、その属性を照会できます。新しいユーザープロパティを作成する場合、開発者はPDUserPropertyオブジェクトをインスタンス化し、その値と属性を設定し、適切な構造要素に添付します。

ユーザープロパティに格納される値は、さまざまな型(テキスト文字列、数値など)が可能で、フォーマット済み値はオプションの人間が読める表現を提供します。非表示フラグを使用することで、特定のプロパティを内部用または非表示として マークできます。これは、エンドユーザーに提示すべきでない処理ヒントや技術的メタデータを保存する際に便利です。この柔軟性により、ユーザープロパティは、より広範な ( Citation: , (). Retrieved from https://pdfa.org/resource/tagged-pdf-best-practice-guide-syntax/ ) エコシステムとの互換性を維持しながら、カスタムセマンティクスを埋め込むための強力なツールとなります。

関連用語

  • PDStructureElement – ユーザープロパティを含むことができるTagged PDF内の構造要素を表すクラス
  • Tagged PDF – アクセシビリティとコンテンツ再利用のための論理構造情報を含むPDF文書
  • PDModel – PDF文書オブジェクトを扱うためのApache PDFBoxの高レベルAPIパッケージ
  • Structure Attributes(構造属性) – 構造要素に添付される標準的なPDF属性で、プレゼンテーションとセマンティックプロパティを定義する
  • PDF Accessibility(PDFアクセシビリティ) – 障害を持つ人々が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