SpringSide3 PropertyFilter介绍

PropertyFilter是SpringSide框架中封装的一个类，可在页面中简单定义filter_EQS_name,filter_LIKES_NAME_OR_LOGIN_NAME的请求参数，可通过HibernateWebUtils的 buildPropertyFilter(ServletRequest)函数快速构造出PropertiyFilter列表并传递到 HibernateDAO的search(List<PropertyFilter>)方法中，整个过程非常自动化，无需太多的特定编码，filter的命名规则也一目了然。其中比较类型可选 EQ(=), LIKE(模糊匹配), LT(<), GT(>), LE(<=), GE(>=);

比较值类型可选S(String.class), I(Integer.class), L(Long.class), N(Double.class), D(Date.class),B(Boolean.class);

如果要同时比较多个属性，属性名之间用_OR_分隔。

源码如下：

/**

 * Copyright (c) 2005-2009 springside.org.cn

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * 

 * $Id: PropertyFilter.java 873 2010-01-18 16:38:24Z calvinxiu $

 */

package org.springside.modules.orm;

import java.util.Date;

import org.apache.commons.lang.StringUtils;

import org.springframework.util.Assert;

import org.springside.modules.utils.ReflectionUtils;

/**

 * 与具体ORM实现无关的属性过滤条件封装类.

 * 

 * PropertyFilter主要记录页面中简单的搜索过滤条件,比Hibernate的Criterion要简单.

 * 

 * @author calvin

 */

public class PropertyFilter {

/** 多个属性间OR关系的分隔符. */

public static final String OR_SEPARATOR = "_OR_";

/** 属性比较类型. */

public enum MatchType {

EQ, LIKE, LT, GT, LE, GE;

}

/** 属性数据类型. */

public enum PropertyType {

S(String.class), I(Integer.class), L(Long.class), N(Double.class), D(Date.class), B(Boolean.class);

private Class<?> clazz;

PropertyType(Class<?> clazz) {

this.clazz = clazz;

}

public Class<?> getValue() {

return clazz;

}

}

private String[] propertyNames = null;

private Class<?> propertyType = null;

private Object propertyValue = null;

private MatchType matchType = null;

public PropertyFilter() {

}

/**

* @param filterName 比较属性字符串,含待比较的比较类型、属性值类型及属性列表. 

*                   eg. LIKES_NAME_OR_LOGIN_NAME

* @param value 待比较的值.

*/

public PropertyFilter(final String filterName, final String value) {

String matchTypeStr = StringUtils.substringBefore(filterName, "_");

String matchTypeCode = StringUtils.substring(matchTypeStr, 0, matchTypeStr.length() - 1);

String propertyTypeCode = StringUtils.substring(matchTypeStr, matchTypeStr.length() - 1, matchTypeStr.length());

try {

matchType = Enum.valueOf(MatchType.class, matchTypeCode);

} catch (RuntimeException e) {

throw new IllegalArgumentException("filter名称" + filterName + "没有按规则编写,无法得到属性比较类型.", e);

}

try {

propertyType = Enum.valueOf(PropertyType.class, propertyTypeCode).getValue();

} catch (RuntimeException e) {

throw new IllegalArgumentException("filter名称" + filterName + "没有按规则编写,无法得到属性值类型.", e);

}

String propertyNameStr = StringUtils.substringAfter(filterName, "_");

propertyNames = StringUtils.split(propertyNameStr, PropertyFilter.OR_SEPARATOR);

Assert.isTrue(propertyNames.length > 0, "filter名称" + filterName + "没有按规则编写,无法得到属性名称.");

//按entity property中的类型将字符串转化为实际类型.

this.propertyValue = ReflectionUtils.convertStringToObject(value, propertyType);

}

/**

* 是否比较多个属性.

*/

public boolean isMultiProperty() {

return (propertyNames.length > 1);

}

/**

* 获取比较属性名称列表.

*/

public String[] getPropertyNames() {

return propertyNames;

}

/**

* 获取唯一的比较属性名称.

*/

public String getPropertyName() {

if (propertyNames.length > 1) {

throw new IllegalArgumentException("There are not only one property");

}

return propertyNames[0];

}

/**

* 获取比较值.

*/

public Object getPropertyValue() {

return propertyValue;

}

/**

* 获取比较值的类型.

*/

public Class<?> getPropertyType() {

return propertyType;

}

/**

* 获取比较方式类型.

*/

public MatchType getMatchType() {

return matchType;

}

}