Class Index | File Index

Classes


Class bdo.datasource.DataSource


Defined in: datasource.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
bdo.datasource.DataSource(definition, opt_options)
Classe responsável pela execução e manipulação de Fontes de Dados (por exemplo, scripts .ids).
Field Summary
Field Attributes Field Name and Description
<static>  
bdo.datasource.DataSource.ColumnOps
Operadores para colunas de Datasource.
 
Coleção das colunas disponíveis dos dados retornados.
 
Coleção dos filtros disponíveis para a consulta dos dados.
 
Ajuda para o usuário final que deve explicar o propósito das informações retornadas por esta fonte de dados e deve orientar o usuário quanto ao seu uso.
 
Indica se a definição da fonte de dados é pública.
Method Summary
Method Attributes Method Name and Description
 
convertColumns_(columns)
Converte as colunas do formato objeto literal para o formato nativo do DataSource.
 
createColumns(jsonColumns)
Cria o objeto de colunas.
 
createFilters(jsonFilters)
Cria o objeto de filtros.
 
Deriva filtros a partir de um array de objetos com chave e valor, onde a chave deverá ser o nome do filtro e o valor deve ser correspondente ao valor do filtro.
<inner>  
fillSourceColumns(columnDef)
Preenche as colunas com as definições.
<inner>  
fillSourceFilters(filterDef)
Preenche os filtros com as definições.
 
getDataSet(filters, columns)
Obtém uma seleção de registros desta fonte de dados.
 
Obtém a chave do script .ids que foi utilizado na geração deste DataSource.
 
getQuery(filters, columns)
Retorna o comando SQL responsável por gerar o DataSet do DataSource.
 
getResult(filters, columns)
Retorna uma representação de um resultado bdo.dataSource.Result especializado para uma consulta de uma fonte de dados.
 
Obtém a url do IDS(*.ids) que gerou este DataSource
<static>  
bdo.datasource.DataSource.list()
Lista todos os DataSources existentes na base.
 
Executa a função onMountDataSet, caso ela esteja definida no DataSource.
 
Remove as colunas inseridas pela fonte de dados que não foram solicitadas em columns.
Class Detail
bdo.datasource.DataSource(definition, opt_options)
Classe responsável pela execução e manipulação de Fontes de Dados (por exemplo, scripts .ids).
  var options = {
    specializedFilters: [   //Especializa a importação dos filtros
      {classKey: -2007889000, prefix: "PES"}
    ],
    specializedColumns: [  //Especializa a importação das colunas
      {classKey: -2007889000, prefix: "PES"}
    ]
  };

  new DataSource(-2007890000, dtsOptions);
Parameters:
{!(bdo.datasource.DataSourceDef|Object|number)} definition
Chave da configuração da consulta de DataSource ou objeto literal contendo as mesmas propriedades definidas na iVFS e capturadas através da chave.
{Object=} opt_options
Objeto literal com opções de configuração do DataSource.
See:
bdo.datasource.DataSourceDef
Field Detail
<static> bdo.datasource.DataSource.ColumnOps
Operadores para colunas de Datasource.

columns
Coleção das colunas disponíveis dos dados retornados.

filters
Coleção dos filtros disponíveis para a consulta dos dados.

help
Ajuda para o usuário final que deve explicar o propósito das informações retornadas por esta fonte de dados e deve orientar o usuário quanto ao seu uso.

public
Indica se a definição da fonte de dados é pública. Se a está propriedade for declarada como "true" outros sistemas poderão consumí-la. Optar por tornar uma fonte de dados pública é perigoso quando {@link bdo.datasource.DataSourceDef#onGetQuery} da definição da fonte de dados retorna uma consulta sql pois, não serão testadas as permissões do usuário. No caso, recomenda-se definir como retorno, uma instância de IQuery em bdo.datasource.DataSourceDef#onGetQuery.
Method Detail
{bdo.datasource.Columns} convertColumns_(columns)
Converte as colunas do formato objeto literal para o formato nativo do DataSource.
Parameters:
{Array} columns
Colunas JSON
Returns:
{bdo.datasource.Columns} Lista de colunas no formato nativo do DataSource @private

createColumns(jsonColumns)
Cria o objeto de colunas.
Parameters:
{Array|Array} jsonColumns
Colunas no formato JSON que serão processadas para gerar o objeto de colunas.

{bdo.datasource.Filters} createFilters(jsonFilters)
Cria o objeto de filtros.
Parameters:
{Array|Array} jsonFilters
Filtros no formato JSON que serão processados para gerar o objeto de filtros.
Returns:
{bdo.datasource.Filters}

{bdo.datasource.Filters} createFiltersFromMap(filtersMap)
Deriva filtros a partir de um array de objetos com chave e valor, onde a chave deverá ser o nome do filtro e o valor deve ser correspondente ao valor do filtro.
Parameters:
{Object} filtersMap
Mapa que representa os filtros que serão utilizados na fonte de dados.
Returns:
{bdo.datasource.Filters} Coleção dos filtros criados a partir do mapa.

<inner> fillSourceColumns(columnDef)
Preenche as colunas com as definições.
Parameters:
{bdo.datasource.ColumnDef} columnDef
Definição da coluna

<inner> fillSourceFilters(filterDef)
Preenche os filtros com as definições.
Parameters:
{bdo.datasource.ColumnDef} filterDef
Definição dos filtros

{DataSet} getDataSet(filters, columns)
Obtém uma seleção de registros desta fonte de dados. Serão retornadas as informações referenciadas pelas colunas informadas em columns dos registros que satisfaçam os filtros informados em filters.
Parameters:
{bdo.datasource.Filters} filters
Coleção dos filtros que determinam quais registros devem ser retornados.
{bdo.datasource.Columns} columns
Coleção das colunas quem devem ser retornadas.
Returns:
{DataSet} DataSet contendo os registros que satisfazem os filtros informados.

{number} getKey()
Obtém a chave do script .ids que foi utilizado na geração deste DataSource.
Returns:
{number} A chave do script .ids

{string} getQuery(filters, columns)
Retorna o comando SQL responsável por gerar o DataSet do DataSource.
Para gerar o comando SQL será necessário informar uma coleção de filtros e colunas.
  // /products/INTEQengine/library/dataSource/DataSource.ijs);
  __includeOnce('/bdo/datasource/datasource.js');

  // /products/INTEQengine/dataSources/Logs.ids
  var dts = new DataSource(-1898142161);
  var filters = dts.createFilters([{name: "LOG_IKEY", value: -1}])
  var columns = dts.createColumns([{name: "LOG_IKEY"}])
  var ds = dts.getQuery(filters, columns)
Parameters:
{bdo.datasource.Filters} filters
Coleção de filtros usado para gerar o SQL o DataSource.
{bdo.datasource.Columns} columns
Coleção de colunas que deveram ser geradas no DataSet gerado pelo DataSource.
Returns:
{string} Comando SQL gerado pelo DataSource.

{bdo.datasource.Result} getResult(filters, columns)
Retorna uma representação de um resultado bdo.dataSource.Result especializado para uma consulta de uma fonte de dados.
Parameters:
{Array|Array} filters
Definições de filtro em formato JSON que serão transformados para o objeto de filtros de uma fonte de dados com a finalidade de restringir a consulta dos dados realizada pela API de fontes de dados.
{Array|Array} columns
Definições de colunas em formato de JSON que serão transformadas para o objeto de colunas de fonte de dados com a finalidade de projetar as colunas que irão fazer parte do resultado do consumo de uma fonte de dados.
Returns:
{bdo.datasource.Result} Resultado especializado.

{String} getUrl()
Obtém a url do IDS(*.ids) que gerou este DataSource
Returns:
{String} Url do IDS(*.ids)

<static> {DataSet} bdo.datasource.DataSource.list()
Lista todos os DataSources existentes na base.
Returns:
{DataSet} DataSet com a chave, nome e url das fontes de dados existentes na base de dados.

{DataSet} mountDataSet(ds)
Executa a função onMountDataSet, caso ela esteja definida no DataSource.
Parameters:
{DataSet} ds
O dataSet utilizado pelo dataSource na montagem do retorno.
Returns:
{DataSet} Novo dataset gerado com a regra de negócio definida na função onMountDataSet.

{DataSet} purgeUnsolicitedColumns(ds, columns)
Remove as colunas inseridas pela fonte de dados que não foram solicitadas em columns.
Parameters:
{DataSet} ds
DataSet que terá removidas as colunas não definidas em columns.
{bdo.datasource.Columns} columns
Colunas solicitadas.
Returns:
{DataSet} DataSet sem as colunas não solicitadas.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Aug 23 2016 16:17:58 GMT-0300 (GFT)