Funciones de diccionario y arreglo en Jitterbit Design Studio

Introducción

Las funciones de diccionario y arreglo proporcionan estructuras de almacenamiento para información en scripts. Consulta las Funciones Relacionadas en el panel lateral para funciones adicionales que se pueden usar con arreglos.

Diferencia entre arreglos y diccionarios

Aunque son muy similares en muchos aspectos como un método para almacenar información, los arreglos y los diccionarios difieren en estas características importantes:

• Arreglos
  • Los elementos están ordenados
  • Los elementos se recuperan por posición
• Diccionarios
  • Los elementos se almacenan sin tener en cuenta el orden y no tienen un orden intrínseco
  • Los elementos se recuperan por una clave

La sintaxis para establecer y recuperar un elemento es similar (ambos pueden usar la notación de corchetes) pero los arreglos no tienen claves asociadas con los elementos y deben almacenar todos los ítems secuencialmente, sin huecos. Los diccionarios pueden ser dispersos, con claves pobladas solo según sea necesario.

Cuál usar depende de la naturaleza de la información. Los diccionarios son adecuados para información que varía en cómo se recupera. Los arreglos son a menudo mejores para conjuntos ordenados.

Estableciendo y recuperando valores en arreglos y diccionarios

// Example of an array
$org.lookup.currency = Array();
$org.lookup.currency[1]="USD";
$org.lookup.currency[2]="EUR";

// currency will be "USD"
currency = $org.lookup.currency[1];

// Example of a dictionary
$common.dictionary.message = Dict();
AddToDict($common.dictionary.message, 'OP_START', 'Start');
AddToDict($common.dictionary.message, 'OP_END', 'End');
AddToDict($common.dictionary.message, 'API_PARMS', 'API Parameters');

// message will be "API Parameters"
message = $common.dictionary.message['API_PARMS'];

Encontrando valores en diccionarios y arreglos

Para diccionarios, la función HasKey te permite probar si una clave está presente. Para un arreglo, puedes usar la función FindValue de manera similar pasando dos instancias del arreglo a la función:

arr = {1, 2, 3};
value = 1;
t = (FindValue(value, arr, arr) == value);
// t will be 1 (true)

value = 4;
t = (FindValue(value, arr, arr) == value);
// t will be 0 (false)

AddToDict

Declaración

bool AddToDict(dictionary dict, string key, type arg)

Sintaxis

AddToDict(<dict>, <key>, <arg>)

Parámetros requeridos

• dict: Un diccionario existente
• key: Clave que se utilizará en el diccionario
• arg: Valor que se colocará en esa clave

Descripción

Agrega un valor a un diccionario para una clave específica.

La clave debe ser una cadena o tener una representación de cadena, con claves nulas no permitidas. Cualquier valor es permitido, incluso valores nulos.

Devuelve true si el valor fue agregado y la nueva clave se añadió al diccionario o false si la clave ya existía y el valor en esa clave fue actualizado en su lugar. Si el primer argumento no está definido o no es un diccionario, se inicializará a un diccionario vacío antes de agregar el valor.

Consulta también la función Dict().

Ejemplos

// Initialize a dictionary prior to use
d = Dict();


// Adds a value to a dictionary "d" if a key doesn't already exist
If(!HasKey(d, "key"), AddToDict(d, "key", "value"));

// To directly assign a key-value, use this syntax:
d["key"] = "value";

Array

Declaración

array Array()

Sintaxis

Array()

Descripción

Crea un array vacío. Aunque los arrays no necesitan ser inicializados antes de su uso, este método puede ser utilizado para ser explícito o para reiniciar un array que ya existe. Los arrays son basados en cero, y los valores se recuperan utilizando índices.

Ejemplos

// Create an empty array and set values
arr = Array();
arr[0] = "value1";
arr[1] = "value2";

// Create an array and set the first value directly:
arr2[0] = "value";

// Arrays can be created with { } syntax:
arr3 = {};

Collection

Declaración

array Collection()

Sintaxis

Collection()

Descripción

Un alias para Array. Consulta la función Array.

CollectValues

Declaration

array CollectValues(dictionary dict, array names)

Syntax

CollectValues(<dict>, <names>)

Required parameters

• dict: Un diccionario existente
• names: Un arreglo de claves que se buscarán en el diccionario

Description

Devuelve un arreglo que contiene los valores correspondientes a los nombres en el arreglo de argumentos, devueltos en el mismo orden que las claves en el arreglo.

Examples

// Retrieve a map from a source instance
map = GetSourceInstanceMap([Values$Value.]);
names = Array();
names[0] = "Attr1";
names[1] = "Attr2";
// Array containing the values of
// the attributes named in the names array
values = CollectValues(map, names);

Dict

Declaration

dictionary Dict()

Syntax

Dict()

Description

Crea un diccionario vacío. Un diccionario es una colección de pares nombre-valor donde el valor se recupera basado en un valor de clave de cadena. Se permite cualquier valor, incluso valores nulos. La clave debe ser una cadena o tener una representación de cadena. No se permiten claves nulas. Ver también la función AddToDict().

Examples

// Creating a dictionary "myDictionary"
myDictionary = Dict();

// Assigning a value ("text") to the key "myKey"
myDictionary["myKey"] = "text";
// Using the AddToDict function instead
AddToDict(myDictionary, "myKey", "text");

GetKeys

Declaration

array GetKeys(dictionary dict)

Syntax

GetKeys(<dict>)

Required parameters

• dict: Un diccionario existente

Description

Devuelve un arreglo de las claves en un diccionario. El argumento debe ser un diccionario existente.

Ejemplos

// Retrieving the keys from the dictionary "myDictionary"
// using GetKeys and then looping through the array
// to retrieve all the values in the dictionary
// and writing them to the Operation Log
keys = GetKeys(myDictionary);
i=0;
While(i < Length(keys),
 WriteToOperationLog(myDictionary[keys[i]]);
 i++;
);

GetSourceAttrNames

Declaración

array GetSourceAttrNames(node n)

Sintaxis

GetSourceAttrNames(<n>)

Parámetros requeridos

• n: Una expresión de ruta de referencia de cadena a un nodo en la transformación actual

Descripción

Devuelve un arreglo que contiene los nombres de los atributos de un nodo, en el orden en que aparecen los atributos en el nodo.

Compárese con la función GetSourceInstanceMap que devuelve un mapa de las claves (los atributos) y valores para un nodo.

Para ingresar una ruta n en la función, haga doble clic en la carpeta del nodo XML deseado para insertar su ruta calificada en la ubicación de su cursor. Para más información, consulte las instrucciones sobre insertar rutas de nodos XML.

Ejemplos

// Appends all the attributes together without having
// to explicitly reference their source data elements
map = GetSourceInstanceMap([Values$Value.]);
names = GetSourceAttrNames([Values$Value.]);
i = 0;
n = Length(names);
str = "";

While(i < n,
  str = str + map[names[i]];
  i++;
);

GetSourceElementNames

Declaración

array GetSourceElementNames(node n)

Sintaxis

GetSourceElementNames(<n>)

Parámetros requeridos

• n: Una expresión de ruta de referencia de cadena a un nodo en la transformación actual

Descripción

Devuelve un arreglo que contiene los nombres de los subelementos simples para un nodo en el orden en que aparecen los atributos en el nodo.

Compara con la función GetSourceInstanceElementMap que devuelve un mapa de un nodo.

Para ingresar una ruta n en la función, haz doble clic en la carpeta del nodo XML deseado para insertar su ruta calificada en la ubicación de tu cursor. Para más información, consulta las instrucciones sobre inserción de rutas de nodos XML.

Ejemplos

// Appends all the attributes together without having
// to explicitly reference their source data elements
map = GetSourceInstanceElementMap([Values$Value.]);
names = GetSourceElementNames([Values$Value.]);

// The values as an array of values from the sub-elements
values = CollectValues(map, names);

GetSourceInstanceArray

Declaración

array GetSourceInstanceArray(node n)

Sintaxis

GetSourceInstanceArray(<n>)

Parámetros requeridos

• n: Una expresión de ruta de referencia de cadena a un nodo en la transformación actual

Descripción

Devuelve un arreglo que contiene el valor del atributo de un nodo elemento. El valor en el arreglo está etiquetado con el nombre del atributo y se puede recuperar ya sea por su índice o por su nombre como en un elemento de datos de diccionario.

Como alternativa a esta función, consulta GetSourceInstanceMap.

Para ingresar una ruta n en la función, haz doble clic en la carpeta del nodo XML deseado para insertar su ruta calificada en la ubicación de tu cursor. Para más información, consulta las instrucciones sobre inserción de rutas de nodos XML.

Ejemplos

arr = GetSourceInstanceArray([Values$Value.]);
// To retrieve the value of the "Attr1" attribute:
// If "Attr1" is the first attribute name, you can use:
v = arr[0];
// Or, you can use the name "Attr1":
v = arr["Attr1"];

GetSourceInstanceElementArray

Declaración

array GetSourceInstanceElementArray(node n)

Sintaxis

GetSourceInstanceElementArray(<n>)

Parámetros requeridos

• n: Una expresión de ruta de referencia de cadena a un nodo en la transformación actual

Descripción

Devuelve un arreglo que contiene el valor del sub-elemento de un nodo de elemento. El valor en el arreglo está etiquetado con el nombre del sub-elemento y se puede recuperar ya sea por su índice o por su nombre, como en el elemento de datos del diccionario.

Como alternativa a esta función, consulte GetSourceInstanceElementMap.

Para ingresar una ruta n en la función, haga doble clic en la carpeta del nodo XML deseado para insertar su ruta calificada en la ubicación de su cursor. Para más información, consulte las instrucciones sobre insertar rutas de nodos XML.

Ejemplos

arr = GetSourceInstanceElementMap([Values$Value.]);
// To retrieve the value of the "e1" sub-element:
// If "el" is the first sub-element, you can use:
v = arr[0];
// Or, you can use the name "e1":
v = arr["e1"];

GetSourceInstanceMap

Declaración

dictionary GetSourceInstanceMap(node n)

Sintaxis

GetSourceInstanceMap(<n>)

Parámetros requeridos

• n: Una expresión de ruta de referencia de cadena a un nodo en la transformación actual

Descripción

Devuelve un diccionario (mapa) que contiene el nombre del atributo y su valor de un nodo de elemento.

Como alternativa a esta función, consulta GetSourceInstanceArray.

Para ingresar una ruta n en la función, haz doble clic en la carpeta del nodo XML deseado para insertar su ruta calificada en la ubicación de tu cursor. Para más información, consulta las instrucciones sobre inserción de rutas de nodos XML.

Ejemplos

map = GetSourceInstanceMap([Values$Value.]);
v = map["Attr1"];
// Devuelve el valor del atributo "Attr1"

GetSourceInstanceElementMap

Declaración

dictionary GetSourceInstanceElementMap(node n)

Sintaxis

GetSourceInstanceElementMap(<n>)

Parámetros requeridos

• n: Una expresión de ruta de referencia de cadena a un nodo en la transformación actual

Descripción

Devuelve un diccionario (mapa) que contiene el valor del sub-elemento de un nodo de elemento.

Como alternativa a esta función, consulta GetSourceInstanceElementArray.

Para ingresar una ruta n en la función, haz doble clic en la carpeta del nodo XML deseado para insertar su ruta calificada en la ubicación de tu cursor. Para más información, consulta las instrucciones sobre inserción de rutas de nodos XML.

Examples

map = GetSourceInstanceElementMap([Values$Value.]);
v = map["e1"];
// Returns the value of the "e1" sub-element

HasKey

Declaration

bool HasKey(dictionary dict, string key)

Syntax

HasKey(<dict>, <key>)

Required parameters

• dict: Un diccionario existente
• key: Una clave para verificar en el diccionario

Description

Verifica si un diccionario contiene una clave especificada. Devuelve false si el primer argumento no es un diccionario o si la clave no fue encontrada. Como función equivalente que funciona para arreglos, consulte los ejemplos de la función FindValue.

Examples

// Update the value in a dictionary "myDictionary"
// only if the key already exists
If(HasKey(myDictionary, "key"),
    myDictionary["key"] = "value");

Map

Declaration

dictionary Map()

Syntax

Map()

Description

Un alias para Dict. Consulte la función Dict.

MapCache

Declaration

string MapCache(dictionary dict, string key, string value)

Syntax

MapCache(<dict>, <key>, <value>)

Required parameters

• dict: Un diccionario existente
• key: Una clave para verificar en el diccionario
• value: Un valor que se utilizará (y almacenará) si la clave no está en el diccionario

Descripción

Esta función almacena un par clave/valor en un diccionario. Si la clave ya existe en el diccionario, se devolverá el valor correspondiente; de lo contrario, se evaluará el tercer argumento y ese valor se almacenará en el diccionario para la clave.

Ejemplos

// Creating a dictionary "myDictionary"
// and caching values in it,
// if they don't already exist
myDictionary = Dict();
i=0;
a=MapCache(myDictionary, "key1", ++i);
b=MapCache(myDictionary, "key2", ++i);
c=MapCache(myDictionary, "key1", ++i);
result = i;
// The result will be
// result=2, a=1, b=2, and c=1
// as c's value will be retrieved
// rather than incremented

ReduceDimension

Declaración

array ReduceDimension(array arrayMultiD)

Sintaxis

ReduceDimension(<arrayMultiD>)

Parámetros requeridos

• arrayMultiD: Un arreglo multidimensional

Descripción

Dado un arreglo multidimensional con n dimensiones, la función devuelve un arreglo con n-1 dimensiones. La dimensión más baja del arreglo de entrada desaparecerá, y sus miembros se recopilarán en la siguiente dimensión superior.

Ejemplos

prices = ReduceDimension(orders$company.order#.detail#.price);
// If orders$company.order#.detail#.price
// is a 2-dimensional source data element array,
// the function will return a one-dimensional array

a = {{"0_0", "0_1"}, {"1_0", "1_1"}};
result = ReduceDimension(a);
// result will be {0_0, 0_1, 1_0, 1_1}

RemoveKey

Declaración

bool RemoveKey(dictionary dict, string key)

Sintaxis

RemoveKey(<dict>, <key>)

Parámetros requeridos

• dict: Un diccionario existente
• key: Una clave para verificar en el diccionario

Descripción

Elimina un par clave-valor con una clave específica de un diccionario. La clave debe ser una cadena o tener una representación en cadena, y no se permiten valores nulos. Devuelve true si el par clave-valor fue eliminado y false si la clave no existía.

Ejemplos

// Removes a key-value pair if it
// exists in dictionary "myDictionary"
If(HasKey(myDictionary, "key"),
    RemoveKey(myDictionary, "key"));

SortArray

Declaración

void SortArray(array arrayToSort[, bool isAscending])

void SortArray(array arrayToSort, int index[, bool isAscending])

Sintaxis

SortArray(<arrayToSort>[, <isAscending>])

SortArray(<arrayToSort>, <index>[, <isAscending>])

Parámetros requeridos

• arrayToSort: Un array que se va a ordenar
• index: Para arrays multidimensionales, índice del array que se va a ordenar (por defecto 0)

Parámetros opcionales

• isAscending: Si el array se va a ordenar en orden ascendente (el valor por defecto)

Descripción

Ordena un array por referencia. El valor de retorno es indefinido y debe ser ignorado.

En la primera forma, el segundo parámetro (opcional) especifica el orden de clasificación.

En la segunda forma, para arrays multidimensionales, la función ordena el array de acuerdo con un índice basado en cero especificado en el segundo parámetro (requerido). En la segunda forma, el tercer argumento (opcional) especifica el orden de clasificación.

El orden de clasificación por defecto es ascendente en ambas formas.

Después de que la función retorna, el array estará ordenado en su lugar. Si se especifica, se ordenará de acuerdo con el índice.

Es posible realizar múltiples ordenaciones del mismo array aplicando la función SortArray repetidamente.

Ejemplos

// Sorting a one-dimensional array
arr1 = {"Carol", "Bob", "Alice"};
SortArray(arr1);
// arr1 is now {Alice, Bob, Carol}

// Sorting a two-dimensional array
arr2 = {{"a", 20, 1}, {"bc", 7, 12}, {"x", 20, 13}, {"d", 5, 4}};

// Sort arr2, order by third column, descending
SortArray(arr2, 2, false);
// arr2 is now {{x, 20, 13}, {bc, 7, 12}, {d, 5, 4}, {a, 20, 1}}

// Sort arr2, order by second column, ascending
SortArray(arr2, 1);
// arr2 is now {{d, 5, 4}, {bc, 7, 12}, {x, 20, 13}, {a, 20, 1}