%DeepSee.SetBuilder.Model.operator

hidden abstract class %DeepSee.SetBuilder.Model.operator extends %DeepSee.SetBuilder.Model.node

Property Inventory

name
properties
set
target

Method Inventory

%CloseCursor()
%ContainsID()
%Get()
%GetActualTarget()
%GetAsArray()
%GetAsBitstrings()
%GetAsList()
%GetData()
%GetIKnowDomainId()
%GetMemberCount()
%Initialize()
%Next()
%OnInitialize()
%OpenCursor()
%ResolveSetParameters()
%SupportsBitstrings()
%Validate()

Parameters

parameter INPUTOPERATORPROPNAMES;

Properties

property name as %String (XMLPROJECTION = "ATTRIBUTE") [ Required ];

The logical name of this operator, which must be unique within this <set>. Operator names are case insensitive.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()

property properties as list of property (XMLNAME = "property", XMLPROJECTION = "ELEMENT");

Any properties returned by this operator. Property names are case insensitive.

Property methods: propertiesBuildValueArray(), propertiesCollectionToDisplay(), propertiesCollectionToOdbc(), propertiesDisplayToCollection(), propertiesGet(), propertiesGetObject(), propertiesGetObjectId(), propertiesGetSwizzled(), propertiesIsValid(), propertiesOdbcToCollection(), propertiesSet(), propertiesSetObject(), propertiesSetObjectId()

relationship set as set (XMLPROJECTION = "NONE") [ Inverse = operators , Cardinality = one ];

Property methods: setGet(), setGetObject(), setGetObjectId(), setGetSwizzled(), setIsValid(), setNewObject(), setRClose(), setRExec(), setRFetch(), setRelate(), setSQLCompute(), setSet(), setUnRelate()

property target as %String (XMLPROJECTION = "ATTRIBUTE");

The class name of the records being selected by this operator. An empty value implies this operator selects anonymous strings.

Property methods: targetDisplayToLogical(), targetGet(), targetIsValid(), targetLogicalToDisplay(), targetLogicalToOdbc(), targetNormalize(), targetSet()

Methods

method %CloseCursor() as %Status

method %ContainsID(pID As %String, Output pSC As %Status) as %Boolean

method %Get(pPropertyName As %String) as %String

method %GetActualTarget() as %String

Returns the effective target of this operator, which defaults to target if it is set. If not, logical operators will derive the target from the operators they depend on.

method %GetAsArray(Output pArray, pIgnoreProperties As %Boolean = 0) as %Status

Main method to get all set members as an array of type pArray([member ID]) = $lb([properties...])

method %GetAsBitstrings(Output pBits) as %Status

final method %GetAsList(Output pSC As %Status) as %List

method %GetData(pPropertyIndex As %Integer) as %String

method %GetIKnowDomainId() as %Integer

method %GetMemberCount(Output pSC As %Status) as %Integer

final method %Initialize(pDefinition As %DeepSee.SetBuilder.Definition) as %Status

Initializes this node. Called as part of %CreateOperator

method %Next(Output pSC As %Status) as %Boolean

method %OnInitialize() as %Status

method %OpenCursor() as %Status

Default implementation just reads from %GetAsArray()

method %ResolveSetParameters(pString As %String) as %String

Resolves any %parameter references in pString

method %SupportsBitstrings() as %Boolean

final method %Validate(ByRef pExistingOperators) as %Status