GeneralFilter (common-josql 3.6.15 API)

java.lang.Object
- com.gentlyweb.utils.GeneralFilter

public class GeneralFilter
extends Object

字段概要

字段
限定符和类型	字段和说明
`static int`	`CONTAINS`
`static int`	`ENDS_WITH`
`static int`	`EQUALS`
`static int`	`GREATER_THAN`
`static int`	`KEYS`
`static int`	`LESS_THAN`
`static int`	`NOT_CONTAINS`
`static int`	`NOT_EQUALS`
`static int`	`STARTS_WITH`
`static int`	`VALUES`

构造器概要

构造器
构造器和说明

GeneralFilter(Class c)

构造器
构造器和说明
`GeneralFilter(Class c)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`accept(Object o)`
`void`	`addField(String field, boolean value, int type)` Add a new field for a boolean comparison.
`void`	`addField(String field, Date max, Date min)` Add a new field to check for the date to be in the specified range.
`void`	`addField(String field, Date value, int type)` Add a new field for a Date comparison.
`void`	`addField(String field, double max, double min)` Add a new field for a number range comparison.
`void`	`addField(String field, double value, int type)`
`void`	`addField(String field, Object object, Comparator comp, int type)`
`void`	`addField(String field, Object object, int type)`
`void`	`addField(String field, String value, int type)`
`Collection`	`filter(Collection collection)`
`void`	`filter(Collection collection, Collection newCollection)`
`List`	`filter(List list)`
`void`	`filter(List list, List newList)`
`void`	`filter(List list, Set newSet)`
`Map`	`filter(Map map, int type)`
`void`	`filter(Map map, int type, Map newMap)`
`Object[]`	`filter(Object[] objects)`
`Set`	`filter(Set set)`
`void`	`filter(Set set, List newList)`
`void`	`filter(Set set, Set newSet)`
`SortedMap`	`filter(SortedMap map, int type)`
`SortedSet`	`filter(SortedSet set)`
`void`	`filterAndRemove(Collection col)` Cycle over the Collection and filter given our fields directly from the passed in Set.
`void`	`filterAndRemove(List list)`
`void`	`filterAndRemove(Map map, int type)`
`void`	`filterAndRemove(Set set)` Cycle over the Set and filter given our fields directly from the passed in Set.
`Class`	`getFilterClass()` Get the class that we are filtering.
`boolean`	`getNullAcceptPolicy()` Get the null accept policy, this governs what happens when a null is observed from the result of an accessor chain call, `true` indicates that the value is accepted, `false` indicates that it is rejected.
`void`	`setFieldValue(String field, boolean value)` Set a new value for the specified boolean filter field.
`void`	`setFieldValue(String field, Date value)` Set a new date value for the specified date filter field.
`void`	`setFieldValue(String field, Date max, Date min)` Set new date range values for the specified date filter field.
`void`	`setFieldValue(String field, double value)` Set new maximum and minimum values for the specified number filter field.
`void`	`setFieldValue(String field, double max, double min)` Set new maximum and minimum values for the specified number filter field.
`void`	`setFieldValue(String field, Object value)` Set the value for the specified field.
`void`	`setFieldValue(String field, String value)` Set the value for the specified String filter field.
`void`	`setNullAcceptPolicy(boolean policy)`
`String`	`toString()` Output the filter fields as a String suitable for debugging.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料
- EQUALS
```
public static final int EQUALS
```
  另请参阅:
  
  常量字段值
- NOT_EQUALS
```
public static final int NOT_EQUALS
```
  另请参阅:
  
  常量字段值
- GREATER_THAN
```
public static final int GREATER_THAN
```
  另请参阅:
  
  常量字段值
- LESS_THAN
```
public static final int LESS_THAN
```
  另请参阅:
  
  常量字段值
- CONTAINS
```
public static final int CONTAINS
```
  另请参阅:
  
  常量字段值
- NOT_CONTAINS
```
public static final int NOT_CONTAINS
```
  另请参阅:
  
  常量字段值
- STARTS_WITH
```
public static final int STARTS_WITH
```
  另请参阅:
  
  常量字段值
- ENDS_WITH
```
public static final int ENDS_WITH
```
  另请参阅:
  
  常量字段值
- KEYS
```
public static final int KEYS
```
  另请参阅:
  
  常量字段值
- VALUES
```
public static final int VALUES
```
  另请参阅:
  
  常量字段值

构造器详细资料
- GeneralFilter
```
public GeneralFilter(Class c)
```

方法详细资料

setNullAcceptPolicy

public void setNullAcceptPolicy(boolean policy)

getNullAcceptPolicy
```
public boolean getNullAcceptPolicy()
```
Get the null accept policy, this governs what happens when a null is observed from the result of an accessor chain call, true indicates that the value is accepted, false indicates that it is rejected.

返回:

The policy.

addField
```
public void addField(String field,
                     Date max,
                     Date min)
              throws IllegalArgumentException
```
Add a new field to check for the date to be in the specified range.

参数:

field - The field spec.

max - The upper date.

min - The lower date.

抛出:

IllegalArgumentException - If the field spec is not valid for the class set in the constructor.

setFieldValue

public void setFieldValue(String field,
                          Date max,
                          Date min)
                   throws IllegalArgumentException

Set new date range values for the specified date filter field.

参数:: field - The field spec.; max - The upper date.; min - The lower date.
抛出:: IllegalArgumentException - If we can't find the specified field.

addField
```
public void addField(String field,
                     Date value,
                     int type)
              throws IllegalArgumentException
```
Add a new field for a Date comparison. Note: the only supported types for ths method are: GeneralFilter.EQUALS, GeneralFilter.NOT_EQUALS, GeneralFilter.LESS_THAN, GeneralFilter.GREATER_THAN.

参数:

field - The field spec.

value - The Date to check against.

type - The type, see above for valid values.

抛出:

IllegalArgumentException - If the field spec is not valid for the class set in the constructor. Or if you pass in an invalid type for this method.

setFieldValue
```
public void setFieldValue(String field,
                          Date value)
                   throws IllegalArgumentException
```
Set a new date value for the specified date filter field.

参数:

field - The field spec.

value - The new value.

抛出:

IllegalArgumentException - If we can't find the specified field.

addField
```
public void addField(String field,
                     boolean value,
                     int type)
              throws IllegalArgumentException
```
Add a new field for a boolean comparison. Note: the only supported types for ths method are: GeneralFilter.EQUALS, GeneralFilter.NOT_EQUALS.

参数:

field - The field spec.

value - The Date to check against.

type - The type, see above for valid values.

抛出:

IllegalArgumentException - If the field spec is not valid for the class set in the constructor. Or if you pass in an invalid type for this method.

setFieldValue
```
public void setFieldValue(String field,
                          boolean value)
                   throws IllegalArgumentException
```
Set a new value for the specified boolean filter field.

参数:

field - The field spec.

value - The new value.

抛出:

IllegalArgumentException - If we can't find the specified field.

addField

public void addField(String field,
                     double value,
                     int type)
              throws IllegalArgumentException

抛出:: IllegalArgumentException

setFieldValue
```
public void setFieldValue(String field,
                          double value)
                   throws IllegalArgumentException
```
Set new maximum and minimum values for the specified number filter field.

参数:

field - The field spec.

value - The new value.

抛出:

IllegalArgumentException - If we can't find the specified field.

addField
```
public void addField(String field,
                     double max,
                     double min)
```
Add a new field for a number range comparison. Even though you should pass in a double ANY number can be checked for, regardless of primitive type. The checking is such that if the value equals one of the values (max or min) then we find a match.

参数:

field - The field spec.

max - The maximum value to check against.

min - The minimum value to check against.

抛出:

IllegalArgumentException - If the field spec is not valid for the class set in the constructor.

setFieldValue
```
public void setFieldValue(String field,
                          double max,
                          double min)
                   throws IllegalArgumentException
```
Set new maximum and minimum values for the specified number filter field.

参数:

field - The field spec.

max - The new maximum to check against.

min - The new minimum to check against.

抛出:

IllegalArgumentException - If we can't find the specified field.

addField

public void addField(String field,
                     String value,
                     int type)
              throws IllegalArgumentException

抛出:: IllegalArgumentException

setFieldValue
```
public void setFieldValue(String field,
                          String value)
                   throws IllegalArgumentException
```
Set the value for the specified String filter field.

参数:

field - The field spec.

value - The value to compare against.

抛出:

IllegalArgumentException - If we can't find the specified field.

addField

public void addField(String field,
                     Object object,
                     int type)
              throws IllegalArgumentException

抛出:: IllegalArgumentException

setFieldValue
```
public void setFieldValue(String field,
                          Object value)
                   throws IllegalArgumentException
```
Set the value for the specified field.

参数:

field - The field spec.

value - The value to compare against.

抛出:

IllegalArgumentException - If we can't find the specified field.

addField

public void addField(String field,
                     Object object,
                     Comparator comp,
                     int type)
              throws IllegalArgumentException

抛出:: IllegalArgumentException

getFilterClass
```
public Class getFilterClass()
```
Get the class that we are filtering.

返回:

The Class.

accept

public boolean accept(Object o)
               throws IllegalAccessException,
                      InvocationTargetException,
                      FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public void filter(Set set,
                   Set newSet)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public void filter(Set set,
                   List newList)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public void filter(List list,
                   Set newSet)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public void filter(Map map,
                   int type,
                   Map newMap)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public void filter(Collection collection,
                   Collection newCollection)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public void filter(List list,
                   List newList)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public Object[] filter(Object[] objects)
                throws IllegalAccessException,
                       InvocationTargetException,
                       FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public Map filter(Map map,
                  int type)
           throws IllegalAccessException,
                  InvocationTargetException,
                  FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public SortedMap filter(SortedMap map,
                        int type)
                 throws IllegalAccessException,
                        InvocationTargetException,
                        FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public Collection filter(Collection collection)
                  throws IllegalAccessException,
                         InvocationTargetException,
                         FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public Set filter(Set set)
           throws IllegalAccessException,
                  InvocationTargetException,
                  FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public SortedSet filter(SortedSet set)
                 throws IllegalAccessException,
                        InvocationTargetException,
                        FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filter

public List filter(List list)
            throws IllegalAccessException,
                   InvocationTargetException,
                   FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filterAndRemove

public void filterAndRemove(List list)
                     throws IllegalAccessException,
                            InvocationTargetException,
                            FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

filterAndRemove
```
public void filterAndRemove(Collection col)
                     throws IllegalAccessException,
                            InvocationTargetException,
                            FilterException
```
Cycle over the Collection and filter given our fields directly from the passed in Set. The filtered objects are removed from the passed Collection.

参数:

col - The Collection to filter.

抛出:

InvocationTargetException - If we cannot execute the associated Accessor chain and get the value.

IllegalAccessException - If we cannot execute the associated Accessor chain because of a security violation.

FilterException - Thrown if the return type is not what is expected from the field type, for example if we are checking a java.utli.Date but the returned type is NOT of type java.util.Date.

filterAndRemove
```
public void filterAndRemove(Set set)
                     throws IllegalAccessException,
                            InvocationTargetException,
                            FilterException
```
Cycle over the Set and filter given our fields directly from the passed in Set. The filtered objects are removed from the passed Set.

参数:

set - The Set to filter.

抛出:

InvocationTargetException - If we cannot execute the associated Accessor chain and get the value.

IllegalAccessException - If we cannot execute the associated Accessor chain because of a security violation.

FilterException - Thrown if the return type is not what is expected from the field type, for example if we are checking a java.utli.Date but the returned type is NOT of type java.util.Date.

filterAndRemove

public void filterAndRemove(Map map,
                            int type)
                     throws IllegalAccessException,
                            InvocationTargetException,
                            FilterException

抛出:: IllegalAccessException; InvocationTargetException; FilterException

toString
```
public String toString()
```
Output the filter fields as a String suitable for debugging.

覆盖:

toString 在类中 Object

类 GeneralFilter

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

EQUALS

NOT_EQUALS

GREATER_THAN

LESS_THAN

CONTAINS

NOT_CONTAINS

STARTS_WITH

ENDS_WITH

KEYS

VALUES

构造器详细资料

GeneralFilter

方法详细资料

setNullAcceptPolicy

getNullAcceptPolicy

addField

setFieldValue

addField

setFieldValue

addField

setFieldValue

addField

setFieldValue

addField

setFieldValue

addField

setFieldValue

addField

setFieldValue

addField

getFilterClass

accept

filter

filter

filter

filter

filter

filter

filter

filter

filter

filter

filter

filter

filter

filterAndRemove

filterAndRemove

filterAndRemove

filterAndRemove

toString