Mapping Operators

A Mapping Operator takes one or more arguments and returns either the value of a cimProperty or a boolean value for conditional mapping or arguments to another Mapping Operator. A Mapping Operator's arguments are either field values from the data source or the result of another Mapping Operator.

And: Boolean And of two or more boolean values. This example specifies a multiphase, non-gangoperated switch.

<And>
 <Equals value="No">
  <sourceField name="GangOperated" />
 </Equals>
 <GreaterThan value="1">
  <StringLength>
   <sourceField name="PhaseDesignation" />
  </StringLength>
 </GreaterThan>
</And>

Characters: Splits a character string into individual characters. This example occurs when constructing a CompositeSwitch in CIM from a single ArcFM Switch feature.
```
<Characters>
 <sourceField name="PhaseDesignation" />
</Characters>
```

CheckNull: Replaces a Null value in its argument with a default value.

<CheckNull value="0">
 <sourceField name="IMPEDANCE" />
</CheckNull>

Concatenate: Concatenates two or more values. The optional separator attribute specifies a string separating the concatenated values. If the attribute is absent, ":" is the separator. Concatenate is the default operator for cimProperty tags.
```
<Concatenate separator="" tagReference="ConductorCatalogKey">
 <sourceField name="CONDUCTORSIZE" />
 <sourceField name="CONDUCTORMATERIAL" />
</Concatenate>
```

Divide: Divides its argument by a specified value or by another argument.

<Divide>
 <Scale scale="1000">
  <sourceField name="KW" />
 </Scale>
 <ToVolts>
  <sourceField name="NominalVoltage" />
 </ToVolts>
</Divide>

Equals: True if its argument is equal to a specified value or a second argument. The test uses a string representation of its argument.
```
<Equals value="No">
 <sourceField name="GangOperated" />
</Equals>
```
Exists: True if its argument is not null. The result is true if the related CIRCUITSOURCE object does not exist or if the ID field is null.
```
<Exists>
 <sourceField name="CIRCUITSOURCE.ID" />
</Exists>
```
GreaterThan: True if is argument is greater than a specified value or a second argument. The test uses a string representation of its argument. Do not apply this rule to large numeric values.
```
<GreaterThan value="1">
 <StringLength>
  <sourceField name="PhaseDesignation" />
 </StringLength>
</GreaterThan>
```

Multiply: Multiplies two or more arguments.

<Multiply>
 <sourceField name="Impedance.ResistancePerKilometer" />
 <sourceField name="MEASUREDLENGTH" /> <!-- Length in meters -->
 <constant value="0.001" />
</Multiply>

Not: Boolean complement of its argument.

<Not>
 <SourceIs class="BusBar" />
</Not>

NotEquals: True if the argument is not equal to a specified value or another value in the data source.
```
<NotEquals value="Minerville">
 <sourceField name="OWNER" />
</NotEquals>
```

Or: Boolean Or of two or more boolean values.

<Or>
 <Equals value="Fly Tap">
  <sourceField name="SUBTYPECD" />
 </Equals>
 <Equals value="Loop">
  <sourceField name="SUBTYPECD" />
 </Equals>
 <Equals value="Non-Load Break Elbow">
  <sourceField name="SUBTYPECD" />
 </Equals>
</Or>

PadString: Pads a string with a specified prefix.

<PadString prefix="0" length="5">
 <sourceField name="FACILITYID" />
</PadString>

Scale: Multiplies its argument by a specified value and optionally adds a specified offset. To add 100 to the value after multiplying by 1000, add offset="100" to the Scale tag.
```
<Scale scale="1000">
 <sourceField name="TotalKvar" />
</Scale>
```

StringLength: Returns the length of a string.

<StringLength>
 <sourceField name="PhaseDesignation" />
</StringLength>

NormalOpens: Returns the values of its second and following arguments based upon the value of its first argument. The first argument is a bit map specifying which of the following arguments should be returned. If the value of PhaseDesignation is 4 (A), this example returns the value of NormalPosition_A. If the value of PhaseDesignation is 6 (AC), the example returns the values of NormalPosition_A and NormalPosition_C.
```
<NormalOpens>
 <sourceField name="PHASEDESIGNATION" useDomain="false" />
 <sourceField name="NORMALPOSITION_A" />
 <sourceField name="NORMALPOSITION_B" />
 <sourceField name="NORMALPOSITION_C" />
</NormalOpens>
```

Map: Returns the value of a map corresponding to the value of its argument.

<Map mapRef="Voltage">
 <sourceField name="OperatingVoltage" useDomain="false"/>
</Map>

Lookup: Retrieves a value from a lookup table using its arguments a key values. The ImpedanceCatalog table has three fields, MATERIAL, SIZE and RESISITANCE. In this example, the rule finds a row in the lookup table with MATERIAL and SIZE given by the values of the CONDUCTORMATERIAL and CONDUCTORSIZE fields of the primary source object. The rule returns the value of the table's RESISTANCE column.
```
<Lookup tableName="ImpedanceCatalog" keyField="MATERIAL,CONDSIZE" valueField="RESISTANCE">
 <sourceField name="CONDUCTORMATERIAL" />
 <sourceField name="CONDUCTORSIZE" />
</Lookup>
```