Set-Metadata
説明
グループ、グループ内の各要素、および要素内の属性のメタデータの値を登録します。このメタデータはより高いレイヤーのアプリケーションによって読み取ることができ、グループ、要素、または属性データの処理に影響を与えます。
|
|
Set-Metadata Webject は新しい出力グループを生成しません。代わりに、GROUP_IN パラメータによって指定したグループを修正します。
|
構文
<ie:webject name="Set-Metadata" type="GRP">
<ie:param name="ATTRIBUTE" data="name_of_attribute"/>
<ie:param name="ELEMENT" data="index_of_element"/>
<ie:param name="GROUP_IN" data="input_group_name"/>
<ie:param name="NAME" data="name_of_meta_attribute"/>
<ie:param name="SCOPE" data="[GROUP | ELEMENT | ATTRIBUTE]"/>
<ie:param name="VALUE" data="value_of_meta_attribute"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
GROUP_IN
|
SCOPE
|
VALUE
|
|
NAME
|
ELEMENT
|
|
|
ATTRIBUTE
|
|
ATTRIBUTE
メタデータが設定されている属性を識別します。
SCOPE が ATTRIBUTE である場合は、メタデータを設定する属性を識別するために、ELEMENT および ATTRIBUTE パラメータの両方を指定する必要があります。
ELEMENT
メタデータを設定する要素を識別します。パラメータの値は、グループ内の要素のインデックスを指定する簡単な整数か、または name=value として指定される場合があります。ここで name は属性の名前、value は対応する属性の値です。前と値のペアが指定されると、Webject は指定された名前と値を持つ属性を含んでいる最初の要素を配置し、その要素にメタデータを設定します。
ELEMENT の値はアスタリスク (*) としても指定できます。この場合は、グループのすべての要素が選択されます。
SCOPE パラメータが ELEMENT である場合は、ELEMENT パラメータを指定する必要があります。SCOPE パラメータが ATTRIBUTE である場合は、メタデータを設定する属性を識別するために、ELEMENT および ATTRIBUTE パラメータの両方を指定する必要があります。
GROUP_IN
メタデータを登録するグループの名前を指定します。このパラメータは必須です。
NAME
設定するメタデータ属性の名前を指定します。Webject への 1 回の呼び出しで複数のメタデータ属性を設定するために、複数の NAME および VALUE パラメータの組み合わせを指定できます。このパラメータは必須です。
VALUE
NAME パラメータで指定された対応するメタデータに関連付けられたメタデータの値を指定します。Webject への 1 回の呼び出しで複数のメタデータ属性を設定するために、複数の NAME および VALUE パラメータのペアを指定できます。
このパラメータのデフォルトは NULL 文字です。このパラメータはオプションです。
SCOPE
メタデータの適応範囲を指定します。このパラメータの有効な値は以下のとおりです。
◦ GROUP - グループ全体にメタデータを設定します。
◦ ELEMENT - グループ内の特定の要素のメタデータを設定します。SCOPE が ELEMENT として指定されている場合は、ELEMENT パラメータも指定する必要があります。
◦ ATTRIBUTE - グループ内の要素の特定の属性にメタデータを設定します。SCOPE が ATTRIBUTE として指定されている場合は、ELEMENT および ATTRIBUTE パラメータの両者とも指定する必要があります。
このパラメータのデフォルト値は GROUP です。
例
以下の JSP ページの例は、グループレベルで "createdgroup" という名前のグループに名前 meta_data および値 met_value を持つメタデータを登録します。
<%@page language="java" session="false"
errorPage="XML_IEError.jsp" contentType="text/xml"%>
<%@ taglib uri="http://www.ptc.com/infoengine/taglib/core" prefix="ie"%>
<ie:task uri="com/company/CreateGroup.xml"/>
<ie:webject name="Set-Metadata" type="GRP">
<ie:param name="GROUP_IN" data="createdgroup"/>
<ie:param name="SCOPE" data="GROUP"/>
<ie:param name="NAME" data="meta_name"/>
<ie:param name="VALUE" data="met_value"/>
</ie:webject>
<ie:webject name="Display-XML" type="DSP">
<ie:param name="MODE" data="FULL"/>
</ie:webject>
以下の SetMetadataLevels.jsp ファイルは、3 つのすべての SCOPE 値にメタデータを設定し、Display-XML を使用して XML 出力を表示します。
<%@page language="java" session="false" errorPage="../IEError.jsp"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core" prefix="ie"%>
<ie:webject name="Create-Group" type="GRP">
<ie:param name="ELEMENT" data="NAME=Sam Johnson:
ADDRESS=1234 Main St.:EMAIL=sjohnson@somewhere.com"/>
<ie:param name="ELEMENT" data="NAME=Harvy Anderson:
ADDRESS=1234 Amber St.:EMAIL=handerson@somewhere.com"/>
<ie:param name="ELEMENT" data="NAME=<>'&":
EMAIL=joconnor@somewhere.com"/>
<ie:param name="GROUP_OUT" data="CREATE-RESULTS"/>
</ie:webject>
<ie:webject name="SeT-Metadata" type="GRP">
<ie:param name="GROUP_IN" data="CREATE-RESULTS"/>
<ie:param name="NAME" data="testattribute"/>
<ie:param name="VALUE" data="attribute metadata"/>
<ie:param name="SCOPE" data="ATTRIBUTE"/>
<ie:param name="ELEMENT" data="*"/>
<ie:param name="ATTRibute" data="name"/>
</ie:webject>
<ie:webject name="Set-Metadata" type="GRP">
<ie:param name="GROUP_IN" data="CREATE-RESULTS"/>
<ie:param name="NAME" data="testelement"/>
<ie:param name="VALUE" data="element metadata"/>
<ie:param name="SCOPE" data="ELEMENT"/>
<ie:param name="ELEMENT" data="0"/>
</ie:webject>
<ie:webject name="Set-Metadata" type="GRP">
<ie:param name="GROUP_IN" data="CREATE-RESULTS"/>
<ie:param name="NAME" data="testgroup"/>
<ie:param name="VALUE" data="group metadata"/>
<ie:param name="SCOPE" data="GROUP"/>
</ie:webject>
<ie:webject name="Display-Xml" type="DSP">
<ie:param name="Mode" data="FULL"/>
</ie:webject>
この例を実行することにより生成される XML 出力は以下のとおりです。
