程序包 org.hibernate.criterion

类 Example

java.lang.Object

org.hibernate.criterion.Example

所有已实现的接口:

Serializable, Criterion

public class Example
extends Object
implements Criterion

Support for query by example.

 List results = session.createCriteria(Parent.class)
     .add( Example.create(parent).ignoreCase() )
     .createCriteria("child")
         .add( Example.create( parent.getChild() ) )
     .list();
 

"Examples" may be mixed and matched with "Expressions" in the same Criteria.

作者:

Gavin King

另请参阅:

Criteria, 序列化表格

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	Example.AllPropertySelector	Property selector that includes all properties
static class	Example.NotNullOrZeroPropertySelector	Property selector that includes only properties that are not null and non-zero (if numeric)
static class	Example.NotNullPropertySelector	Property selector that includes only properties that are not null
static interface	Example.PropertySelector	A strategy for choosing property values for inclusion in the query criteria.

构造器概要

构造器

限定符	构造器	说明
protected	Example(Object exampleEntity, Example.PropertySelector selector)	Allow subclasses to instantiate as needed.

方法概要

修饰符和类型	方法	说明
protected void	addComponentTypedValues(String path, Object component, CompositeType type, List<TypedValue> list, Criteria criteria, CriteriaQuery criteriaQuery)
protected void	addPropertyTypedValue(Object value, Type type, List<TypedValue> list)
protected void	appendComponentCondition(String path, Object component, CompositeType type, Criteria criteria, CriteriaQuery criteriaQuery, StringBuilder buf)
protected void	appendPropertyCondition(String propertyName, Object propertyValue, Criteria criteria, CriteriaQuery cq, StringBuilder buf)
static Example	create(Object exampleEntity)	Create a new Example criterion instance, which includes all non-null properties by default
Example	enableLike()	Use the "like" operator for all string-valued properties.
Example	enableLike(MatchMode matchMode)	Use the "like" operator for all string-valued properties
Example	excludeNone()	Include all properties.
Example	excludeProperty(String name)	Exclude a particular property by name.
Example	excludeZeroes()	Exclude zero-valued properties.
TypedValue[]	getTypedValues(Criteria criteria, CriteriaQuery criteriaQuery)	Return typed values for all parameters in the rendered SQL fragment
Example	ignoreCase()	Ignore case for all string-valued properties
Example	setEscapeCharacter(Character escapeCharacter)	Set escape character for "like" clause if like matching was enabled
Example	setPropertySelector(Example.PropertySelector selector)	Set the property selector to use.
String	toSqlString(Criteria criteria, CriteriaQuery criteriaQuery)	Render the SQL fragment
String	toString()

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

Example

protected Example(Object exampleEntity,
                  Example.PropertySelector selector)

Allow subclasses to instantiate as needed.

参数:

exampleEntity - The example bean

selector - The property selector to use

方法详细资料

create

public static Example create(Object exampleEntity)

Create a new Example criterion instance, which includes all non-null properties by default

参数:

exampleEntity - The example bean to use.

返回:

a new instance of Example

setEscapeCharacter

public Example setEscapeCharacter(Character escapeCharacter)

Set escape character for "like" clause if like matching was enabled

参数:

escapeCharacter - The escape character

返回:

this, for method chaining

另请参阅:

enableLike()

enableLike

public Example enableLike()

Use the "like" operator for all string-valued properties. This form implicitly uses MatchMode.EXACT

返回:

this, for method chaining

enableLike

public Example enableLike(MatchMode matchMode)

Use the "like" operator for all string-valued properties

参数:

matchMode - The match mode to use.

返回:

this, for method chaining

ignoreCase

public Example ignoreCase()

Ignore case for all string-valued properties

返回:

this, for method chaining

setPropertySelector

public Example setPropertySelector(Example.PropertySelector selector)

Set the property selector to use. The property selector operates separately from excluding a property.

参数:

selector - The selector to use

返回:

this, for method chaining

另请参阅:

excludeProperty(java.lang.String)

excludeZeroes

public Example excludeZeroes()

Exclude zero-valued properties. Equivalent to calling setPropertySelector(org.hibernate.criterion.Example.PropertySelector) passing in Example.NotNullOrZeroPropertySelector.INSTANCE

返回:

this, for method chaining

另请参阅:

setPropertySelector(org.hibernate.criterion.Example.PropertySelector)

excludeNone

public Example excludeNone()

Include all properties. Equivalent to calling setPropertySelector(org.hibernate.criterion.Example.PropertySelector) passing in Example.AllPropertySelector.INSTANCE

返回:

this, for method chaining

另请参阅:

setPropertySelector(org.hibernate.criterion.Example.PropertySelector)

excludeProperty

public Example excludeProperty(String name)

Exclude a particular property by name.

参数:

name - The name of the property to exclude

返回:

this, for method chaining

另请参阅:

setPropertySelector(org.hibernate.criterion.Example.PropertySelector)

toSqlString

public String toSqlString(Criteria criteria,
                          CriteriaQuery criteriaQuery)

从接口复制的说明: Criterion

Render the SQL fragment

指定者:

toSqlString 在接口中 Criterion

参数:

criteria - The local criteria

criteriaQuery - The overall criteria query

返回:

The generated SQL fragment

getTypedValues

public TypedValue[] getTypedValues(Criteria criteria,
                                   CriteriaQuery criteriaQuery)

从接口复制的说明: Criterion

Return typed values for all parameters in the rendered SQL fragment

指定者:

getTypedValues 在接口中 Criterion

参数:

criteria - The local criteria

criteriaQuery - The overall criteria query

返回:

The types values (for binding)

addPropertyTypedValue

protected void addPropertyTypedValue(Object value,
                                     Type type,
                                     List<TypedValue> list)

addComponentTypedValues

protected void addComponentTypedValues(String path,
                                       Object component,
                                       CompositeType type,
                                       List<TypedValue> list,
                                       Criteria criteria,
                                       CriteriaQuery criteriaQuery)

appendPropertyCondition

protected void appendPropertyCondition(String propertyName,
                                       Object propertyValue,
                                       Criteria criteria,
                                       CriteriaQuery cq,
                                       StringBuilder buf)

appendComponentCondition

protected void appendComponentCondition(String path,
                                        Object component,
                                        CompositeType type,
                                        Criteria criteria,
                                        CriteriaQuery criteriaQuery,
                                        StringBuilder buf)

toString

public String toString()

覆盖:

toString 在类中 Object