Extensões IBM para o Dojo Toolkit

Biblioteca Atom, Armazém de Dados e Widgets

Referência de Biblioteca Atom:

A biblioteca Atom está amplamente dividida em três categorias: funções de utilitário, o modelo de dados Atom e o objeto AtomIO.


Funções de Utilitário
Resumo das Funções
String createDate(DOMNode node)
Cria uma data a partir do conteúdo do texto do nó de um DOM
String escapeHtml(String str)
Utiliza escape para caracteres especiais XML em uma cadeia HTML
String unEscapeHtml(String str)
Utiliza unescape para caracteres especiais XML em uma cadeia HTML
Date getIso8601Date(String iso8601String)
Converte uma cadeia de data ISO-8610 em um objeto de data
String dateToIso8601String(Date date, String offset)
Converte um objeto de data em uma cadeia ISO-8610
String getNodename(DOMNode node)
Obtém um nome de nó

Detalhes das Funções
createDate

escapeHtml

unEscapeHtml

getIso8601Date

dateToIso8601String

getNodename

Modelo de Dados Atom

Para uma referência de qualquer elemento Atom, consulte a especificação Atom, localizada aqui.

Visão Geral do Componente
ibm_atom.io.atom.AtomItem Elemento Atom genérico. Classe-base para Entry e Feed.
ibm_atom.io.atom.Category Elemento de categoria Atom
ibm_atom.io.atom.Content Elemento de conteúdo Atom. Manipula vários tipos (texto, html, etc.) de acordo com a especificação Atom. Utilizado para conteúdo, resumos e títulos.
ibm_atom.io.atom.Link Elemento de link Atom. Manipula vários tipos de links (edição, alt, etc.)
ibm_atom.io.atom.Person Elemento de pessoa Atom. Utilizado para representar autores e contribuidores.
ibm_atom.io.atom.Generator Elemento de gerador Atom
ibm_atom.io.atom.Entry Elemento de entrada Atom. Representa uma entrada Atom, inclusive armazenando os autores, contribuidores, título, conteúdo, etc.
ibm_atom.io.atom.Feed Elemento de feed Atom. Representa um Feed Atom, inclusive os elementos feed, como o título e autor, além de representar a lista de entradas.
ibm_atom.io.atom.Service Elemento de serviço Atom
ibm_atom.io.atom.Workspace Elemento de espaço de trabalho Atom
ibm_atom.io.atom.Collection Elemento de coleta Atom

Detalhes do Componente
ibm_atom.io.atom.AtomItem

Geralmente não utilizada independentemente, a classe AtomItem é a classe-base para objetos feed e entry Atom, uma vez que eles compartilham alguns componentes comuns (título, subtítulo, ícone, matrizes de autores, contribuidores e links).

Variáveis de Objetos
String ATOM_URI O URI do espaço de nomes Atom
Array links Armazena vários objetos ibm_atom.io.atom.Link dos links associados a esse item Atom
Array authors Armazena os objetos ibm_atom.io.atom.Person dos autores
Array categories Armazena os objetos ibm_atom.io.atom.Category associados a esse item Atom
Array contributors Armazena os objetos ibm_atom.io.atom.Person dos contribuidores
String icon A URL para o ícone desse item
String id O ID desse item
String logo A URL para o logotipo desse item
String rights Os direitos associados a esse item Atom
ibm_atom.io.atom.Content cargo O título desse item
ibm_atom.io.atom.Content subtitle O subtítulo desse item
Date updated A data em que esse item foi atualizado
ibm_atom.io.atom.Content content O conteúdo desse item
Array entradas Matriz de objetos ibm_atom.io.atom.Entry para esse item

Funções de Objetos
Booleano accept(String tag)
Retorna se esse item aceita o nome de tag especificado. Substituído pelas classes-filha
void _postBuild()
Função executada após a conclusão de buildFromDom. Os objetos-filho podem substituir essa função, se necessário, para incluir funcionalidade após a conclusão da construção.
void buildFromDom(DOMNode node)
Constrói esse AtomItem a partir de um DOMNode especificado.
void addAuthor(String name, String email, String uri)
Inclui um autor nesse item com as informações especificadas
void addContributor(String name, String email, String uri)
Inclui um contribuidor nesse item com as informações especificadas
void addCategory(String name, String term, String label)
Inclui uma categoria nesse item com as informações especificadas
void addLink(String href, String rel, String hrefLang, String title, String type)
Inclui um link com os atributos especificados nesse item
Number removeLink(String href, String rel)
Remove o link especificado desse item, retornando o número de links removidos
Number removeBasicLinks()
Remove todos os links básicos (links sem o atributo rel) desse item, retornando o número de links removidos
Array getCategories(String scheme)
Obtém todas as categorias correspondentes ao esquema especificado para esse item e as retorna em uma matriz
Number removeCategories(String scheme, String term)
Remove todas as categorias correspondentes ao esquema especificado, retornando o número de categorias removidas.
void setTitle(String str, String type)
Configura o título desse item para a str especificada com o tipo especificado.
void addExtension(String name_space, String name, Array attributes, String content, String shortNS)
Inclui em uma extensão o espaço de nomes no item.
Array getExtensions(String name_space, String name)
Obtém todas as extensões correspondentes ao name_space e name especificados e as retorna em uma matriz. name_space pode ser o espaço de nomes completo (como 'http://www.w3.org/2005/Atom') ou o nome abreviado especificado (como 'atom')
void removeExtensions(String name_space, String name)
Remove todas as extensões correspondentes ao name_space e name especificados
void destroy()
Exclui todas as variáveis associadas a esse item
ibm_atom.io.atom.Category

Esse objeto representa o elemento Category da especificação Atom. Cada entradas e feed pode ter elementos de categoria para transportar informações sobre a entrada ou o feed.

Variáveis de Objetos
String scheme O esquema para essa categoria
String term O termo para essa categoria
String label O rótulo para essa categoria

Funções de Objetos
Booleano accept(String tag)
Sempre retorna false, uma vez que as categorias não possuem elementos-filho.
void _postBuild()
Função executada após a conclusão de buildFromDom. Os objetos-filho podem substituir essa função, se necessário, para incluir funcionalidade após a conclusão da construção.
String toString()
Retorna uma cadeia representando essa categoria como XML
void buildFromDom(DOMNode node)
Cria essa categoria a partir do nó XML especificado
ibm_atom.io.atom.Content

Esse objeto modela um objeto de conteúdo genérico, que é utilizado na especificação Atom como título, subtítulos, conteúdo e resumo. Um objeto de conteúdo pode ter vários tipos, além de seu valor.

Variáveis de Objetos
String tagName O nome desse elemento, tal como conteúdo, resumo, etc
String valor O valor desse elemento
String src A URL que contém o valor desse elemento
String type O tipo de conteúdo armazenado nesse elemento. Os valores aceitáveis são listados a seguir.
String xmlLang O idioma do conteúdo. Esse idioma será incluído na saída se este elemento for colocado em uma cadeia.
String HTML Uma cadeia representando o tipo HTML
String TEXT Uma cadeia representando o tipo texto
String XHTML Uma cadeia representando o tipo XHTML
String XML Uma cadeia representando o tipo XML

Funções de Objetos
void _postBuild()
Função executada após a conclusão de buildFromDom. Os objetos-filho podem substituir essa função, se necessário, para incluir funcionalidade após a conclusão da construção.
void buildFromDom(DOMNode node)
Constrói esse objeto de conteúdo a partir de um DOMNode especificado.
String toString()
Retorna uma cadeia representando essa categoria como XML.
ibm_atom.io.atom.Link

Esse objeto representa o elemento de link Atom.

Variáveis de Objetos
String href A URL para esse link
String hrefLang O atributo hrefLang
String rel O atributo rel, que descreve a relação desse link com o item-pai
String cargo O título desse link
String type O tipo de link

Funções de Objetos
void _postBuild()
Função executada após a conclusão de buildFromDom. Os objetos-filho podem substituir essa função, se necessário, para incluir funcionalidade após a conclusão da construção.
void buildFromDom(DOMNode node)
Constrói esse objeto de link a partir de um DOMNode especificado
String toString()
Retorna uma cadeia representando essa categoria como XML
ibm_atom.io.atom.Person

Esse objeto representa um objeto pessoal, que é utilizado para os tipos autor e contribuidor na especificação Atom. Um objeto pessoal pode ter um nome ou um endereço de e-mail ou URI, ou ambos.

Variáveis de Objetos
String personType O tipo de pessoa que esse objeto representa, geralmente autor ou contribuidor.
String name O nome de desse objeto pessoal
String email O endereço de e-mail dessa pessoa
String uri O URI dessa pessoa

Funções de Objetos
void _postBuild()
Função executada após a conclusão de buildFromDom. Os objetos-filho podem substituir essa função, se necessário, para incluir funcionalidade após a conclusão da construção.
void buildFromDom(DOMNode node)
Constrói esse objeto pessoal a partir de um DOMNode especificado
String toString()
Retorna uma cadeia representando essa categoria como XML
Booleano accept(String tag)
Retorna se esse item aceita o nome de tag especificado; substituído pelas classes-filha
ibm_atom.io.atom.Generator

Esse elemento Atom transporta informações sobre o pacote que gerou esse feed Atom. Um gerador pode ter um URI e um número de versão, além do nome legível pelo usuário.

Variáveis de Objetos
String uri O URI desse gerador
String versão O número de versão desse gerador
String valor O nome legível pelo usuário desse gerador

Funções de Objetos
void _postBuild()
Função executada após a conclusão de buildFromDom. Os objetos-filho podem substituir essa função, se necessário, para incluir funcionalidade após a conclusão da construção.
void buildFromDom(DOMNode node)
Constrói esse objeto de gerador a partir de um DOMNode especificado.
String toString()
Retorna uma cadeia representando essa categoria como XML.
ibm_atom.io.atom.Entry

Representando o elemento de entrada Atom, esse objeto estende ibm_atom.io.atom.AtomItem. As variáveis e funções herdadas apropriadas podem ser localizadas aqui.

Variáveis de Objetos
String feedUrl A URL do feed Atom que possui essa entrada

Funções de Objetos
String toString()
Retorna uma cadeia representando essa Categoria como XML
Booleano accept(String tag)
Retorna se esse item aceita o nome de tag especificado; substituído pelas classes-filha
String getEditHref()
Descobre a URL para enviar informações de entradas atualizadas por meio do Atom Publishing Protocol
ibm_atom.io.atom.Feed

Representando o elemento de feed Atom, esse objeto estende ibm_atom.io.atom.AtomItem. As variáveis e funções herdadas apropriadas podem ser localizadas aqui.

Funções de Objetos
String toString()
Retorna uma cadeia representando essa categoria como XML
Booleano accept(String tag)
Retorna se esse item aceita o nome de tag especificado; substituído pelas classes-filha
void addNamespace(String fullName, String shortName)
Inclui o espaço de nomes especificado nesse feed
void addEntry(ibm_atom.io.atom.Entry Entry)
Inclui a entrada especificada nessa representação de objeto do feed Atom. Essa função não envia dados para o servidor.
ibm_atom.io.atom.Entry getFirstEntry()
Recupera a primeira entrada desse feed Atom
ibm_atom.io.atom.Entry getEntry(String entryId)
Recupera a entrada identificada pela cadeia de ID especificada
Number removeEntry(ibm_atom.io.atom.Entry entry)
Remove a entrada especificada do feed, retornando o número de entradas removidas
void setEntries(Array arrayOfEntry)
Inclui as entradas contidas na matriz especificada nesse feed Atom
ibm_atom.io.atom.Entry createEntry()
Cria um novo objeto de entrada vazia, configura sua variável feedUrl e retorna o objeto de entrada
String getSelfHref()
Obtém a URL desse feed Atom ou retorna um valor nulo se o feed não incluir o objeto de link apropriado
ibm_atom.io.atom.Service

Um documento de serviço Atom descreve os serviços oferecidos por um servidor que está implementando o Atom Publishing Protocol. Este objeto representa esse tipo de documento.

Variáveis de Objetos
String href A URL para o documento de serviço

Funções de Objetos
void buildFromDom(DOMNode node)
Constrói esse documento de serviço a partir de um DOMNode especificado
Array getCollection(String url)
Recupera uma matriz de todas as coles identificadas pela URL especificada
ibm_atom.io.atom.Workspace

Um elemento de espaço de trabalho Atom faz parte de um documento de Serviço Atom, conforme definido pela especificação Atom Publishing Protocol, e destina-se à organização no documento de serviço.

Variáveis de Objetos
String cargo O título desse espaço de trabalho
Array collections As coletas armazenadas por esse espaço de trabalho

Funções de Objetos
void buildFromDom(DOMNode node)
Constrói esse objeto de espaço de trabalho a partir de um DOMNode especificado
ibm_atom.io.atom.Collection

Uma coleta Atom descreve um conjunto de recursos, acessíveis a partir de uma URL especificada, que são identificados por um título.

Variáveis de Objetos
String href A URL para essa coleta
String cargo O título dessa coleta
Array attributes Os atributos dessa coleta
Array features Os recursos dessa coleta
Array filhos Os filhos dessa coleta; por exemplo os elementos <accept> ou <category>
String memberType O tipo de membro dessa coleta
String id A cadeia de ID dessa coleta

Funções de Objetos
void buildFromDom(DOMNode node)
Constrói esse objeto de coleta a partir de um DOMNode especificado

Objeto AtomIO

O objeto AtomIO destina-se a fornecer uma interface fácil para os desenvolvedores iniciarem rapidamente a interfacear com uma implementação de feed Atom ou de servidor APP (Atom Publishing Protocol). Esse objeto não mantém um objeto Feed ou quaisquer variáveis internas entre as chamadas. Se um desenvolvedor estiver tentando manter uma representação local de um feed (consulte feed acima) sincronizada com a cópia do servidor, isso será responsabilidade dele.

Variáveis de Objetos
Booleano sínc Indica se deve-se forçar os pedidos desse objeto AtomIO para serem síncronos
Booleano useCache Indica se deve-se desativar o armazenamento em cache (nos pedidos XHR)
Booleano alertsEnabled Indica se deve-se exibir as caixas de alertas sobre erros de E/S ou apenas interromper silenciosamente

Funções de Objetos
void getFeed(String url, Function callback, Function errorCallback, Object scope)
Recupera um feed Atom específico a partir da URL especificada
void getService(String url, Function callback, Function errorCallback, Object scope)
Recupera um documento de serviço ou de introspecção a partir da URL especificada
void getEntry(String url, Function callback, Function errorCallback, Object scope)
Recupera um documento de entrada Atom específico a partir da URL especificada
void updateEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean retrieveUpdated, Boolean xmethod, Object scope)
Atualiza a entrada remota utilizando a entrada especificada, padronizando o pedido com base nos parâmetros especificados
void addEntry(ibm_atom.io.atom.Entry entry, String url, Function callback, Function errorCallback, Boolean retrieveUpdated, Object scope)
Inclui uma nova entrada na URL de coleta especificada, com base nos parâmetros especificados
void deleteEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean xmethod, Object scope)
Exclui a entrada Atom especificada de sua coleta

Detalhes das Funções
getFeed

getService

getEntry

updateEntry

addEntry

deleteEntry