Interface XDocumentMetadataAccess

Devguide

索引

Methods' 要約

せいにするs' 要約

Methods' 詳細（に述べる）s

せいにするs' 詳細（に述べる）s

:: com :: sun :: 星／主役にする :: rdf ::

unpublished

interface XDocumentMetadataAccess

Base Interfaces

XDocumentMetadataAccess
┣ XURI
┃ ┗ XResource
┃    ┗ XNode
┗ XRepositorySupplier

XURI	(言及／関連d interface's 要約:) 代表するs an URI node that may occur in a RDF graph.
XRepositorySupplier	(言及／関連d interface's 要約:) 供給するs 接近 to an RDF Repository.

Usage 制限s

not published

Description

文書 metadata functionality 関係のある to the "manifest.rdf".

This interface 含む／封じ込めるs some methods that create 関係s between the content and the RDF metadata of an ODF 文書. The main idea is to make querying and manipulating the data in the metadata manifest easier.

公式文書，認める that this interface 相続するs from XURI: the base URI of the 文書 is the string value of the RDF node. This is so that you can easily make RDF 声明s about the 文書.

Since

OOo 3.2

See also

XDocumentRepository

Methods' 要約
getElementByMetadataReference	get the unique ODF element with the given metadata 言及／関連.
getElementByURI	get the ODF element that corresponds to an URI.
getMetadataGraphsWithType	get the 指名するs of all metadata とじ込み／提出するs with a given type.
addMetadataFile	追加する a metadata とじ込み／提出する to the manifest.
importMetadataFile	輸入する a metadata とじ込み／提出する into the 文書 repository, and 追加する it to the manifest.
removeMetadataFile	除去する a metadata とじ込み／提出する from the manifest and the repository.
addContentOrStylesFile	追加する a content or styles とじ込み／提出する to the manifest.
removeContentOrStylesFile	除去する a content or styles とじ込み／提出する from the manifest.
loadMetadataFromStorage	initialize 文書 metadata from a 貯蔵.
storeMetadataToStorage	蓄える／店文書 metadata to a 貯蔵.
loadMetadataFromMedium	負担s 文書 metadata from a medium.
storeMetadataToMedium	蓄える／店s 文書 metadata to a medium.

Methods' 詳細（に述べる）s

getElementByMetadataReference

XMetadatable
getElementByMetadataReference(	[in] ::com::sun::星／主役にする::beans::StringPair	MetadataReference );

Description: get the unique ODF element with the given metadata 言及／関連.
Parameter MetadataReference: a metadata 言及／関連, 構成するing the stream 指名する and the XML ID For example: Pair("content.xml", "foo-element-1")
Returns: the ODF element with the given metadata 言及／関連s if it 存在するs, else NULL

getElementByURI

XMetadatable
getElementByURI(	[in] XURI	URI )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException );

Description: get the ODF element that corresponds to an URI.
Parameter URI: an URI that may identify an ODF element
Returns: the ODF element that corresponds to the given URI, or NULL
Throws: com::sun::星／主役にする::lang::IllegalArgumentException if the given URI is NULL

getMetadataGraphsWithType

sequence< XURI >
getMetadataGraphsWithType(	[in] XURI	Type )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException );

Description: get the 指名するs of all metadata とじ込み／提出するs with a given type.
Parameter Type: the rdf:type 所有物／資産／財産 of the requested 指名するd graphs
Returns: the 指名するs of all metadata graphs that have a rdf:type 所有物／資産／財産 with the given Type as 反対する
Throws: com::sun::星／主役にする::lang::IllegalArgumentException if the given Type is NULL

addMetadataFile

XURI
addMetadataFile(	[in] string	FileName,
	[in] sequence< XURI >	Types )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::ElementExistException );

Description

追加する a metadata とじ込み／提出する to the manifest.

This convenience method does the に引き続いて:

create a new graph with the given 指名する in the repository
挿入する声明s 宣言するing the new graph to be a metadata とじ込み／提出する into the manifest graph
挿入する声明s 宣言するing rdf:type 所有物／資産／財産s for the new graph into the manifest graph

Parameter FileName

the 指名する of the stream in the ODF 貯蔵 where the graph will be 蓄える／店d

Parameter Types

a 名簿（に載せる）／表（にあげる） of types that will be 挿入するd as rdf:type 所有物／資産／財産s for the graph

Returns

the 指名する of the new graph

Throws

com::sun::星／主役にする::lang::IllegalArgumentException if the FileName is 無効の

Throws

com::sun::星／主役にする::コンテナ::ElementExistException if a stream with the given FileName already 存在するs

importMetadataFile

XURI
importMetadataFile(	[in] short	判型,
	[in] ::com::sun::星／主役にする::io::XInputStream	InStream,
	[in] string	FileName,
	[in] XURI	BaseURI,
	[in] sequence< XURI >	Types )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::datatransfer::UnsupportedFlavorException, ::com::sun::星／主役にする::コンテナ::ElementExistException, ParseException, ::com::sun::星／主役にする::io::IOException );

Description

輸入する a metadata とじ込み／提出する into the 文書 repository, and 追加する it to the manifest.

This convenience method does the に引き続いて:

輸入する the given とじ込み／提出する into a graph with the given 指名する in the repository

挿入する声明s 宣言するing the new graph to be a metadata とじ込み／提出する into the manifest graph

挿入する声明s 宣言するing rdf:type 所有物／資産／財産s for the new graph into the manifest graph

Parameter FileName

the 指名する of the stream in the ODF 貯蔵 where the graph will be 蓄える／店d

Parameter BaseURI

a base URI to 解決する親族 URI 言及／関連s

Parameter Types

a 名簿（に載せる）／表（にあげる） of types that will be 挿入するd as rdf:type 所有物／資産／財産s for the graph

Returns

the 指名する of the new graph

Throws

com::sun::星／主役にする::lang::IllegalArgumentException if the given stream is NULL, or BaseURI is NULL and the 判型要求するs use of a base URI, or the FileName is 無効の

Throws

com::sun::星／主役にする::datatransfer::UnsupportedFlavorException if the 判型 requested is unknown or not supported

Throws

com::sun::星／主役にする::コンテナ::ElementExistException if a stream with the given FileName already 存在するs

Throws

ParseException if the input does not 適合する to the 明示するd とじ込み／提出する判型.

Throws

com::sun::星／主役にする::io::IOException if an I/O error occurs.

See also

FileFormat

removeMetadataFile

無効の
removeMetadataFile(	[in] XURI	GraphName )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::NoSuchElementException );

Description

除去する a metadata とじ込み／提出する from the manifest and the repository.

This convenience method does the に引き続いて:

削除する the graph with the given GraphName in the repository

除去する the 声明s 宣言するing the graph to be a metadata とじ込み／提出する from the manifest graph

Parameter GraphName

the 指名する of the graph that is to be 除去するd

Throws

com::sun::星／主役にする::lang::IllegalArgumentException if the given GraphName is NULL

Throws

com::sun::星／主役にする::コンテナ::NoSuchElementException if a graph with the given GraphName does not 存在する

addContentOrStylesFile

無効の
addContentOrStylesFile(	[in] string	FileName )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::ElementExistException );

Description

追加する a content or styles とじ込み／提出する to the manifest.

This convenience method 追加するs the 要求するd 声明s 宣言するing a content or styles とじ込み／提出する to the manifest graph.

If the FileName ends in "content.xml", an odf:ContentFile is 追加するd.
If the FileName ends in "styles.xml" , an odf:StylesFile is 追加するd.
Other FileNames are 無効の.

Parameter FileName

the 指名する of the stream in the ODF 貯蔵

Throws

com::sun::星／主役にする::lang::IllegalArgumentException if the FileName is 無効の

Throws

com::sun::星／主役にする::コンテナ::ElementExistException if a stream with the given FileName already 存在するs

removeContentOrStylesFile

無効の
removeContentOrStylesFile(	[in] string	FileName )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::NoSuchElementException );

Description: 除去する a content or styles とじ込み／提出する from the manifest.; This convenience method 除去するs the 声明s 宣言するing a content or styles とじ込み／提出する from the manifest graph.
Parameter FileName: the 指名する of the stream in the ODF 貯蔵
Throws: com::sun::星／主役にする::lang::IllegalArgumentException if the FileName is 無効の
Throws: com::sun::星／主役にする::コンテナ::NoSuchElementException if a graph with the given GraphName does not 存在する

loadMetadataFromStorage

無効の
loadMetadataFromStorage(	[in] ::com::sun::星／主役にする::embed::XStorage	貯蔵,
	[in] XURI	BaseURI,
	[in] ::com::sun::星／主役にする::仕事::XInteractionHandler	InteractionHandler )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::lang::WrappedTargetException );

Description

initialize 文書 metadata from a 貯蔵.

This method re-initializes the 文書 metadata, 負担s the stream 指名するd "manifest.rdf" from the 貯蔵, and then 負担s all metadata streams について言及するd in the manifest.

公式文書，認める that it is not an error if the 貯蔵 does not 含む／封じ込める a manifest. In this 事例／患者, the 文書 metadata will be default initialized.

If an InteractionHandler argument is given, it will be used for error 報告（する）／憶測ing. さもなければ, errors will be 報告（する）／憶測d as exceptions.

Parameter 貯蔵

a 貯蔵, 代表するing e.g. an ODF 一括とじ込み／提出する, or sub-文書

Parameter BaseURI

a base URI to 解決する親族 URI 言及／関連s

N.B.: when 負担ing from an ODF 一括, the base URI is not the URI of the 一括, but the URI of the directory in the 一括 that 含む／封じ込めるs the metadata.rdf

Parameter InteractionHandler

an InteractionHandler, used for error 報告（する）／憶測ing

Throws

com::sun::星／主役にする::lang::IllegalArgumentException if any argument is NULL

Throws

com::sun::星／主役にする::lang::WrappedTargetException if an error occurs while 負担ing and no InteractionHandler given

storeMetadataToStorage

無効の
storeMetadataToStorage(	[in] ::com::sun::星／主役にする::embed::XStorage	貯蔵 )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::lang::WrappedTargetException );

Description

蓄える／店文書 metadata to a 貯蔵.

This method 蓄える／店s all the graphs in the 文書 metadata repository to the given 貯蔵.

公式文書，認める that to be 蓄える／店d 正確に, a 指名するd graph must have a 完全にする入ること／参加（者） in the manifest graph.

Parameter 貯蔵

a 貯蔵, 代表するing e.g. an ODF 一括とじ込み／提出する, or sub-文書

Throws

com::sun::星／主役にする::lang::IllegalArgumentException if 貯蔵 argument is NULL

Throws

com::sun::星／主役にする::lang::WrappedTargetException if an error occurs while 負担ing

loadMetadataFromMedium

無効の
loadMetadataFromMedium(	[in] sequence< ::com::sun::星／主役にする::beans::PropertyValue >	Medium )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::lang::WrappedTargetException );

Description: 負担s 文書 metadata from a medium.; If the Medium 含む／封じ込めるs an InteractionHandler, it will be used for error 報告（する）／憶測ing.
Parameter Medium: the com::sun::星／主役にする::文書::MediaDescriptor 代表するing the source
Throws: com::sun::星／主役にする::lang::IllegalArgumentException if the argument does not 含む／封じ込める a URL or Stream 所有物／資産／財産
Throws: com::sun::星／主役にする::lang::WrappedTargetException if an error occurs while 負担ing
See also: ::com::sun::星／主役にする::文書::MediaDescriptor

storeMetadataToMedium

無効の
storeMetadataToMedium(	[in] sequence< ::com::sun::星／主役にする::beans::PropertyValue >	Medium )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::lang::WrappedTargetException );

Description: 蓄える／店s 文書 metadata to a medium.
Parameter Medium: the com::sun::星／主役にする::文書::MediaDescriptor 代表するing the 的
Throws: com::sun::星／主役にする::lang::IllegalArgumentException if the argument does not 含む／封じ込める a URL or Stream 所有物／資産／財産
Throws: com::sun::星／主役にする::lang::WrappedTargetException if an error occurs while 蓄える／店ing
See also: ::com::sun::星／主役にする::文書::MediaDescriptor

最高の，を越す of Page

Copyright © 2013, The Apache ソフトウェア創立／基礎, Licensed under the Apache License, 見解／翻訳／版 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache ソフトウェア創立／基礎. Other 指名するs may be trademarks of their 各々の owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous