Property

From ObjectVision

(Difference between revisions)
Jump to: navigation, search
Line 44: Line 44:
*'''''StorageOptions:'''''
*'''''StorageOptions:'''''
*'''StorageReadOnly''': to configure if a [[Data source|storage]] is only configured to read from (not to write to). The default value for this property is ''False''. If configured to ''True'', data is only read from the [[Data source|storage]] and not written to.
*'''StorageReadOnly''': to configure if a [[Data source|storage]] is only configured to read from (not to write to). The default value for this property is ''False''. If configured to ''True'', data is only read from the [[Data source|storage]] and not written to.
-
 
+
*'''[[Storagetype]]''': This property indicates the [[StorageManager]] used to read and write the data, e.g. [[TIFF]], [[DBF]], [[SHP]]. The StorageType property only has be configured if it cannot be derived from the file extension.
=== Label ===
=== Label ===

Revision as of 10:02, 26 March 2020

A property is a relevant characteristic of a tree item that can be defined in the configuration.

To configure a property, use a colon character (:) after the definition of an item and configure the property with the syntax PropertyKeyWord = "PropertyValue". The comma (,) is used as delimiter between multiple property definitions.

Contents

List

  • CalcSchema:
  • CaseDir: a derived property, not meant to be configured. It presents the name of the configuration folder.
  • Cdf: to configure a classification for a values unit or data item.
  • ConfigFileColNr: a derived property, not meant to be configured. It presents the vertical column position of the configured item in the configuration file.
  • ConfigFileLineNr: a derived property, not meant to be configured. It presents the horizontal line position of the configured item in the configuration file.
  • ConfigFileName: a derived property, not meant to be configured. It presents the name of the configuration file, including the path from the configuration directory of the project.
  • ConfigStore:
  • Descr: to configure a description to a tree item that is shown in the GeoDMS GUI detail pages and as tool tip. It is advised to keep a description short, more descriptive information can better be stored in an (HTML) file and configured as metadata with the url property.
  • DialogData: to configure, often in combination with the DialogType property how to present data items in different views.
  • DialogType: together with the DialogData property, this property defines how data items are presented in different views..
  • DisableStorage: to configure whether or not a data item needs to be stored in an external storage. The default value for this property is: False. If a storage is configured to an item (or any parent item), the property definition: DisableStorage ="True" indicates the current item will not be stored in an external storage.
  • DomainUnit: The domain unit of an attribute indicates the entity for which the attribute is available. It's not configured as a normal property but between normal brackets after the data item, see domain unit.
  • DomainUnit_FullName: a derived property, not meant to be configured, indicating the FullName (the name of the item self and all it's parent items) of the domain unit of the item.
  • ExplicitSupplier: to configure a supplier relation towards another data item, that needs to be updated first, before the current data item is updated. Such dependencies are often necessary if external components are executed. In that case the dependencies are not implicit (caused by references in expressions) but need to be configured with the ExplicitSupplier property.
  • Expr: to configure an expression for a tree item. Since GeoDMS version 7.104 it is advised to use the syntax := for configuring expressions
  • FreeData: to configure if (intermediate) results, maintained in the CalcCache, will be stored persistent or released after their interest count goes down to zero. The default value for this property is: True. For more information see the CalcCache Guide.
  • FullName: a derived property, not meant to be configured. It is derived from the name of the tree item and it's hierarchical structure (all parent container item names). The property is not meant to be configured.
  • FullSource : a derived property, not meant to be configured. It presents the information used for the Source Description in the Source Detail Page.
  • HasCalculator: a derived property, not meant to be configured. The property indicates if the data item has an expression configured or the data item is the result of an expression configured to it's parent item.
  • InHidden: a derived property from the configured isHidden = "True" property for the tree item self or to any parent of the item, not meant to be configured. The inHidden property indicates if a tree item is visible (False) or not visible (True) in the user mode. The default value for this property is False.
  • IntegrityCheck: to configure checks on the integrity of data results.
  • InTemplate: a derived property, not meant to be configured, from a parent property for which the IsTemplate property is configured. With the InTemplate property is indicated if the item is part of a template that can not be calculated.
  • IsEndogenous: a derived property, not meant to be configured, indicating a data item is calculated and not read from a source file.
  • IsHidden: to configure if tree items in the user mode are hidden, to present only the relevant items. In the administrator mode, also hidden items are visible. The default value for the this property is False.
  • IsLoadable: a derived property, not meant to be configured, indicating if exogenous data items can be read from external source files, a StorageManager is configured for the data item and the property DisableStorage is not configured to be True.
  • IsStorable: a derived property, not meant to be configured, indicating if endogenous data items can be stored, a StorageManager is configured for the data item and the property DisableStorage is not configured to be True.
  • IsTemplate: This property was configured to a container item representing a template. The property informs the GeoDMS that all tree items for which the property is configured and all it's direct and indirect subitem represent a template that can be used for a case/template instantiation. In recent versions the IsTemplate property is derived from the configuration of the keyword Template, so it does not have to be configured explicitly anymore.
  • KeepData: to configure if data items are kept in memory after being calculated once. This is advised for results of time consuming calculations, that are requested in the GeoDMS GUI multiple times. The default value is False, If set to True the results of a calculation are kept in memory. We advice to limit the number of data items with this property configured to True as it will result in a higher memory load.
  • Label: to configure how an item is named in the GeoDMS GUI (except for the Treeview in which the tree item name is used). In the legend of the Map view and the header of the Table view the label is used (if configured, else the name is used). In a label property all characters are allowed, but it is advised to keep the size of the label limited.
  • LastChange : a derived property, not meant to be configured, indicating a time stamp for the last data change. The property is used by the GeoDMS to determine if results are still valid or need to be recalculated.
  • Name: This property is configured by naming a tree item, see also naming conventions.
  • NrSubitems: a derived property, not meant to be configured, indicating the number of direct subitems of a tree item. The property is not meant to be configured.
  • ParamData: This property was used for defining case parameter, but as case instantiation can now only be configured within the GeoDMS syntax, this property has become obsolete.
  • ParamType: See ParamData
  • Source: to configure descriptive information for the source data used in a GeoDMS configuration. The configured information is presented in the Source Description Detail Page for each data item in which this source data item is used (based on the supplier relations). This way a nice overview of all data used for your model results is presented.
  • SqlString: to configured a data source with an SQL statement (query or view). We advice to only configure simple: SELECT .. FROM .. WHERE .. ORDER BY statements, joins and aggregations are usually much faster in the GeoDMS. The ORDER BY part is essential, as the GeoDMS works with semantic arrays in which the sequence of entries matter.
  • StorageName: primary data used in the GeoDMS is usually stored in external storages. With the StorageName property a reference towards a primary data source is configured (in most cases a filename).
  • StorageOptions:
  • StorageReadOnly: to configure if a storage is only configured to read from (not to write to). The default value for this property is False. If configured to True, data is only read from the storage and not written to.
  • Storagetype: This property indicates the StorageManager used to read and write the data, e.g. TIFF, DBF, SHP. The StorageType property only has be configured if it cannot be derived from the file extension.

Label

The label property is used to configure a more extensive name of an item, in which all characters including spaces are allowed. This label is used in the GeoDMS GUI to present the item in the table header or the legend of the map view.

Example:

attribute<meter> elev_5km (Geography/EuroGrid) : label = "mean elevation per 5km^2";


Url

The url property is used to configure extensive descriptive information, stored in a (preferably HTML format) file. The contents of the file is shown in the metadata detail page if the tree item is activated and this detail page is visible. Example:

container Network: url = "%projDir%/data/metadata/Network.htm"

Range/nrofrows

The range property is used to set the allowed range of values of a unit. For integer units, it implicitly also defines the number of allowed elements. The nrofrows property can be used to explicitly define the number of elements for a domain unit. For data sources read from external sources the number of elements is derived from the source. If explicitly configured, the number of elements should correspond to what is read from the source, otherwise an error message is generated.

Examples:

unit<float32> nrHaPerGridCell: range = [0,256>; 
unit<uint8>    province:              nrofrows = 12; 

Ranges are configured as half open intervals. The [ bracket before the the first value of the range (0) indicates this value is the first value of the allowed data elements. The > bracket after the second value, indicates this value (256) is the first value that does not belong to the the collection of allowed data elements. The highest allowed value in this range is 255,999999...

See PropertyList for a list of all possible properties.

Personal tools