Extensiones IBM para Dojo Toolkit

Biblioteca Atom, almacén de datos y widgets

Referencia de biblioteca Atom:

La biblioteca Atom se puede dividir en tres categorías: funciones de programa de utilidad, el modelo de datos Atom y el objeto AtomIO.


Funciones de programa de utilidad
Resumen de funciones
Serie createDate(DOMNode node)
Crea una fecha a partir del contenido de texto de nodo de un DOM
Serie escapeHtml(String str)
Convierte en escape los caracteres especiales XML en una serie HTML
Serie unEscapeHtml(String str)
Elimina el escape de los caracteres especiales XML en una serie HTML
Fecha getIso8601Date(String iso8601String)
Convierte una serie de fecha ISO-8610 en un objeto de fecha
Serie dateToIso8601String(Date date, String offset)
Convierte un objeto de fecha en una serie ISO-8610
Serie getNodename(DOMNode node)
Obtiene un nombre de nodo

Detalles de las funciones
createDate

escapeHtml

unEscapeHtml

getIso8601Date

dateToIso8601String

getNodename

Modelo de datos Atom

Para obtener una referencia de los elementos Atom, consulte la especificación Atom que se encuentra aquí.

Visión general de los componentes
ibm_atom.io.atom.AtomItem Elemento Atom genérico. Clase básica de entrada y canal de información.
ibm_atom.io.atom.Category Elemento de categoría Atom.
ibm_atom.io.atom.Content Elemento de contenido Atom. Maneja varios tipos (texto, html, etc.) de acuerdo con la especificación Atom. Se utiliza para el contenido, los resúmenes y los títulos.
ibm_atom.io.atom.Link Elemento de enlace Atom. Maneja varios tipos de enlace (edición, alt, etc.)
ibm_atom.io.atom.Person Elemento de persona Atom. Se utiliza para representar autores y colaboradores.
ibm_atom.io.atom.Generator Elemento de generador Atom.
ibm_atom.io.atom.Entry Elemento de entrada Atom. Representa una entrada Atom, incluido el almacenamiento de los autores, colaboradores, título, contenido, etc.
ibm_atom.io.atom.Feed Elemento de canal de información Atom. Representa un canal de información Atom, incluidos los elementos de canal de información como, por ejemplo, el título y el autor, y también representa la lista de entradas.
ibm_atom.io.atom.Service Elemento de servicio Atom.
ibm_atom.io.atom.Workspace Elemento de espacio de trabajo Atom.
ibm_atom.io.atom.Collection Elemento de colección Atom.

Detalles de los componentes
ibm_atom.io.atom.AtomItem

La clase AtomItem generalmente no se utiliza de forma independiente y es la clase básica de los objetos de entrada y canal de información Atom, ya que comparten algunos componentes (título, subtítulo, icono, matrices de autores, colaboradores y enlaces).

Variables del objeto
Serie ATOM_URI El URI del espacio de nombres Atom
Matriz enlaces Aloja varios objetos ibm_atom.io.atom.Link de los enlaces asociados con este elemento Atom
Matriz autores Aloja los objetos ibm_atom.io.atom.Person de los autores
Matriz categorías Aloja los objetos ibm_atom.io.atom.Category asociados con este elemento Atom
Matriz colaboradores Aloja los objetos ibm_atom.io.atom.Person de los colaboradores
Serie icon El URL del icono de este elemento
Serie id El ID de este elemento
Serie logo El URL del logotipo de este elemento
Serie rights Los derechos asociados de este elemento Atom
ibm_atom.io.atom.Content título El título de este elemento
ibm_atom.io.atom.Content subtítulo El subtítulo de este elemento
Fecha actualizada La fecha en la que se ha actualizado este elemento
ibm_atom.io.atom.Content contenido El contenido de este elemento
Matriz entradas Matriz de objetos ibm_atom.io.atom.Entry de este elemento

Funciones del objeto
Booleano accept(String tag)
Devuelve si este elemento acepta el nombre de código proporcionado. Las clases hijo pueden alterarlo temporalmente
void _postBuild()
Función que se ejecuta cuando finaliza buildFromDom. Los objetos hijo pueden alterar temporalmente esta función si necesitan añadir funcionalidad cuando finaliza la compilación.
void buildFromDom(DOMNode node)
Compila este AtomItem a partir de un DOMNode dado.
void addAuthor(String name, String email, String uri)
Añade un autor a este elemento con la información dada
void addContributor(String name, String email, String uri)
Añade un colaborador a este elemento con la información dada
void addCategory(String name, String term, String label)
Añade una categoría a este elemento con la información dada
void addLink(String href, String rel, String hrefLang, String title, String type)
Añade un enlace a este elemento con los atributos dados
Número removeLink(String href, String rel)
Elimina el enlace dado de este elemento y devuelve el número de enlaces eliminados
Número removeBasicLinks()
Elimina todos los enlaces básicos (enlaces sin atributos rel) de este elemento y devuelve el número de enlaces eliminados
Matriz getCategories(String scheme)
Obtiene todas las categorías que coinciden con el esquema dado para este elemento y las devuelve en una matriz
Número removeCategories(String scheme, String term)
Elimina todas las categorías que coinciden con el esquema dado y devuelve el número de categorías eliminadas.
void setTitle(String str, String type)
Establece el título de este elemento en la serie dada con el tipo dado.
void addExtension(String name_space, String name, Array attributes, String content, String shortNS)
Añade un espacio de nombres de extensión en el elemento.
Matriz getExtensions(String name_space, String name)
Obtiene todas las extensiones que coinciden con el name_space y el nombre proporcionados, y devuelve dichas extensiones en una matriz. name_space puede ser el espacio de nombres completo (como 'http://www.w3.org/2005/Atom') o el nombre abreviado (como 'atom')
void removeExtensions(String name_space, String name)
Elimina todas las extensiones que coinciden con el name_space y el nombre proporcionados
void destroy()
Suprime todas las variables asociadas con este elemento
ibm_atom.io.atom.Category

Este objeto representa el elemento de categoría de la especificación Atom. Las entradas y los canales de información pueden tener elementos de categoría para transportar información sobre la entrada o el canal de información.

Variables del objeto
Serie scheme El esquema de esta categoría
Serie term El término de esta categoría
Serie label La etiqueta de esta categoría

Funciones del objeto
Booleano accept(String tag)
Siempre devuelve false, ya que las categorías no tienen elementos hijo.
void _postBuild()
Función que se ejecuta cuando finaliza buildFromDom. Los objetos hijo pueden alterar temporalmente esta función si necesitan añadir funcionalidad cuando finaliza la compilación.
Serie toString()
Devuelve una serie que representa esta categoría como XML
void buildFromDom(DOMNode node)
Crea esta categoría a partir del nodo XML dado
ibm_atom.io.atom.Content

Este objeto crea un modelo de un objeto de contenido genérico, que se utiliza en la especificación Atom como títulos, subtítulos, contenido y resumen. Un objeto de contenido puede tener varios tipos además de su valor.

Variables del objeto
Serie tagName El nombre de este elemento, por ejemplo, el contenido, el resumen, etc.
Serie value El valor de este elemento
Serie src El URL que contiene el valor de este elemento
Serie type El tipo del contenido almacenado en este elemento. Los valores aceptables se listan más abajo.
Serie xmlLang El idioma del contenido. El idioma se incluye en la salida si este elemento se coloca en una serie.
Serie HTML Una serie que representa el tipo HTML
Serie TEXT Una serie que representa el tipo de texto
Serie XHTML Una serie que representa el tipo XHTML
Serie XML Una serie que representa el tipo XML

Funciones del objeto
void _postBuild()
Función que se ejecuta cuando finaliza buildFromDom. Los objetos hijo pueden alterar temporalmente esta función si necesitan añadir funcionalidad cuando finaliza la compilación.
void buildFromDom(DOMNode node)
Compila este objeto de contenido a partir de un DOMNode dado.
Serie toString()
Devuelve una serie que representa esta categoría como XML.
ibm_atom.io.atom.Link

Este objeto representa el elemento de enlace Atom.

Variables del objeto
Serie href El URL de este enlace
Serie hrefLang El atributo hrefLang
Serie rel El atributo rel, que describe la relación de este enlace con el elemento padre
Serie título El título de este enlace
Serie type El tipo de enlace

Funciones del objeto
void _postBuild()
Función que se ejecuta cuando finaliza buildFromDom. Los objetos hijo pueden alterar temporalmente esta función si necesitan añadir funcionalidad cuando finaliza la compilación.
void buildFromDom(DOMNode node)
Compila este objeto de enlace a partir de un DOMNode dado
Serie toString()
Devuelve una serie que representa esta categoría como XML
ibm_atom.io.atom.Person

Este objeto representa un objeto de persona, que se utiliza para los tipos de autor y colaborador en la especificación Atom. Un objeto de persona puede tener un nombre, una dirección de correo electrónico, un URI, o todos a la vez.

Variables del objeto
Serie personType El tipo de persona que representa este objeto, normalmente un autor o un colaborador.
Serie name El nombre de este objeto de persona
Serie email La dirección de correo electrónico de esta persona
Serie uri El URI de esta persona

Funciones del objeto
void _postBuild()
Función que se ejecuta cuando finaliza buildFromDom. Los objetos hijo pueden alterar temporalmente esta función si necesitan añadir funcionalidad cuando finaliza la compilación.
void buildFromDom(DOMNode node)
Compila este objeto de persona a partir de un DOMNode dado
Serie toString()
Devuelve una serie que representa esta categoría como XML
Booleano accept(String tag)
Devuelve si este elemento acepta el nombre de código proporcionado; las clases hijo pueden alterarlo temporalmente
ibm_atom.io.atom.Generator

Este elemento Atom transporta información sobre el paquete que ha generado este canal de información Atom. Un generador puede tener un URI y un número de versión, además del nombre legible por una persona.

Variables del objeto
Serie uri El URI de este generador
Serie version El número de versión de este generador
Serie value El nombre legible para las personas de este generador

Funciones del objeto
void _postBuild()
Función que se ejecuta cuando finaliza buildFromDom. Los objetos hijo pueden alterar temporalmente esta función si necesitan añadir funcionalidad cuando finaliza la compilación.
void buildFromDom(DOMNode node)
Compila este objeto de generador a partir de un DOMNode dado.
Serie toString()
Devuelve una serie que representa esta categoría como XML.
ibm_atom.io.atom.Entry

Este objeto representa el elemento de entrada Atom y amplía ibm_atom.io.atom.AtomItem. Las variables heredadas y las funciones correspondientes pueden encontrarse aquí.

Variables del objeto
Serie feedUrl El URL del canal de información Atom que posee esta entrada

Funciones del objeto
Serie toString()
Devuelve una serie que representa esta categoría como XML
Booleano accept(String tag)
Devuelve si este elemento acepta el nombre de código proporcionado; las clases hijo pueden alterarlo temporalmente
Serie getEditHref()
Descubre el URL al que se envía información de entrada actualizada mediante el Protocolo de publicación Atom
ibm_atom.io.atom.Feed

Este objeto representa el elemento de canal de información Atom y amplía ibm_atom.io.atom.AtomItem. Las variables heredadas y las funciones correspondientes pueden encontrarse aquí.

Funciones del objeto
Serie toString()
Devuelve una serie que representa esta categoría como XML
Booleano accept(String tag)
Devuelve si este elemento acepta el nombre de código proporcionado; las clases hijo pueden alterarlo temporalmente
void addNamespace(String fullName, String shortName)
Añade el espacio de nombres dado a este canal de información
void addEntry(ibm_atom.io.atom.Entry Entry)
Añade la entrada dada a esta representación de objeto del canal de información Atom. Esta función no envía datos al servidor.
ibm_atom.io.atom.Entry getFirstEntry()
Recupera la primera entrada de este canal de información Atom
ibm_atom.io.atom.Entry getEntry(String entryId)
Recupera la entrada identificada por la serie de ID dada
Número removeEntry(ibm_atom.io.atom.Entry entry)
Elimina la entrada dada del canal de información y devuelve el número de entradas eliminadas
void setEntries(Array arrayOfEntry)
Añade las entradas contenidas en la matriz dada a este canal de información Atom
ibm_atom.io.atom.Entry createEntry()
Crea un nuevo objeto de entrada vacío, establece su variable feedUrl y devuelve el objeto de entrada
Serie getSelfHref()
Obtiene el URL de este canal de información Atom, o devuelve un valor nulo si el canal de información no incluye el objeto de enlace correspondiente
ibm_atom.io.atom.Service

Un documento de servicio Atom describe los servicios que ofrece un servidor que implementa el Protocolo de publicación Atom. Este objeto representa este tipo de documento.

Variables del objeto
Serie href El URL del documento de servicio

Funciones del objeto
void buildFromDom(DOMNode node)
Compila el documento de servicio a partir de un DOMNode dado
Matriz getCollection(String url)
Recupera una matriz de todas las colecciones identificadas por el URL dado
ibm_atom.io.atom.Workspace

Un elemento de espacio de trabajo Atom es un componente de un documento de servicio Atom, tal como se define en la especificación del Protocolo de publicación Atom, y se utiliza en la organización del documento de servicio.

Variables del objeto
Serie título El título de este espacio de trabajo
Matriz collections Las colecciones que aloja este espacio de trabajo

Funciones del objeto
void buildFromDom(DOMNode node)
Compila este objeto de espacio de trabajo a partir de un DOMNode dado
ibm_atom.io.atom.Collection

Una colección Atom describe un conjunto de recursos a los que se puede acceder desde un URL dado y que se identifican con un título.

Variables del objeto
Serie href El URL de esta colección
Serie título El título de esta colección
Matriz attributes Los atributos de esta colección
Matriz features Las características de esta colección
Matriz children Los hijos de esta colección; por ejemplo, los elementos <accept> o <category>
Serie memberType El tipo de miembro de esta colección
Serie id La serie de ID de esta colección

Funciones del objeto
void buildFromDom(DOMNode node)
Compila este objeto de colección a partir de un DOMNode dado

Objeto AtomIO

El objeto AtomIO está diseñado para proporcionar una interfaz fácil de utilizar para que los desarrolladores puedan empezar rápidamente a interactuar con un canal de información Atom o una implementación de servidor APP (Protocolo de publicación Atom). Este objeto no mantiene un objeto de canal de información ni las variables internas entre llamadas. Si un desarrollador intenta mantener una representación local de un canal de información (consulte canal de información más arriba) sincronizado con la copia de servidor, es su responsabilidad.

Variables del objeto
Booleano sync Determina si las peticiones de este objeto AtomIO se fuerzan para que sean síncronas
Booleano useCache Determina si se debe desactivar la memoria caché (en las peticiones XHR)
Booleano alertsEnabled Determina si se deben mostrar recuadros de alerta en los errores de ES o desactivarse en silencio

Funciones del objeto
void getFeed(String url, Function callback, Function errorCallback, Object scope)
Recupera un canal de información Atom específico del URL dado
void getService(String url, Function callback, Function errorCallback, Object scope)
Recupera un documento de servicio o introspección del URL dado
void getEntry(String url, Function callback, Function errorCallback, Object scope)
Recupera un documento de entrada Atom específico del URL dado
void updateEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean retrieveUpdated, Boolean xmethod, Object scope)
Actualiza la entrada remota utilizando la entrada dada, adaptando la petición según los parámetros dados
void addEntry(ibm_atom.io.atom.Entry entry, String url, Function callback, Function errorCallback, Boolean retrieveUpdated, Object scope)
Añade una nueva entrada al URL de colección dado, basándose en los parámetros proporcionados
void deleteEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean xmethod, Object scope)
Suprime la entrada Atom especificada de la colección

Detalles de las funciones
getFeed

getService

getEntry

updateEntry

addEntry

deleteEntry