Esfinge Query Builder - Persistência simples e rápida

Query Builder em 1 minuto

public interface PersonDAO extends Repository<Person>{
    public List<Person> getPersonByLastName(String lastname);
    public List<Person> getPersonByAddressCity(String city);
    public List<Person> getPersonByAgeGreater(Integer age);
}

PersonDAO dao = QueryBuilder.create(PersonDAO.class);

Como funciona?

Achou fácil? Saiba mais sobre os detalhes e as funcionalidades do QueryBuilder nas seções seguintes.

Configurando o Query Builder

Além disso ainda são necessárias outros JAR básicos para o acesso ao banco de dados, como o driver de conexão e a implementação JPA.

public class TestEntityManagerProvider implements EntityManagerProvider {
    @Override
    public EntityManager getEntityManager() {
        return getEntityManagerFactory().createEntityManager();
    }

    @Override
    public EntityManagerFactory getEntityManagerFactory() {
        return Persistence.createEntityManagerFactory("database_test");
    }
}

Para configurar essa nova classe criada, é preciso criar um arquivo chamado org.esfinge.querybuilder.jpa1.EntityManagerProvider no diretório META-INF/services de algum dos arquivos JAR da aplicação. Esse arquivo deve conter apenas o nome completo da classe criada.

Repositório

Abaixo seguem os métodos disponibilizados por essa interface com as respectivas descrições:

Nomeandos os Métodos

Os métodos devem começar com get e serem seguidos do nome da entidade. O nome utilizado deve ser o mesmo utilizado pelo JPA. Exemplo: List<Person> getPerson()
Para passar parâmetros para a consulta, o nome da entidade deve ser seguido por by e por nomes de propriedades da classe. O parâmetro deve ser do mesmo tipo da propriedade. Exemplo: Person getPersonByName(String name) e Person getPersonByLastName(String name)
Os métodos podem retornar uma instância da entidade ou uma lista de instâncias da entidade , como os dois exemplos anteriores apresentados.
O parâmetro passado pode navegar entre as dependências da classe e acessar propriedades delas. Exemplo: List<Person> getPersonByAddressCity(String city) , que filtraria a propriedade city na propriedade address.
Para passar mais de um parâmetro pode-se utilizar and ou or entre as propriedades. Os parâmetros serão considerados na mesma ordem definida no nome. Exemplo: Person getPersonByNameAndLastName(String name, String lastname) e List<Person> getPersonByNameOrLastName(String name, String lastname)

Outros Tipos de Comparação

List<Person> getPersonByAge(@Greater Integer age);

List<Person> getPersonByName(@Starts String name);

public List<Person> getPersonByAgeLesser(Integer age);

public List<Person> getPersonByLastNameNotEquals(String name);

public List<Person> getPersonByNameStartsAndAgeGreater(String name, Integer age);

Ordenação de Consultas

public List<Person> getPersonOrderByName();

public List<Person> getPersonByAgeOrderByNameDesc(@Greater Integer age);

public List<Person> getPersonOrderByNameAndLastName();

Query Objects

public class ExampleQueryObject {

    private Integer ageGreater;
    private Integer ageLesser;

    @Contains
    private String name;
    private String lastName;

    public Integer getAgeGreater() {
        return ageGreater;
    }
    public void setAgeGreater(Integer ageGreater) {
        this.ageGreater = ageGreater;
    }
    public Integer getAgeLesser() {
        return ageLesser;
    }
    public void setAgeLesser(Integer ageLesser) {
        this.ageLesser = ageLesser;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Contains
    public String getLastName() {
        return lastName;
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

}

Abaixo segue um exemplo de um método que utiliza a classe definida acima:

public List getPerson(@QueryObject ExampleQueryObject obj);