wiki:programmersguide/architecture/web/core/semantics/Format

Version 2 (modified by raphael.costa, 9 years ago) (diff)

--

Format

As semanticas do TerraMA² estão definidas no arquivo semantics.json.

Tipos de campos

Esta seção descreve todos os tipos de campos que serão apresentados na interface na Aplicação Web do TerraMA².

TiposDescrição
stringDefine um campo do tipo texto.
numberDefine um campo do tipo numerico. Será aceito tanto numeros inteiros e numeros com ponto flutuante
integerDefine um campo do tipo inteiro.
booleanDefine um campo do tipo checkbox.

Seções

Metadados

Interface e modelo de dados

A seção gui define a estrutura geral de dados conforme é apresentado abaixo:

"gui": {
  "schema": {
    "properties": {
      "table_name": {
        "type": "string",
        "title": "Table Name"
      }
    },
    "required": ["table_name"]
  },
  "form": ["*"]
}

Neste bloco, contém os seguintes elementos:

  • schema Define as regras gerais dos componentes. Basicamente, define-se a regra de negocio da semantica. Este bloco é composto dos seguintes elementos:
    • properties Define quais são os campos utilizados dessa semantica. Um exemplo pode ser visto abaixo:
        ..
        "properties": {
          "table_name": {
            "key": "string",
            "title": "Table Name"
          }
        }
      
      Dentro de cada campo (field1) deve-se descrever obrigatoriamente o campo key que define o tipo de dado.(LINK). Podemos inclusive adicionar outros elementos.
          "table_name": {
            "key": "string",
            "title": "Table Name",
            "placeholder": "It represents a description of field"
          }
      
    • required Define quais campos serão obrigatórios na interface
  • form Define como os elementos serão desenhados na interface, bem como a ordem deles. Este bloco deve ser obrigatoriamente uma cadeia (array) de elementos. TODO:

Criando uma nova semantica

TODO: