Template:— assigning_partial_document (asg_partial_doc) Date: 2008/03/05 14:41:06
Revision: 1.7
Template: assigning_partial_document

XML references to the Template

These can be cut and pasted into the XML as required.

assigning_partial_document

Set up a hyperlink to the template definition.
<template_ref name="assigning_partial_document" capability="representing_documents"/>

Set up a table of the template parameters.
<template_table figure_id="?" instance="" name="assigning_partial_document" capability="representing_documents">
  <param name="doc">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="doc_asg_role">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="doc_asg_role_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="doc_portion">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="is_assigned_to">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="assigning_partial_document">
  <param_in name="doc" value=""/>
  <param_in name="doc_asg_role" value=""/>
  <param_in name="doc_asg_role_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="doc_portion" value=""/>
  <param_in name="is_assigned_to" value=""/>
</template_example>

assigning_partial_document
/assigning_partial_document(doc='', doc_asg_role='', doc_asg_role_ecl_id='urn:plcs:rdl:std', doc_portion='', is_assigned_to='')/

Path

-- Create the partial document assignment entity.
Partial_document_assignment
Partial_document_assignment.role = '/IGNORE'
Partial_document_assignment.document_portion = '/IGNORE'
Partial_document_assignment.is_assigned_to -> @is_assigned_to

-- Mark the Partial_document_assignment entity as referable when this template is used.
-- In other words, bind the Partial_document_assignment instance to the reference
-- parameter partial_doc_asg
%^partial_doc_asg = Partial_document_assignment%

-- Assign the role through ref data
/assigning_reference_data(
    items=^partial_doc_asg,
    class_name=@doc_asg_role,
    ecl_id=@doc_asg_role_ecl_id)/

-- Assign the text identifying the portion of the document being assigned
/assigning_descriptor(
    descr=@doc_portion,
    class_name='Description',
    ecl_id='urn:plcs:rdl:std',
    is_assigned_to=^partial_doc_asg)/

-- Assign the partial document to be used
Partial_document_assignment.assigned_document -> @doc
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Partial_document_assignment.role '/IGNORE' Document_assignment.role
Partial_document_assignment.document_portion '/IGNORE'

XML representation of path

<refpath
   template="assigning_partial_document">
   <comment>
      Create the partial document assignment entity.
   </comment>
   <instantiate
      entity="Partial_document_assignment"
      context="">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Partial_document_assignment"
            attribute="role"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value="'/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Partial_document_assignment"
            attribute="document_portion"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value="'/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Partial_document_assignment"
            attribute="is_assigned_to"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="is_assigned_to">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      Mark the Partial_document_assignment entity as referable when this template is used.
   </comment>
   <comment>
      In other words, bind the Partial_document_assignment instance to the reference
   </comment>
   <comment>
      parameter partial_doc_asg
   </comment>
   <bind
      parameter="partial_doc_asg">
      <express_entity
         entity="Partial_document_assignment"
         context="">
         
      </express_entity>
   </bind>
   <comment>
      Assign the role through ref data
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="">
      <param_in
         name="items"
         value="^partial_doc_asg">
         
      </param_in>
      <param_in
         name="class_name"
         value="@doc_asg_role">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="@doc_asg_role_ecl_id">
         
      </param_in>
   </call_template>
   <comment>
      Assign the text identifying the portion of the document being assigned
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="">
      <param_in
         name="descr"
         value="@doc_portion">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Description'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^partial_doc_asg">
         
      </param_in>
   </call_template>
   <comment>
      Assign the partial document to be used
   </comment>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Partial_document_assignment"
            attribute="assigned_document"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="doc">
            
         </param_in_ref>
      </source>
   </assign>
</refpath>

© OASIS 2010 — All rights reserved