org.lavieri.modelutil.cep
Class WebServiceCep

java.lang.Object
  extended by org.lavieri.modelutil.cep.WebServiceCep

public final class WebServiceCep
extends java.lang.Object

Ferramenta de busca de CEP, veja o método searchCep(String) para maiores informações.

Constroi um objeto WebServiceCep com os dados XML encapsulados, a partir da chamada do método estatico searchCep(String).

Objeto contem todas as informações do XML, além de informações referente ao resultado da pesquisa.

Esta ferramente depende diretamente do pacote org.dom4j para fazer o parse dos arquivos XML. O pacote dom4j.jar pode ser encontrado em dom4j.org

Exemplo de uso:
WebServiceCep cep = WebServiceCep.searchCep("13345-325");
//caso a busca ocorra bem, imprime os resultados.
if (cep.wasSuccessful()) {
    System.out.println("Cep: "+cep.getCep());
    System.out.println("Logradouro: "+cep.getLogradouroFull());
    System.out.println("Bairro: "+cep.getBairro());
    System.out.println("Cidade: "+ cep.getCidade()+"/"+ cep.cep());
//caso haja problemas imprime o código e msg de erro.
} else {
    System.out.println("Erro número: " + cep.getResulCode());
    System.out.println("Descrição do erro: " + cep.getResultText());
}

A resposta do console seria:

Cep: 13345325
Logradouro: Rua Cinco
Bairro: Jardim Rêmulo Zoppi
Cidade: Indaiatuba/SP

Ultima revisão: 09/01/2009

Author:
Tomaz Lavieri

Method Summary
 java.lang.String getBairro()
          Informa o bairro
 java.lang.String getCep()
          Informa o cep.
 java.lang.String getCidade()
          Informa a cidade
 java.lang.Exception getException()
          Pega a exceção que ocorreu durante a busca, retorna null caso não haja exceções.
 java.lang.String getLogradouro()
          Informa o logradouro.
 java.lang.String getLogradouroFull()
          Informa o logradouro junto com o tipo de logradouro.
 java.lang.String getLogradouroType()
          Informa o tipo do logradouro.
 int getResulCode()
          Informa o código do resultado da pesquisa.
 java.lang.String getResultText()
          Informação textual sobre o resultado da pesquisa
 java.lang.String getUf()
          Informa a Unidade Federativa
 boolean hasException()
          Informa se houve falhas na busca do cep
 boolean isCepNotFound()
          Informa se não existe o cep cadastrado.
static WebServiceCep searchCep(java.lang.String cep)
          Faz uma busca a partir do cep enviado, no site republicavirtual.com.br, retornando o resultado em um objeto WebServiceCep.
 boolean wasSuccessful()
          Informa se o cep foi encontrado com sucesso.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

searchCep

public static WebServiceCep searchCep(java.lang.String cep)
Faz uma busca a partir do cep enviado, no site republicavirtual.com.br, retornando o resultado em um objeto WebServiceCep.

Não se faz necessário formatações, a string pode ser enviada em qualquer formatação, pois só serão consideradas os primeiros 8 numeros da string.
Por Exemplo:
Uma String "14.568-910" é automaticamente passada para "14568910".
Uma String "1%4#5?55%16a8&910" é automaticamente passada para "14555168", só levando em conta os primeiros 8 números.

Parameters:
cep - Número do cep a ser carregado. Só serão considerados os primeiros 8 números da String enviada. Todos os caracters não numéricos serão removidos, e a string será truncada caso seja maior que 8 caracters.
Returns:
WebServiceCep contendo as informações da pesquisa.

getResulCode

public int getResulCode()
Informa o código do resultado da pesquisa.
Códigos conhecidos:
-1 : busca não realizada
0 : cep não encontrado
1 : cep econtrado
-14 : Site não encontrado (pode ser por problemas na internet).
-15 : Não foi possivel ler o documento xml
-16 : Erro na formação da url
-17 : Erro inesperado

Returns:
int Código do resultado.

getResultText

public java.lang.String getResultText()
Informação textual sobre o resultado da pesquisa

Returns:
String contendo a descrição do resultado da pesquisa.

wasSuccessful

public boolean wasSuccessful()
Informa se o cep foi encontrado com sucesso.

Returns:
true - caso a pesquisa ache um resultado no banco.
false - caso haja falhas, ou o cep enviado não esteja cadastrado.

isCepNotFound

public boolean isCepNotFound()
Informa se não existe o cep cadastrado.

Returns:
true - Caso o cep não tenha cido encontrado.
false - Caso haja falhas, ou caso o cep esteja cadastrado.

hasException

public boolean hasException()
Informa se houve falhas na busca do cep

Returns:
true - Caso ocorra falhas
false - Caso não haja falhas.

getException

public java.lang.Exception getException()
Pega a exceção que ocorreu durante a busca, retorna null caso não haja exceções.

Returns:
Exception - Caso ocorra falhas
null - Caso não haja falhas.

getBairro

public java.lang.String getBairro()
Informa o bairro

Returns:
String contendo o nome bairro

getCidade

public java.lang.String getCidade()
Informa a cidade

Returns:
String contendo o nome da Cidade

getUf

public java.lang.String getUf()
Informa a Unidade Federativa

Returns:
String contendo o nome da Unidade Federativa

getLogradouro

public java.lang.String getLogradouro()
Informa o logradouro.

Returns:
String contendo o nome do Logradouro

getLogradouroFull

public java.lang.String getLogradouroFull()
Informa o logradouro junto com o tipo de logradouro.

Returns:
String contendo o tipo de Logradouro + nome do Logradouro.

getLogradouroType

public java.lang.String getLogradouroType()
Informa o tipo do logradouro.

Returns:
String contendo o tipo de logradouuro.

getCep

public java.lang.String getCep()
Informa o cep.

Returns:
String contendo o cep.