Class MappingKey

Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. Can be either single or compound keys. For example, a single string (e.g. product id) or multiple string components (e.g. product id and site).

Property Summary 

PropertyDescription
keyComponents: String[] (read-only)Gets the (possible compound) key.
singleComponentKey: String (read-only)Gets a key that contains only a single key component (i.e.

Constructor Summary 

ConstructorDescription
MappingKey(String…)Instantiates a new key using compound key components.

Method Summary 

MethodDescription
getKeyComponents()Gets the (possible compound) key.
getSingleComponentKey()Gets a key that contains only a single key component (i.e.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

keyComponents 

keyComponents: String[] (read-only)

Gets the (possible compound) key. If the key consists of only of a single value, the string array will simply contain a single element.


singleComponentKey 

singleComponentKey: String (read-only)

Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is not a single component key.


Constructor Details 

MappingKey(String...) 

MappingKey(keyComponents: String...)

Instantiates a new key using compound key components. A key can consist of a single string (e.g. product id) or multiple string components (e.g. product id and site). Ctor accepts single string or multiple components for a compound key.

Parameters:

  • keyComponents - the key components

Method Details 

getKeyComponents() 

getKeyComponents(): String[]

Gets the (possible compound) key. If the key consists of only of a single value, the string array will simply contain a single element.

Returns:

  • the key

getSingleComponentKey() 

getSingleComponentKey(): String

Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is not a single component key.

Returns:

  • the single key