Search

Module: Editor

Version: 2.2.1 +

User: Developer

Object Type: Data Object

Parent of:

no children

Child of:

 

Description

A DatabaseField is always defined within a DatabaseView. It is used to represent one of the fields that is retrieved by the query or stored procedure of that DatabaseView. The behavior of the DatabaseField (for example the timeout) is determined by the settings of the DatabaseView.

Properties

DebugLogMode (from version 4.1)

Indicates the level of detail of debug information that is logged when running a Futurama application (website, webservice, console application) to the trace, a logfile, a database etc. The possible values are:

  • None: no debug information is logged
  • Simple: only basic information is given
  • Extended: in addition to the information in the Simple mode the values of all the properties of the object are shown

IsPublic

Possible values are 'True' or 'False'. If the value is 'False', then the object can only be used within the document where it is created. If the value is 'True', then also from other Futurama documents can be referred to this object. This means that changes in the object also affect the document in which is referred to this object. If the value is 'True' and you attempt to move or delete the object, a warning will be given. To limit these warnings to a minimum it is recommended to set IsPublic to 'True' only when necessary.

ReturnsTable (until version 5.0)

This is an automatic property. It is 'True' if the property SingeRow of the DatabaseView that contains the DatabaseField is set to 'False'. ReturnsTable is 'False' if the property SingeRow of the DatabaseView that contains the DatabaseField is set to 'True'. From version 5.1.0 the ReturnsTable property is replaced by the Rank property (see property below).

Rank (from version 5.1)

The Rank property is an automatic property indicating the rank of the Calculation Object. Rank=0 implies a scalar. Rank=1 a vector and Rank=2 a matrix. For the DatabaseField only the values Rank=0 and Rank=1 are applicable. If the property 'SingleRow' of the DatabaseView is 'True', the Rank=0, otherwise Rank=1.  

XmlName

The name of the object as it is shown in the source of the website. By default the XmlName is equal to the name given in the property (Name) with spaces replaced by underscores, but you are free to change it.

(Name)

The name of the object.

Comment

Here a comment can be entered. For example a short description of the object.

DataType

The value of this property determines the type of the data that is defined in the field defined in the property FieldName. The following types are available:

  • Long (an integer)
  • Double (a broken number)
  • Date
  • String
  • Boolean (a logical value which can be True or False)

FieldName

This property contains the name of the field whose data has to be represented.

ID

The unique identification number of the object. This number is automatically generated by Futurama on the moment of creation. This number can be used when searching for a certain object in the Find Window.

Type

The value of this property determines the Futurama type to which the data in Fieldname is to be converted. The following types are available:

  • Long (an integer)
  • Double (a broken number)
  • Date
  • String
  • Boolean (a logical value which can be True or False)

Conversion

Typically Type and DataType will be the same, but sometimes it might be necessary to have data be converted. For instance, data of type Long be converted to type Double or data of type Date to a String. In that case Type will differ from DataType. The conversion of the data from DataType to Type will be done automatically.

Note that if the combination of Type and DataType is illogical, the conversion might produce unexpected results. For instance if data of type Date is transformed to Booleans.

Related Topics

- DatabaseView

Updated: 2012-08-31