Sfairadora

  • Reference Guide

Object Naming

If a data item has to be identified, it is necessary to specify the object in which it is located and the item reference relative to the object.
Sfairadora recognizes the following standard object names:
Object Name
Description
system
The system document. It contains application settings, information about the computer and application installation, and other data available to all documents.
document
References the entire document.
master
The document to which a tool in a tool set is related is available under this name (the document name refers to the actual document of the tool set).
You can change this name in the Settings section of the tool sets document by means of the Name of master document data option.
Objects accessible in data types
root
References the entire object in which the analytic item referencing the object is located.
this
The object is available to analytic data items located in sequences and inferred sequences. The this name identifies the sequence element in which the analytic data item is located.
Suppose you have a table (i.e. a sequence of structures) with columns a, b, and c, where a and b are numbers and c is their sum. The expression determining the value in the c column is: this.a+this.b. Since the this object name need not be explicitly included in the Enki language, it is sufficient to write a+b.
This object is in particular important because it allows you to create analytic types of table columns – an instance of an analytic column type can then reference, on every row, other data items located on the same row.
parent
Similar to this, but it references the element of the sequence superior to the nearest sequence.
Analytic type supplement info can use the parent_skip item to designate a sequence higher than the nearest one as the determining sequence.
src
The object is available to analytic data items located in inferred sequences. The src name identifies an element of the source sequence of the given inferred sequence, that represents the source of the element in which the analytic data item is located.
This allows you, for example, to specify that a column in the inferred sequence should have the same value as a column in the source sequence. Suppose you wish that column a1 in the inferred sequence is equal to column a in the source sequence. The a1 column in the inferred sequence will be a forwarded item with Object name set to src and Data reference set to a.
If the inferred sequence has more than one source, you can identify the source sequence containing the source element by the src_id item in Analytic type supplement info.
parent_src
Similar to src, but it references the element of the sequence superior to the nearest sequence. This sequence must be an inferred sequence (otherwise the object is incorrectly identified).
Analytic type supplement info can use the parent_skip item to designate a sequence higher than the nearest one as the determining sequence and the parent_src_id to identify the source sequence containing the source element if the determining sequence has more than one source sequence.
Objects accessible in presentations
item_data
Data object provided by a sequence editor to dispels editing the individual elements. This object represents the edited element of every sequence child. The object can be renamed in the definition of the respective sequence editor.
row_data
Data object provided by a table to dispels constituting the contents of table cells. This object represents the respective row of the edited table. The object can be renamed in the definition of the respective table.
cell_data
Data object provided by a table to dispels constituting the contents of table cells. This object represents the data edited by the given cell (i.e. the component of the row pertaining to the column where the cell is located). The link between the column and the data item is established by the Data reference attribute in the definition of each table column. The object can be renamed in the definition of the respective table.
summary
Data object provided by a table to dispels and expression in the summary. See the Table Summary chapter for detailed description.
vars
Object containing local variables created by the data provider.
State objects
editor_state
seq_state
In addition to these standard object names, also names specified in the definition of some dispels can be used as identifiers. This feature is described separately in chapters devoted to individual dispels.