Home > Class Reference > ENSLIB namespace > Ens.DTL.Transform

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

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 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 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 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()

Methods

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

Inherited Methods

%AddToSaveSet() %DispatchSetMultidimProperty() %OriginalNamespace()
%ClassIsLatestVersion() %DispatchSetProperty() %PackageName()
%ClassName() %Extends() %RemoveFromSaveSet()
%ConstructClone() %GetParameter() %SerializeObject()
%DispatchClassMethod() %IsA() %SetModified()
%DispatchGetModified() %IsModified() %ValidateObject()
%DispatchGetProperty() %New() NormalizeAttribute()
%DispatchMethod() %NormalizeObject() WriteAnnotationXML()
%DispatchSetModified() %ObjectModified() WriteExpandedAttribute()