Skip to main content

Ens.DTL.Transform

class Ens.DTL.Transform extends Ens.DTL.Action, Ens.Util.PortalModelBase

This class represents the data transform specification. It is the root node of the parse tree derived from the XDATA DTL Specification defined in the DataTransformation class

Property Inventory

Method Inventory

Properties

property Actions as Ens.DTL.ActionList;
This holds the actions to be performed on the arguments
Property methods: ActionsGet(), ActionsGetSwizzled(), ActionsIsValid(), ActionsNewObject(), ActionsSet()
property Create as %String (MAXLEN = 20, VALUELIST = ",new,copy,existing") [ InitialExpression = "new" , Required ];
This determines how the new target object should be created.
Property methods: CreateDisplayToLogical(), CreateGet(), CreateIsValid(), CreateLogicalToDisplay(), CreateLogicalToOdbc(), CreateNormalize(), CreateSet()
property GenerateEmptySegments as %String [ InitialExpression = 0 ];
This holds the value of the GENERATEEMPTYSEGMENTS parameter so it can be edited in the UI
Property methods: GenerateEmptySegmentsDisplayToLogical(), GenerateEmptySegmentsGet(), GenerateEmptySegmentsIsValid(), GenerateEmptySegmentsLogicalToDisplay(), GenerateEmptySegmentsLogicalToOdbc(), GenerateEmptySegmentsNormalize(), GenerateEmptySegmentsSet()
property IgnoreMissingSource as %String [ InitialExpression = 1 ];
This holds the value of the IGNOREMISSINGSOURCE parameter so it can be edited in the UI
Property methods: IgnoreMissingSourceDisplayToLogical(), IgnoreMissingSourceGet(), IgnoreMissingSourceIsValid(), IgnoreMissingSourceLogicalToDisplay(), IgnoreMissingSourceLogicalToOdbc(), IgnoreMissingSourceNormalize(), IgnoreMissingSourceSet()
property Language as %String [ InitialExpression = $$$objectscript ];
This holds the language of the class
Property methods: LanguageDisplayToLogical(), LanguageGet(), LanguageIsValid(), LanguageLogicalToDisplay(), LanguageLogicalToOdbc(), LanguageNormalize(), LanguageSet()
property ReadOnly as %Integer (%JSONINCLUDE = "OUTPUTONLY", XMLPROJECTION = "NONE") [ InitialExpression = 0 , Transient ];
Flag to indicate whether the current object should be handled in ReadOnly mode. A value of 1 indicates that the class could not be locked. A value of 2 indicates that the source control framework indicated that the document is ReadOnly.
Property methods: ReadOnlyDisplayToLogical(), ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlyLogicalToDisplay(), ReadOnlyNormalize(), ReadOnlySet(), ReadOnlyXSDToLogical()
property ReportErrors as %String [ InitialExpression = 1 ];
This holds the value of the REPORTERRORS parameter so it can be edited in the UI
Property methods: ReportErrorsDisplayToLogical(), ReportErrorsGet(), ReportErrorsIsValid(), ReportErrorsLogicalToDisplay(), ReportErrorsLogicalToOdbc(), ReportErrorsNormalize(), ReportErrorsSet()
property SourceClass as %String (MAXLEN = 128) [ Required ];
This holds the type of the source object
Property methods: SourceClassDisplayToLogical(), SourceClassGet(), SourceClassIsValid(), SourceClassLogicalToDisplay(), SourceClassLogicalToOdbc(), SourceClassNormalize(), SourceClassSet()
property SourceDocType as %String (MAXLEN = 128);
This holds the optional document type of the source object
Property methods: SourceDocTypeDisplayToLogical(), SourceDocTypeGet(), SourceDocTypeIsValid(), SourceDocTypeLogicalToDisplay(), SourceDocTypeLogicalToOdbc(), SourceDocTypeNormalize(), SourceDocTypeSet()
property TargetClass as %String (MAXLEN = 128) [ Required ];
This holds the type of the target object
Property methods: TargetClassDisplayToLogical(), TargetClassGet(), TargetClassIsValid(), TargetClassLogicalToDisplay(), TargetClassLogicalToOdbc(), TargetClassNormalize(), TargetClassSet()
property TargetDocType as %String (MAXLEN = 128);
This holds the optional document type of the target object
Property methods: TargetDocTypeDisplayToLogical(), TargetDocTypeGet(), TargetDocTypeIsValid(), TargetDocTypeLogicalToDisplay(), TargetDocTypeLogicalToOdbc(), TargetDocTypeNormalize(), TargetDocTypeSet()
property Timestamp as %TimeStamp (%JSONINCLUDE = "OUTPUTONLY", XMLPROJECTION = "NONE") [ Transient ];
The most recent time that the underlying class definition was changed.
Property methods: TimestampDisplayToLogical(), TimestampGet(), TimestampIsValid(), TimestampLogicalToDisplay(), TimestampLogicalToXSD(), TimestampNormalize(), TimestampOdbcToLogical(), TimestampSet(), TimestampXSDToLogical()
property TreatEmptyAsNull as %Boolean [ InitialExpression = 0 ];
This holds the value of the TREATEMPTYREPEATINGFIELDASNULL parameter so it can be edited in the UI
Property methods: TreatEmptyAsNullDisplayToLogical(), TreatEmptyAsNullGet(), TreatEmptyAsNullIsValid(), TreatEmptyAsNullLogicalToDisplay(), TreatEmptyAsNullNormalize(), TreatEmptyAsNullSet()
property pyFromImport as %VarString;
Property methods: pyFromImportDisplayToLogical(), pyFromImportGet(), pyFromImportIsValid(), pyFromImportLogicalToDisplay(), pyFromImportLogicalToOdbc(), pyFromImportNormalize(), pyFromImportSet()

Methods

method %OnNew() as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method Deserialize(pState As %String) as %Status
Fill in properties of this item from the serial string
method DisabledSet(pVal As %Boolean) as %Status
Disabled can not be set for a transform.
method DisplayName() as %String
Provide a user readable string which names the activity
method ExpandedSet(pVal As %Boolean) as %Status
method GenerateCode(pCompiler As Ens.DTL.Compiler) as %Status
method GenerateXML(pStream As %BinaryStream) as %Status
Expanded can not be set for a transform.
method Serialize(pStream As %CharacterStream) as %Status
Serialize this transform for use by DTL editor
method Validate(ByRef pStatus As %Status, pContext As Ens.DTL.ValidationContext) as %Status
Inherited description: Perform a sanity check on the nodes in the parse tree
classmethod decoratePropString(pVarName As %String) as %String
add implicit GetAt() / GetPrevious() names explicitly to match what instantiateProps() supports.
classmethod getPropsArgs(pVarName As %String) as %String
Returns a string representing a code-generated list of arguments to GetAt() invocations in the pVarName string passed to instantiateProps().
method primaryDocType(docType As %String) as %String
Internal method to return DocType if child doc names also specified.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab