Class: DataSetManager

@nginstack/engine/lib/dataset/DataSetManager~ DataSetManager


new DataSetManager()

Classe de objeto para o trabalho com vários datasets, facilitando a execução dos queries em bloco e possibilitando a abstração da origem dos datasets bem como a serialização dos datasets.

Methods


addDataSet(dataSetName, dataSet)

Adiciona dataset na lista de datasets

Parameters:
Name Type Description
dataSetName String

Nome do dataset sendo adicionado.

dataSet DataSet

Dataset que ficará associada ao nome.


addDataSetQuery(dataSetName, query [, union])

Adiciona query na lista de queries a serem executados

Parameters:
Name Type Argument Description
dataSetName String

Nome do dataset, utilizado para se obter o dataset após execução do query.

query String

Query a ser executado no banco. A query ficará associada ao nome do dataset.

union Boolean <optional>

Adiciona mais um query ao dataset, onde esse query será dado union com outro existente.


clearAll()

Limpa a lista dos datasets


clearDataSets()

Limpa os datasets


dataSetNameExists(dataSetName)

Verifica se um nome de dataset já foi definido.

Parameters:
Name Type Description
dataSetName String

nome do dataset a ser verificado

Returns:

Retorna true se existe o nome do dataset

Type
Boolean

delDataSets(um)

Remove um dataSet e todas as suas propriedades vinculadas a um determinado nome.

Parameters:
Name Type Description
um String | Array

nome ou array de nomes dos dataSets.


executeAllQueries()

Executa todas as consultas.


executePendingQueries()

Executa as consultas pendentes, ou seja, as que não possuem dataset.


getDataSet(dataSetName)

Pega um dataset pelo nome.

Parameters:
Name Type Description
dataSetName String

Nome do dataSet a ser obtido.

Returns:

Dataset associado ao nome

Type
DataSet

getDataSetNames()

Pega todos os nomes de datasets no gerenciador.

Returns:

Array com os nomes dos datasets

Type
Array

getQuery(dataSetName)

Pega um query pelo nome. O resultado pode ser uma string ou um array no caso de um dataset com querys para union.

Parameters:
Name Type Description
dataSetName String

Nome do dataSet a ser obtido.

Returns:

A query associada ao nome

Type
String | Array

loadFromStream(stream)

Reconstrói os datasets serializados pelo DataSetManager a partir um stream.

Parameters:
Name Type Description
stream File | MemoryStream

Stream que contém os datasets serializados.


saveToStream(stream)

Serializa os datasets para um stream. O nome do dataset vai prefixar o dataset no arquivo e o separador entre o nome do dataset e o dataset será # (cerquilha).

Parameters:
Name Type Description
stream Stream

O stream onde será serializado os datasets.


setDataSet(dataSetName, dataSet)

Altera o dataset

Parameters:
Name Type Description
dataSetName String

Nome do dataset sendo alterado.

dataSet DataSet

Dataset que ficará associada ao nome.


setDataSetQuery(dataSetName, query, Informa)

Muda um query de um dataset

Parameters:
Name Type Description
dataSetName String

Nome do dataset, utilizado para se obter o dataset após execução do query.

query String

Query a ser executado no banco. A query ficará associada ao nome do dataset.

Informa Boolean

se o dataSet vai ser mantido.