Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%DeepSee.SetBuilder.Builder

EXPERIMENTAL FEATURE This API may change!

Method Inventory

Methods

method AddExcept(ByRef pName As %String, pInput As %String, pExclude As %List) as %Status
method AddExternal(ByRef pName As %String, pSetName As %String, ByRef pParameters, pProperties As %List = "") as %Status
method AddIntersect(ByRef pName As %String, pInputs As %List) as %Status
method AddListing(pName As %String, pFieldList As %String, pOrder As %String = "") as %Status
method AddPropertyFilter(ByRef pName As %String, pInput As %String, pProperty As %String, pFilter As %String = "", pFilterValues As %String = "") as %Status
method AddPropertySelector(ByRef pName As %String, pInput As %String, pProperty As %String, ByRef pAggregate, pTarget As %String = "") as %Status
method AddSQL(ByRef pName As %String, pSQL As %String, pTarget As %String = "", ByRef pParameters) as %Status
Adds an SQL statement as an input operator. The first column will be used as idField, any other columns will be added as properties
method AddSetParameter(pName As %String, pDefaultValue As %String) as %Status
method AddSetProperty(pName As %String, pType As %String = "") as %Status
method AddUnion(ByRef pName As %String, pInputs As %List) as %Status
method AddValueList(ByRef pName As %String, ByRef pValues, pTarget As %String = "") as %Status
Adds a <valueList> operator with the supplied values. pValues can either be a %List, a comma- separated list of values or an array: pValues(n) = [value], pValues(n,[propname])=[propvalue] If no operator name is supplied, a new name will be generated. Any properties encountered in pValues will automatically be created.
method AddValuesToList(pName As %String, ByRef pValues) as %Status
Extends an existing valueList element with the supplied values
method New(pSetName As %String) as %Status
Instantiates a new set definition with name pSetName, which can be saved by calling Save() after adding a few operators.
method Open(pSetName As %String) as %Status
Opens an existing set definition so it can be modified through this Builder object.
method OperatorNameInUse(pName As %String, Output pOperator As %DeepSee.SetBuilder.Model.operator) as %Boolean
method Save(pClassName As %String = "", pVerbose As %Boolean = 1) as %Status
Saves the current set being worked on.
method SetOutputOperator(pOperatorName As %String) as %Status
Selects pOperatorName as the output operator for this set.
method Validate() as %Status

Inherited Members

Inherited Methods

FeedbackOpens in a new tab