Template:— file_location (file_locn)
Context:— UK_Defence

Date: 2009/04/17 11:50:09
Revision: 1.2

Cover Contents Description Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template file_location.

NOTE The template has been defined in the context of UK_Defence. Refer to the business context for details of related templates.

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes how to represent a file location.

Model diagrams

The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "file_location". The text highlighted in blue shows the template parameters.

Figure 1 — An EXPRESS-G representation of the Information model for file_location

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 2 below.

Figure 2 — The graphical representation of the file_location template

Input parameters

The following input parameters are defined for this template:

file_path (Type='STRING')

The location of the file.

type (Type='CLASS')

The type of file location eg. URL or FTP.

The following classes and their sub-classes can be used:

classifications: [File_location_identification_type]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

source_organization (Type='STRING')

The source organization of the file location.

file_name (Type='STRING')

The name of the file.

item (Type= 'SELECT (external_identification_item)' )

The item to which the location refers.

Reference parameters

The following reference parameters are defined for this template:

ext_class(Type='ENTITY (External_class)')

Allow the External_class entity instantiated in this path to be referenced when this template is used.

Note: The External_class entity can be referenced in a template path by:

%^target = $file_location.ext_class%

where target is the parameter to which the External_class is bound.

Instantiation path

The instantiation path shown below specifies the entities that are to be instantiated by the template.

A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.

File_location_identification
%^file_loc_id = File_location_identification%
File_location_identification.source_id = '/IGNORE'
File_location_identification.source_type = '/IGNORE'
File_location_identification.description = '/NULL'
File_location_identification.external_id = '/IGNORE'
File_location_identification.item -> @item

-- file path
/identifier(
    ID=@file_path,
    source_organization=@source_organization,
    type=@type,
    items=^file_loc_id)/

-- file name
/identifier(
    ID=@file_name,
    source_organization=@source_organization,
    type=@type,
    items=^file_loc_id)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
File_location_identification.source_id	'/IGNORE'	External_source_identification.source_id
File_location_identification.source_type	'/IGNORE'	External_source_identification.source_type
File_location_identification.description	'/NULL'	External_source_identification.description
File_location_identification.external_id	'/IGNORE'	External_item_identification.external_id

Instance diagrams

The instance diagram in Figure 3 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/file_location(file_path='', type='', source_organization='', file_name='', item='')/

(an illustration of the consolidated file_location template is shown in Figure 4 below.)

Figure 3 — Entities instantiated by file_location template

The instance diagram in Figure 4 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/file_location(file_path='', type='', source_organization='', file_name='', item='')/

Figure 4 — Instantiation of file_location template

Characterizations

No common characterizations of the template file_location have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.