Enum as Hibernate Parameter Namedquery

Question

Is there any way to pass as a parameter in a NamedQuery the value of Enum.

public enum TipoConta{
   CREDITO("Cartao de Credito"), DEBITO("Cartao de Debito");
   private final String descricao;

   TipoConta(String descricao) {
    this.descricao = descricao;
   }

   @Query("SELECT g FROM Gasto g WHERE g.transacao.tipo.nome = TipoConta.DEBITO.descricao")
   List<Gasto> findAllGastos();
}

This is an example of what I would like to do, in my code I need to pass as a condition, and I pass a description. But I wouldn’t want to leave like hard code in Query, and pass a constant of a Enum, so I just change the Enum and changes in all Query.

Answer 1

You can pass parameters to a named query the same way it passes to any JPA query.

Using standard JPA, prepare the query to receive the parameter:

@NamedQuery(
    name="findAllGastos",
    queryString="SELECT g FROM Gasto g WHERE g.transacao.tipo.nome = :tipoConta")

And to consume it:

Query query = em.createNamedQuery("findAllGastos");
query.setParameter("tipoConta", TipoConta.DEBITO.descricao);

And using Spring (your case):

@Query("SELECT g FROM Gasto g WHERE g.transacao.tipo.nome = :tipoConta")
List<Gasto> findAllGastos(@Param("tipoConta") String tipoConta);

Maybe these parameter names aren’t legal because where we’re saying "type" we are actually wanting to receive the "description of the account type"; and we are comparing this "description" with a "name" (Expense.transacao.type.name). Consider refactoring this.

One last tip - don’t post complex business methods on an Enum. Try to use Enum for what it proposes: group constants cohesively and strongly typed.

Answer 2

I don’t know if I understand you very well.

Change your Enum to constants, because Annotation does not allow receiving instance parameters. As quoted in that and in that issue of the OS.

public enum TipoConta{

    // Troque seu enum para constantes, pois annotation não permite receber parâmetros de instância
    public final static String CREDITO = "Cartao de Credito";
    public final static String DEBITO = "Cartao de Debito";
}

And in query:

// concatene a query a valor do enum (Você também pode parametrizar que é mais adequedo, eficiente e seguro)
@Query("SELECT g FROM Gasto g WHERE g.transacao.tipo.nome = " + TipoConta.DEBITO)
List<Gasto> findAllGastos();