Pasta de trabalho: Demonstração das ferramentas do esquema XML do NetBeans Enterprise Pack 5.5

Você pode usar este documento como uma pasta de trabalho para reproduzir as ações demonstradas na Demonstração das ferramentas do esquema XML do NetBeans Enterprise Pack 5.5.

Para obter mais informações sobre como trabalhar com o NetBeans IDE, consulte a página de Documentação no site do NetBeans.

superior

Criando o projeto WebApplication

Geralmente, o esquema XML é usado para definir os tipos usados em um serviço da Web, assim, você estará usando um projeto da Web para conter seus documentos.

Observação: Esta etapa não é mostrada na demonstração.

1. No IDE, escolha Arquivo > Novo projeto.
2. Na lista Categorias, selecione o nó Web.
3. Na lista Projetos, selecione Aplicativo da Web e clique em Próximo.
4. Na página Nome e local, no campo Nome do projeto, insira WebApplication e especifique o local do projeto.
5. Aceite todos os outros valores e configurações padrão e clique em Finalizar.
   A janela Projetos agora contém um nó de projeto rotulado WebApplication e o arquivo index.jsp é aberto no editor de fontes.
6. No Editor de fontes, feche o arquivo index.jsp.

superior

Adicionando o arquivo do esquema XML do courier

Comece criando um documento do esquema XML que definirá um serviço de entrega de pacotes.

1. Abra o projeto WebApplication no IDE.
2. Na janela Projetos, expanda o nó do projeto WebApplication.
3. Selecione o nó Pacotes de origem, clique com o botão direito do mouse e escolha Novo > Arquivo/Pasta.
   O assistente para Novo arquivo se abre.
4. Na página Escolher tipo de arquivo, na lista Categorias, selecione o nó XML, em seguida, na lista Tipos de arquivo, selecione Esquema XML e clique em Próximo.
5. Na página Nome e local do assistente, no campo Nome do arquivo, digite courier.
6. Aceite os outros valores padrão e clique em Finalizar.
   O novo arquivo, courier.xsd, é aberto na exibição Esquema do editor do esquema XML.
7. Maximize a exibição Esquema clicando com o botão direito do mouse na guia do arquivo e escolhendo Maximizar janela no menu pop-up.
   Ao maximizar a exibição, você pode ver mais informações sobre o esquema.

superior

Preenchendo o arquivo do esquema XML do courier

A exibição Design permite que você preencha rapidamente um esquema, sem precisar saber os detalhes complexos de como o esquema XML é definido.

1. Na exibição Esquema, clique no botão Design para alternar para a exibição Design.
   Observação: Caso você não veja a janela Paleta, no menu principal do IDE, escolha Janela > Paleta.
2. Adicione um tipo global complexo nomeado CourierType executando o seguinte procedimento:
   
   1. Na seção Componentes do esquema XML da Paleta, clique no ícone Tipo complexo e arraste-o para o nó Tipos complexos na área de design do esquema.
   2. Digite CourierType e pressione Enter.
3. Adicione um elemento chamado nome ao tipo complexo CourierType executando o seguinte procedimento:
   
   1. Na seção Componentes do XML da Paleta, clique no ícone Elemento e arraste-o para o tipo complexo CourierType.
      Observe que o IDE adiciona automaticamente um componente Seqüência.
   2. Digite nome e pressione Enter.
4. Adicione mais dois elementos (startDate e veículo) ao tipo complexo CourierType executando o seguinte procedimento:
   
   1. Na seção Componentes do XML da Paleta, clique no ícone Elemento e arraste-o para o tipo complexo courierType.
   2. Digite startDate e pressione Enter.
   3. Na seção Componentes do XML da Paleta, clique no ícone Elemento e arraste-o para o tipo complexo courierType.
   4. Digite veículo e pressione Enter.
5. Adicione dois atributos (primeiro e último) ao elemento nome realizando o seguinte procedimento:
   
   1. Na seção Componentes do XML da Paleta, clique no ícone Atributo e arraste-o para o elemento nome.
   2. Digite primeiro e pressione Enter.
   3. Na seção Componentes do XML da Paleta, clique no ícone Atributo e arraste-o para o elemento nome.
   4. Digite último e pressione Enter.

superior

Alterando o componente do esquema startDate

Você pode procurar componentes do esquema XML por nome, valor de atributo e até mesmo usar expressões regulares. O IDE destaca os resultados da pesquisa para facilitar a navegação.

1. Na exibição Design, clique no botão Esquema para alternar para a exibição Esquema.
2. Na exibição Esquema, clique no botão de árvore para alternar para o modo de árvore na exibição.
3. Clique no botão Localizar da barra de ferramentas.
   Você também pode escolher Editar > Localizar no menu principal do IDE ou pressionar Ctrl-F.
   A barra Localizar é exibida na parte inferior da exibição Esquema.
4. Clique na caixa Localizar, digite startDate e pressione Enter.
   O IDE seleciona a primeira ocorrência correspondente (quando ela aparece na origem).
5. Feche a barra Localizar clicando no ícone do "x" vermelho na barra Localizar.
6. Na exibição Esquema, clique com o botão direito do mouse no nó startDate e escolha Personalizar no menu pop-up.
   A caixa de diálogo Personalizador de elemento local é aberta.
7. Em Tipo, selecione o botão de opção Usar tipo existente e, na lista, expanda o nó Tipos incorporados, selecione data e clique em OK.

superior

Adicionando o componente do esquema do courier na exibição Esquema

Assim como na exibição Design, você pode facilmente criar novos componentes do esquema na exibição Esquema.

1. No modo de árvore da exibição Esquema, selecione o nó Elementos, clique com o botão direito do mouse e escolha Adicionar elemento no menu pop-up.
   A caixa de diálogo Elemento se abre.
2. No campo Nome, digite courier.
3. Em Tipo, selecione o botão de opção Usar tipo existente e, na lista, expanda o nó Tipos complexos.
4. Selecione CourierType e clique em OK.

superior

Recuperando recursos externos

Geralmente, é mais fácil reutilizar um esquema XML existente disponível na Internet. Neste exemplo, você irá recuperar o esquema UBL Order, definido pela organização OASIS.

Observação: Se você quiser explorar esta seção off-line, deve fazer download do Java WSDP.

1. Se a janela Saída não estiver visível, escolha Janela > Saída.
   Quando o IDE recupera os recursos, mensagens informativas são exibidas na janela Saída.
2. Na janela Projetos, expanda o nó do projeto WebApplication e expanda o nó Pacotes de origem.
3. Selecione o nó Pacotes de origem, clique com o botão direito do mouse e escolha Novo > Arquivo/Pasta.
4. Na caixa de diálogo Novo arquivo, em Categorias, selecione o nó XML e, na lista Tipos de arquivo, selecione Documento do esquema XML externo.
5. Clique em Próximo.
   A página Nova recuperação de documentos se abre.
6. Na página Especificar local do recurso, adote o seguinte procedimento:
   
   1. Selecione o botão de opção Do URL.
   2. No campo de texto abaixo do botão de opção Do URL, digite http://docs.oasis-open.org/ubl/cd-UBL-1.0/xsd/maindoc/UBL-Order-1.0.xsd
      Neste exemplo, você está recuperando um esquema UBL de amostra, incluído no Java WSDP Versão 2.0, diretamente de um URL.
   3. Aceite o valor padrão para o campo Salvar na pasta e clique em Finalizar.
   Observe as informações exibidas na janela Saída. O IDE mostra quais arquivos estão sendo copiados para as pastas do projeto e se houver erros, eles serão exibidos na janela Saída.
7. Feche a janela Saída clicando no botão Fechar na barra de título da janela.

superior

Referenciando esquemas externos

Você agora irá adicionar uma importação para fazer referência aos arquivos do esquema externo que acabou de recuperar.

1. Na exibição Esquema do arquivo courier.xsd, selecione o nó Esquemas referenciados, clique com o botão direito do mouse e escolha Adicionar > Importação.
   A caixa de diálogo Importação se abre.
2. Na lista Local, expanda o nó Por espaço de nome, em seguida, expanda o nó urn:oasis:names:specification:ubl:schema:xsd:Order-1.0 e selecione o nó UBL-Order-1.0.xsd.
   O campo Espaço de nome abaixo da lista Local é preenchido pelo IDE e contém o seguinte valor: urn:oasis:names:specification:ubl:schema:xsd:Order-1.0.
3. No campo Novo prefixo, digite order e clique em OK.
   O IDE adiciona a importação ao arquivo do esquema.

superior

Adicionando o componente do esquema da entrega na exibição Esquema

Você agora irá adicionar outro elemento que define seu próprio tipo complexo aninhado.

1. Na exibição Esquema, selecione o nó Elementos, clique com o botão direito do mouse e escolha Adicionar elemento no menu pop-up.
   A caixa de diálogo Elemento se abre.
2. No campo Nome, digite entrega.
3. Em Tipo, selecione o botão de opção Tipo complexo in-line e clique em OK.

superior

Adicionando referências de elementos

Um elemento pode constituir-se de referências a outros elementos, mesmo que tenham sido definidos em outros documentos do esquema.

1. Na exibição Esquema, selecione e clique com o botão direito do mouse no nó entrega e escolha Adicionar > Referência do elemento no menu pop-up.
   A caixa de diálogo Referência do elemento é aberta.
2. Expanda o nó Esquemas referenciados > nó importação > nó Elementos.
3. Selecione o nó Order e clique em OK.
   O IDE adicionou a referência do elemento. Ele possui o seguinte rótulo: Nó Order [1..1](->).
4. Na exibição Esquema, selecione e clique com o botão direito do mouse no nó entrega e escolha Adicionar > Referência do elemento no menu pop-up.
   A caixa de diálogo Referência do elemento é aberta.
5. Expanda o nó Elementos.
6. Selecione o nó courier (instância de CourierType) e clique em OK.
   A nova referência de elemento é adicionada ao esquema. Seu rótulo é courier [1..1](->).

superior

Localizando usos de um componente de esquema

Para ver onde um determinado componente do esquema é definido, use o comando Ir para > Definição. Use também a função Localizar usos para localizar todos os usos do componente do esquema Order no arquivo do esquema UBL-Order-1.0.xsd.

1. Selecione e clique com o botão direito do mouse no nó Order [1..1](->) e escolha Ir para > Definição.
   O IDE abre o UBL-Order-1.0.xsd no editor do esquema XML e realça o elemento Order nesse arquivo do esquema.
2. Clique com o botão direito do mouse no nó Order na exibição Esquema do arquivo UBL-Order-1.0.xsd e escolha Localizar usos.
   A janela Usos de XML se abre na parte inferior do IDE.
3. No painel da árvore da janela Usos do XML (o painel esquerdo), clique duas vezes no nó (Elemento local) ....
   O IDE navega até a exibição Fonte do arquivo courier.xsd e realça a primeira linha do bloco de definição da referência de elemento.
4. Feche a janela Usos de XML clicando no botão Fechar na barra de títulos da janela.

superior

Aplicando um padrão de design

Você agora usará o assistente para Padrão de design para transformar o arquivo do esquema XML.

1. Na janela Projetos, selecione e clique com o botão direito do mouse no nó courier.xsd e escolha Aplicar padrão de design no menu pop-up.
   A caixa de diálogo Aplicar padrão de design se abre.
2. Em Tipo, selecione o botão de opção Não criar tipo(s) e clique em Finalizar.
   Isso aplica o padrão Fatia de salame ao arquivo do esquema.

superior

Salvando o seu trabalho

Você agora salvará o seu trabalho antes de passar para a próxima parte desta pasta de trabalho.

• Clique no botão Salvar todos da barra de ferramentas.
  Você também pode escolher Arquivo > Salvar todos no menu principal do IDE.

superior

Adicionando o arquivo do documento XML da entrega

Para ver como um esquema é usado, adicione um arquivo de documento limitado por esquema XML nomeado entrega ao seu projeto.

1. Na janela Projetos, expanda o nó do projeto WebApplication.
2. Expanda o nó Pacotes de origem, clique com o botão direito do mouse no nó <pacote padrão> e escolha Novo > Arquivo/Pasta.
   O assistente para Novo arquivo se abre.
3. Na página Escolher tipo de arquivo, na lista Categorias, selecione o nó XML e, na lista Tipos de arquivo, selecione Documento XML e clique em Próximo.
4. Na página Nome e local, no campo Nome do arquivo, digite entrega.
5. Aceite os outros valores padrão e clique em Próximo.
6. Na página Selecionar tipo de documento, selecione o botão de opção Documento limitado por esquema XML e clique em Próximo.
7. Na página Opções de esquema, clique no botão Explorar ao lado do campo URI do esquema.
8. Navegue até o caminho-do-projeto\WebApplication\src\java, selecione courier.xsd e clique em OK.
   O IDE preencheu os campos da página Opções de esquema.
9. Na lista suspensa Elemento raiz, selecione entrega.
10. Clique em Finalizar.
    O Editor de fontes agora possui uma guia para o arquivo delivery.xml e essa guia é a guia ativa.

superior

Usando conclusão de código

Conforme digita no editor de fontes, o IDE solicita que você escolha entre os atributos e os elementos disponíveis do esquema. Isso poupa o seu tempo e reduz a probabilidade de erros tipográficos.

1. No Editor de fontes do arquivo delivery.xml, posicione o cursor acima da linha </delivery>.
2. Digite um < (sinal menor que).
   A caixa de conclusão de código se abre.
3. Selecione courier e pressione Enter.
4. Digite o colchete de fechamento (>).
5. Selecione </courier> na caixa de conclusão de código e pressione Enter.
6. Posicione o cursor entre as marcas <courier> e </courier> e pressione Enter para inserir uma linha.
7. Digite um < (sinal menor que).
   A caixa de conclusão de código se abre.
8. Selecione nome e pressione Enter.
9. Pressione a barra de espaços.
   A caixa de conclusão de código agora é aberta com a lista de atributos definidos como nome.
10. Selecione primeiro e pressione Enter.
11. Pressione a barra de espaços.
    A caixa de conclusão de código se abre com a lista de atributos definidos como nome.
12. Selecione último e pressione Enter.
13. Digite /> (barra inclinada seguida por um sinal de maior que) para fechar a definição.
14. Clique no botão Salvar todos da barra de ferramentas.
    Você também pode escolher Arquivo > Salvar todos no menu principal do IDE.

superior

Adicionando o arquivo WSDL da agenda

O esquema XML geralmente é usado por serviços da Web. Você agora usará o assistente para Novo arquivo WSDL para criar um serviço da Web baseado no arquivo do esquema XML.

1. Na janela Projetos, expanda o nó do projeto WebApplication.
2. Selecione o nó Páginas da Web, clique com o botão direito do mouse e escolha Novo > Arquivo/Pasta.
   O assistente para Novo arquivo se abre.
3. Na página Escolher tipo de arquivo, na lista Categorias, selecione o nó Serviços da Web e, em seguida, na lista Tipos de arquivo, selecione WSDL e clique em Próximo.
4. Na página Nome e local, no campo Nome do arquivo, digite agenda.
5. Marque a caixa de seleção Importar arquivo(s) do esquema XML e clique no botão Explorar para selecionar src/java/courier.xsd.
6. Clique em Próximo.
   A página Configuração abstrata é aberta.
7. Em Entrada, na coluna Nome da parte da mensagem, altere parte1 para data e pressione Enter.
8. Em Entrada na coluna Elemento ou tipo, clique no botão de reticências.
   A caixa de diálogo Selecionar elemento ou tipo é aberta.
9. Expanda o nó Tipos de esquema incorporados, selecione o nó data e clique em OK.
   O tipo agora é xsd:data.
10. Em Saída, na coluna Nome da parte da mensagem, altere parte1 para confirmada e pressione Enter.
11. Clique em Finalizar.
    O Editor de fontes agora possui uma guia para o arquivo schedule.wsdl e essa guia é a guia ativa. A exibição WSDL é a exibição ativa no Editor WSDL.

superior

Fazendo referência a um arquivo do esquema XML no arquivo WSDL da agenda

Usando elementos definidos no esquema XML, você pode criar novas partes para as mensagens WSDL, especificando não somente tipos incorporados, mas também os definidos em arquivos importados.

1. No menu principal do IDE, escolha Janela > Propriedades para abrir a janela Propriedades.
2. Na exibição WSDL, no nó Mensagens, selecione scheduleOperationRequest, clique com o botão direito do mouse e escolha Adicionar > Parte no menu pop-up.
   O IDE adiciona um subnó chamado parte1.
3. Selecione o novo nó parte1 e na janela Propriedades, adote o seguinte procedimento:
   
   1. Altere a propriedade Nome para cliente.
   2. Na propriedade Elemento ou tipo, clique no botão de reticências.
      A caixa de diálogo Elemento ou tipo - [Parte] do cliente é aberta.
   3. Expanda o nó Tipos de esquema incorporados e, no nó Tipos incorporados, selecione o nó seqüência e clique em OK.
      O tipo agora é xsd:seqüência.
4. Na exibição WSDL, no nó Mensagens, selecione scheduleOperationReply, clique com o botão direito do mouse e escolha Adicionar > Parte no menu pop-up.
   O IDE adiciona um subnó chamado parte1.
5. Selecione o novo nó parte1 e na janela Propriedades, adote o seguinte procedimento:
   
   1. Altere a propriedade Nome para courier.
   2. Na propriedade Elemento ou tipo, clique no botão de reticências.
      A caixa de diálogo Elemento ou tipo - [Parte] do courier é aberta.
   3. Expanda os nós Tipos de esquema in-line > http://j2ee.netbeans.org/wsdl/schedule > Esquemas referenciados > importação > Elementos.
   4. Selecione o nó courier e clique em OK.
      O tipo agora é ns1:courier.

superior

Usando a validação

Para garantir que o seu documento esteja de acordo com o padrão definido, você pode validar o arquivo e verificar a existência de avisos ou erros. No caso de que algum problema fosse encontrado, a saída forneceria hyperlinks diretamente para a linha de erro no editor de fontes.

• Clique no botão Validar XML .
  Os resultados da validação aparecem na janela Saída.

superior

Mais documentação

• Introdução às ferramentas do esquema XML fornece links para um conjunto de tutoriais que o orientam através da funcionalidade das ferramentas do esquema XML.
• Tutoriais, guias e artigos do NetBeans IDE 5.5 fornece uma lista completa dos tutoriais e artigos da versão NetBeans 5.5 e as versões do Mobility Pack e do Enterprise Pack que o acompanham.
• http://www.w3.org/XML/Schema fornece acesso às especificações do esquema XML.

superior