Ayudantes de entrada: Vista general, Detalles y Restricciones
Los ayudantes de entrada de la vista Esquema JSON están situados por defecto en el lateral derecho de la ventana de la aplicación. Los ayudantes están disponibles en ambos modos de la ventana principal: (i) Tabla de definiciones y (ii) Vista de diseño. Puede arrastrar los ayudantes de entrada por sus barras de título a otras ubicaciones de la pantalla, y puede hacer doble clic en la barra de título de un ayudante de entrada con el fin de acoplarlo o desacoplarlo. Para saber más sobre estas operaciones, consulte la sección Ayudantes de entrada.
Ayudante de entrada Vista general
El ayudante de entrada Vista general (imagen siguiente) muestra la definición actual del esquema y todas las definiciones globales de dicho esquema. Si hace doble clic en una definición, ésta se abre en la Vista Diseño, donde se puede editar. Si desea utilizar definiciones de esquemas externos, basta con añadir el esquema externo y después reutilizar la definición correspondiente.
Agregar un esquema externo
Para agregar un esquema externo, haga clic en el icono Agregar esquema nuevo del ayudante de entrada Vista general y, a continuación, busque el esquema que desee agregar. Una vez agregado el esquema, sus definiciones se mostrarán en el ayudante de entrada Vista general. En la imagen siguiente, por ejemplo, puede ver que se ha agregado el esquema TelNumbers.json y que dicho esquema contiene una definición denominada USTelephoneNumbers. Puede agregar tantos esquemas externos como desee.
Reutilizar una definición externa
Una vez agregado el esquema externo, sus definiciones se podrán reutilizar en las definiciones del esquema al que se importaron. Cuando una definición reutiliza otra definición (por medio de referencias), toma todas sus propiedades. La referencia puede hacerse de dos maneras:
•En la Vista Diseño: arrastre la definición global desde el ayudante de entrada Vista general hasta la definición donde quiere usarla.
•En la Tabla de definiciones o en la Vista Diseño: a través del campo Referencia del ayudante de entrada Detalles de la definición en la que desea reutilizarla. Para más información, consulte la descripción del ayudante de entrada Detalles.
Nota: El icono Actualizar situado junto a la entrada Esquemas externos del ayudante Vista general sirve para actualizar todos los esquemas externos que se hayan agregado. Tenga en cuenta que, si no se ha reutilizado ninguna definición de un esquema externo agregado, dicho esquema se eliminará de la lista cuando esta se actualice.
Ayudante de entrada Detalles
Las propiedades de una definición pueden introducirse en las ventanas Detalles y Restricciones cuando se selecciona la definición en cualquiera de los dos modos de la ventana principal: Tabla de definiciones o Vista Diseño. En la imagen siguiente puede ver la definición de USTelephoneNumbers en la Vista Diseño junto con los ayudantes de entrada Detalles y Restricciones. Observe que la información de los dos ayudantes de entrada también aparece en el recuadro azul de la definición en la Vista Diseño. Más abajo puede ver qué propiedades pueden configurarse en estos dos ayudantes de entrada.
En el ayudante de entrada Detalles se pueden introducir los siguientes datos:
•Nombre: el nombre de la definición.
•Referencia: si desea que una definición reutilice otra definición, haga clic en el botón Cuadro de diálogo adicional del campo Referencia (imagen anterior). Esto abre el cuadro de diálogo Editar referencia, donde se enumeran todas las definiciones disponibles (tanto del esquema actual como de los esquemas externos). Seleccione la definición que desee reutilizar, marque la opción Ruta relativa si desea una ruta relativa y haga clic en Aceptar. Consulte Definiciones globales y locales para obtener más información.
•Tipo: seleccione el tipo de datos de la definición en la lista desplegable del cuadro combinado. Tenga en cuenta que si cambia el tipo de la definición se eliminarán las palabras clave que sean propias del tipo anterior. Si desea volver a las definiciones anteriores, pulse Deshacer (Ctrl-Z). Los tipos se explican en los apartados Datos JSON y Selectores de tipo (cualquiera, múltiple, etc.).
•ID: se trata de una palabra clave opcional que define un URI para el esquema. Este URI puede utilizarse para hacer referencia al esquema y se emplea como URI de base para otras referencias de URI dentro del esquema. El valor ID debe ser una cadena que constituya un URI. Tenga en cuenta que la función de validación JSON de Altova utiliza únicamente la desreferenciación canónica. Consulte la especificación JSON para obtener más información.
•Ancla (novedad en draft-2019-09): se trata de una palabra clave de identificación opcional que proporciona un fragmento de nombre simple (y no un URI, como ocurre con ID). El valor de Anchor debe ser una cadena de caracteres, tal y como se describe en los borradores correspondientes.
•Título, Descripción: los valores de estas dos palabras clave se utilizan con fines descriptivos y pueden ser leídos por el usuario final.
•Comentario (draft-07): destinado a las notas dirigidas a los responsables del mantenimiento de esquemas, a diferencia de la palabra clave Descripción, que está dirigida a los usuarios finales.
•Const (draft-06): un valor constante, como una enumeración de un solo valor.
•Predet.: el valor predeterminado de la definición.
•Solo lectura, Solo escritura (novedad en draft-07): indican, respectivamente, campos de solo lectura y de solo escritura. Un ejemplo de campo de solo escritura sería el campo de la contraseña.
•Obsoleto (novedad en draft-2019-09): un indicador de que la definición seleccionada podría eliminarse en el futuro. Las aplicaciones tienen métodos especiales para tratar con este tipo de definiciones.
Ayudante de entrada Restricciones
Las restricciones de una definición dependen del tipo que tenga. A continuación describimos las restricciones de cada tipo. (Consulte también el apartado sobre Tipos atómicos.)
Los tipos que faltan en esta lista se han excluido porque no pueden tener restricciones. Sin embargo, recuerde que puede definir enumeraciones para todos los tipos:
•Cadena de texto: la longitud de la cadena y el patrón de la misma; el patrón se especifica mediante una expresión regular. En el campo Formato puede seleccionar uno de los formatos de cadena de texto que se definen en la especificación JSON (imagen anterior, que muestra los formatos disponibles en la versión draft-04); existen más formatos definidos en versiones posteriores. Content Media Type y Content Encoding (ambos nuevos en la versión draft-07) seleccionan el tipo de soporte y de codificación de los datos no JSON codificados en cadenas JSON.
•Numérico: el rango de valores permitidos
•Matriz: el número de elementos permitidos en la matriz y si los elementos deben ser únicos
•Objeto: el número de propiedades permitidas
El ayudante de entrada Restricciones siempre incluye la pestaña Enumeraciones, para todos los tipos. En ella puede especificar una lista de elementos permitidos del tipo de dicha definición. Asimismo, existe una pestaña Ejemplos (novedad en draft-06) para todos los tipos excepto para el tipo Prohibido. Se trata de una serie de ejemplos sin efecto de validación; el valor default puede utilizarse como ejemplo sin necesidad de repetirlo bajo esta palabra clave.