Template:— representing_hardcopy_file (rep_hard_file)
Capability:representing_documents
Date: 2009/03/18 11:50:09
Revision: 1.6
Template: representing_hardcopy_file

XML references to the Template

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

representing_hardcopy_file

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="" name="representing_hardcopy_file" capability="representing_documents">
  <param name="hardcopy_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="hardcopy_id_class_name">
    <param_value>File_identification_code</param_value>
    <description></description>
  </param>
  <param name="hardcopy_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="hardcopy_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="hardcopy_org_id_class_name">
    <param_value>Organization_name</param_value>
    <description></description>
  </param>
  <param name="hardcopy_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="hardcopy_vn_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="hardcopy_vn_id_class_name">
    <param_value>Version_identification_code</param_value>
    <description></description>
  </param>
  <param name="hardcopy_vn_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="hardcopy_vn_org_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="hardcopy_vn_org_id_class_name">
    <param_value>Organization_name</param_value>
    <description></description>
  </param>
  <param name="hardcopy_vn_org_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="cont_data_type_class_name">
    <param_value>Unknown_data_type</param_value>
    <description></description>
  </param>
  <param name="cont_data_type_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="representing_hardcopy_file">
  <param_in name="hardcopy_id" value=""/>
  <param_in name="hardcopy_id_class_name" value="File_identification_code"/>
  <param_in name="hardcopy_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="hardcopy_org_id" value=""/>
  <param_in name="hardcopy_org_id_class_name" value="Organization_name"/>
  <param_in name="hardcopy_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="hardcopy_vn_id" value=""/>
  <param_in name="hardcopy_vn_id_class_name" value="Version_identification_code"/>
  <param_in name="hardcopy_vn_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="hardcopy_vn_org_id" value=""/>
  <param_in name="hardcopy_vn_org_id_class_name" value="Organization_name"/>
  <param_in name="hardcopy_vn_org_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="cont_data_type_class_name" value="Unknown_data_type"/>
  <param_in name="cont_data_type_ecl_id" value="urn:plcs:rdl:std"/>
</template_example>

representing_hardcopy_file
/representing_hardcopy_file(hardcopy_id='', hardcopy_id_class_name='File_identification_code', hardcopy_id_ecl_id='urn:plcs:rdl:std', hardcopy_org_id='', hardcopy_org_id_class_name='Organization_name', hardcopy_org_id_ecl_id='urn:plcs:rdl:std', hardcopy_vn_id='', hardcopy_vn_id_class_name='Version_identification_code', hardcopy_vn_id_ecl_id='urn:plcs:rdl:std', hardcopy_vn_org_id='', hardcopy_vn_org_id_class_name='Organization_name', hardcopy_vn_org_id_ecl_id='urn:plcs:rdl:std', cont_data_type_class_name='Unknown_data_type', cont_data_type_ecl_id='urn:plcs:rdl:std')/

Path

Hardcopy

-- Mark the file entity as
-- referable when this template is used by binding it to the reference
-- parameter id_assgn
%^hardcopy = Hardcopy%
Hardcopy.id = '/IGNORE'
Hardcopy.version = '/IGNORE'
Hardcopy.contained_data_type = '/IGNORE'

-- Identify the Document
/assigning_identification(
    items=^hardcopy,
    id=@hardcopy_id,
    id_class_name=@hardcopy_id_class_name,
    id_ecl_id=@hardcopy_id_ecl_id,
    org_id=@hardcopy_org_id,
    org_id_class_name=@hardcopy_org_id_class_name,
    org_id_ecl_id=@hardcopy_org_id_ecl_id )/

-- Note that digital files do not have a digital_file_version - only single atttribute on the file itself. However, we'll use the same mechanism as previously to identify it.
-- Identify the Document_version
/assigning_identification(
    items=^hardcopy,
    id=@hardcopy_vn_id,
    id_class_name=@hardcopy_vn_id_class_name,
    id_ecl_id=@hardcopy_vn_id_ecl_id,
    org_id=@hardcopy_vn_org_id,
    org_id_class_name=@hardcopy_vn_org_id_class_name,
    org_id_ecl_id=@hardcopy_vn_org_id_ecl_id )/

-- provide the contained data type of the file by classification
/assigning_reference_data(
    items=^hardcopy,
    class_name=@cont_data_type_class_name,
    ecl_id=@cont_data_type_ecl_id)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Hardcopy.id '/IGNORE' File.id
Hardcopy.version '/IGNORE' File.version
Hardcopy.contained_data_type '/IGNORE' File.contained_data_type

XML representation of path

<refpath
   template="representing_hardcopy_file">
   <instantiate
      entity="Hardcopy"
      context="">
      
   </instantiate>
   <comment>
      Mark the file entity as
   </comment>
   <comment>
      referable when this template is used by binding it to the reference
   </comment>
   <comment>
      parameter id_assgn
   </comment>
   <bind
      parameter="hardcopy">
      <express_entity
         entity="Hardcopy"
         context="">
         
      </express_entity>
   </bind>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Hardcopy"
            attribute="id"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Hardcopy"
            attribute="version"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Hardcopy"
            attribute="contained_data_type"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <comment>
      Identify the Document
   </comment>
   <call_template
      name="assigning_identification"
      business_context="">
      <param_in
         name="items"
         value="^hardcopy">
         
      </param_in>
      <param_in
         name="id"
         value="@hardcopy_id">
         
      </param_in>
      <param_in
         name="id_class_name"
         value="@hardcopy_id_class_name">
         
      </param_in>
      <param_in
         name="id_ecl_id"
         value="@hardcopy_id_ecl_id">
         
      </param_in>
      <param_in
         name="org_id"
         value="@hardcopy_org_id">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="@hardcopy_org_id_class_name">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="@hardcopy_org_id_ecl_id ">
         
      </param_in>
   </call_template>
   <comment>
      Note that digital files do not have a digital_file_version - only single atttribute on the file itself. However, we'll use the same mechanism as previously to identify it.
   </comment>
   <comment>
      Identify the Document_version
   </comment>
   <call_template
      name="assigning_identification"
      business_context="">
      <param_in
         name="items"
         value="^hardcopy">
         
      </param_in>
      <param_in
         name="id"
         value="@hardcopy_vn_id">
         
      </param_in>
      <param_in
         name="id_class_name"
         value="@hardcopy_vn_id_class_name">
         
      </param_in>
      <param_in
         name="id_ecl_id"
         value="@hardcopy_vn_id_ecl_id">
         
      </param_in>
      <param_in
         name="org_id"
         value="@hardcopy_vn_org_id">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="@hardcopy_vn_org_id_class_name">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="@hardcopy_vn_org_id_ecl_id ">
         
      </param_in>
   </call_template>
   <comment>
      provide the contained data type of the file by classification
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="">
      <param_in
         name="items"
         value="^hardcopy">
         
      </param_in>
      <param_in
         name="class_name"
         value="@cont_data_type_class_name">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="@cont_data_type_ecl_id">
         
      </param_in>
   </call_template>
</refpath>

© OASIS 2010 — All rights reserved