This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.RecordMap.Model.Field


class EnsLib.RecordMap.Model.Field extends EnsLib.RecordMap.Model.RecordProperty

Server side class to model the Field object used in the RecordMap model. Both fixed width and delimited fields are described by this model.

Property Inventory

Method Inventory


property datatype as %String (XMLPROJECTION = "ATTRIBUTE");
The datatype to be used for the data. If not specified, a %String type will be used.
Property methods: datatypeDisplayToLogical(), datatypeGet(), datatypeIsValid(), datatypeLogicalToDisplay(), datatypeLogicalToOdbc(), datatypeNormalize(), datatypeSet()
property index as %String (VALUELIST = ",,1,bitmap,idkey,unique", XMLPROJECTION = "ATTRIBUTE");
Indicate whether the generated property should be indexed. This only applies to persistent classes.
Property methods: indexDisplayToLogical(), indexGet(), indexIsValid(), indexLogicalToDisplay(), indexLogicalToOdbc(), indexNormalize(), indexSet()
property params as %String (MAXLEN = 1000, XMLPROJECTION = "ATTRIBUTE");
List of parameters for datatype. The format is a semicolon-separated list of key/value pairs as follows:
Leading and trailing whitespace will be ignored. This will be most useful for datatypes like dates or special numeric types. NOTE: MAXLEN parameters are automatically calculated for fixed width fields.
Property methods: paramsDisplayToLogical(), paramsGet(), paramsIsValid(), paramsLogicalToDisplay(), paramsLogicalToOdbc(), paramsNormalize(), paramsSet()
property repeating as EnsLib.RecordMap.Model.DataType.Boolean (XMLPROJECTION = "ATTRIBUTE");
Indicate whether the property is repeating. This only has meaning in delimited Records, and will report an error if enabled for fixed width Records.
Property methods: repeatingDisplayToLogical(), repeatingGet(), repeatingIsValid(), repeatingLogicalToDisplay(), repeatingLogicalToXSD(), repeatingNormalize(), repeatingSet(), repeatingXSDToLogical()
property sqlColumn as %Integer (MAXVAL = 4096, MINVAL = 2, XMLPROJECTION = "ATTRIBUTE");
The SQL column number of the field. This value must either not be specified, or must lie between 2 and 4096 (inclusive) as per the values for the SqlColumnNumber property keyword. The column number is of particular use when importing data from CSV files or similar data dumps, as the SQL representation can be replicated easily.
Property methods: sqlColumnDisplayToLogical(), sqlColumnGet(), sqlColumnIsValid(), sqlColumnLogicalToDisplay(), sqlColumnNormalize(), sqlColumnSet(), sqlColumnXSDToLogical()
property trailingData as %String (XMLPROJECTION = "ATTRIBUTE");
Characters which will follow the field, as can happen with some fixed width formats. Note that if there is not an exact match between the incoming data and these characters, the RecordMap parser will immediately throw an error. Only valid for fixed width RecordMaps.
Property methods: trailingDataDisplayToLogical(), trailingDataGet(), trailingDataIsValid(), trailingDataLogicalToDisplay(), trailingDataLogicalToOdbc(), trailingDataNormalize(), trailingDataSet()
property width as %Integer (XMLPROJECTION = "ATTRIBUTE");
Number of characters containing this field's data. Only valid for fixed width RecordMaps.
Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthNormalize(), widthSet(), widthXSDToLogical()


method GetFieldName() as %String
Get the field part of the name, which equates to the part of the name following the last "." character.
method GetObjectName() as %String
Get the object part of the name, which equates to all parts of the name prior to the last ".", with any "$" characters removed.
classmethod nameIsValid(%val) as %Status
Validate the value of the name property - ensure the generated property name requested by the user is valid.

Inherited Members

Inherited Properties

Inherited Methods