在p:dataTable过滤器中显式使用隐式JSF转换器javax.faces.convert.EnumConverter

时间:2015-10-26 05:58:19

标签: jsf primefaces datatable enums converter

Enum:

public enum OrderStatus {

    New("New"),
    Paid("Paid"),
    Shipped("Shipped"),
    Completed("Completed");

    private final String label;

    private OrderStatus(String label) {
        this.label = label;
    }

    public String getLabel() {
        return label;
    }
}

enum过滤器中使用<p:dataTable>类型,如下所示。

<p:dataTable var="row"
             value="#{testBacking}"
             lazy="true"
             rows="10"
             widgetVar="dataTableUIWidget">

    <p:column id="id" headerText="Id">
        <h:outputText value="#{row.orderId}"/>
    </p:column>

    <p:column headerText="Order Status" filterBy="#{row.orderStatus}">
        <f:facet name="filter">
            <p:selectOneMenu onchange="PF('dataTableUIWidget').filter();">
                <f:selectItem itemLabel="Select" itemValue=""/>

                <f:selectItems var="orderStatus"
                               value="#{enumBean.orderStatus}" 
                               itemLabel="#{orderStatus.label}"/>
            </p:selectOneMenu>
        </f:facet>

        <h:outputText value="#{row.orderStatus}"/>
    </p:column>
</p:dataTable>

row.orderStatus是其关联JPA实体中上述enum的一种类型。

<p:selectOneMenu>关联的过滤器需要明确指定javax.faces.convert.EnumConverter,因为它的值没有绑定到支持bean属性(否则适当的转换器会自行隐式地发挥其作用)基于关联的支持bean中的属性类型。)

我希望提到转换器如下

<f:converter converterId="javax.faces.Enum"/>

应该像其他隐式转换器一样工作。

然而,这会导致问题(如上所述指定<f:converter>时)。

  

严重:JSF1006:无法实例化javax.faces.Enum类型的转换器

此转换器有什么问题?我正在寻找一个可行的解决方案。

使用PrimeFaces 5.2 final / Mojarra 2.2.12。

其他:

converterjavax.faces.Enum指定为converterId

public class EnumConverter implements Converter, PartialStateHolder {

    public static final String CONVERTER_ID = "javax.faces.Enum";
    public static final String ENUM_ID = "javax.faces.converter.EnumConverter.ENUM";
    public static final String ENUM_NO_CLASS_ID = "javax.faces.converter.EnumConverter.ENUM_NO_CLASS";
    private Class<? extends Enum> targetClass;
    private boolean isTransient;
    private boolean initialState;

    public EnumConverter() {}
}

因此,这可以通过将javax.faces.Enum指定为convertId <f:converter>作为其他隐式JSF转换器来实现。

上述测试用例中使用的bean(完全可选择进行同行评审):

@Named
@ViewScoped
public class TestBacking extends LazyDataModel<OrderTable> implements Serializable {

    @Inject
    private OrderService orderService;
    private static final long serialVersionUID = 1L;

    public TestBacking() {}

    @Override
    public List<OrderTable> load(int first, int pageSize, String sortField, SortOrder sortOrder, Map<String, Object> filters) {

        if (MapUtils.isNotEmpty(filters)) { // Debugging purpose only.
            System.out.println("Enum filter : " + (filters.get("orderStatus") instanceof OrderStatus));
            System.out.println("Filter value : " + filters.get("orderStatus"));
        }

        int rowCount = MapUtils.isNotEmpty(filters) ? orderService.rowCount(filters).intValue() : orderService.rowCount().intValue();
        setRowCount(rowCount);

        return orderService.getList(first, pageSize, null, filters);
    }
}

stdout方法中的load()语句显示以下输出。

Enum filter : false
Filter value : New

filters.get("orderStatus") instanceof OrderStatus显然返回false,因为过滤器组件<p:selectOneMenu>未通过转换器。它只返回String而无需转换。)

1 个答案:

答案 0 :(得分:7)

EnumConverter是一个特殊的转换器,只能用Class<E>作为参数构造(最终设置为targetClass)。没有它,转换器就不会起作用。遗憾的是,它并不适用于所有枚举(即它实际上不是&#34;通用枚举转换器&#34;)。 在那里你假设对枚举进行隐式/自动转换,它实际上是由EL强制完成的,而不是由JSF EnumConverter完成的。只要目标类型可以解析为枚举,EL就确实支持枚举。

要明确使用JSF枚举转换器,您基本上需要像下面那样扩展EnumConverter以将目标枚举传递给c&#tor;(无需覆盖getAsString/Object()方法):

@FacesConverter(value="orderStatusConverter")
public class OrderStatusConverter extends EnumConverter {

    public OrderStatusConverter() {
        super(OrderStatus.class);
    }

}

然后引用它:

<f:converter converterId="orderStatusConverter" />

不要忘记将<f:selectItem itemValue="">改为itemValue="#{null}",否则ClassCastExceptionjava.lang.String

如果您碰巧使用OmniFaces,您也可以使用generic enum converter代替:

<f:converter converterId="omnifaces.GenericEnumConverter" />