ehcache-core 2.10.9.2 · net.sf.ehcache.search.Attribute

Modifier and Type	Field and Description
private final String	attributeName

Access	Constructor and Description
public	Attribute(String the name of search attribute attributeName) Construct a new attribute instance.

Method Summary

Modifier and Type	Method and Description
public Aggregator	Returns: average aggregator average() Request an average value aggregation of this attribute
public Criteria	Returns: criteria instance between(T the minimum value in the range min, T the maximum value in the range max) Create a range criteria between the given min/max (inclusive).
public Criteria	Returns: criteria instance between(T the minimum value in the range min, T the maximum value in the range max, boolean is the minimum inclusive in the range minInclusive, boolean is the maximum inclusive in the range maxInclusive) Create a range criteria between the given min/max with specified inclusiveness
public Aggregator	Returns: count aggregator count() Request a count aggregation of this attribute
public Criteria	Returns: criteria instance eq(T value) Create a criteria where this attribute is equal to the given value
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Criteria	Returns: criteria instance ge(T value) Create a criteria where this attribute is greater than or equal to the given value
public String	Returns: the attribute name getAttributeName() Get the attribute name
public Criteria	Returns: criteria instance gt(T value) Create a criteria where this attribute is greater than the given value
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public Criteria	Returns: criteria instance ilike(String regex) Create a criteria where this attribute's toString() matches the given expression See `net.sf.ehcache.search.expression.ILike` for the expression syntax
public Criteria	Returns: criteria instance in(Collection<? extends T> values) Create a criteria where this attribute is 'in' (ie.
public Criteria	Returns: criteria instance isNull() Create a criteria that requires no value for this attribute
public Criteria	Returns: criteria instance le(T value) Create a criteria where this attribute is less than or equal to the given value
public Criteria	Returns: criteria instance lt(T value) Create a criteria where this attribute is less than the given value
public Aggregator	Returns: max aggregator max() Request a maximum value aggregation of this attribute
public Aggregator	Returns: min aggregator min() Request a minimum value aggregation of this attribute
public Criteria	Returns: criteria instance ne(T value) Create a criteria where this attribute is not equal to the given value
public Criteria	Returns: criteria instance notIlike(String regex) Create a criteria where this attribute's toString() does not match the given expression See `net.sf.ehcache.search.expression.ILike` for the expression syntax
public Criteria	Returns: criteria instance notNull() Create a criteria that accepts any non-null value for this attribute
public Aggregator	Returns: sum aggregator sum() Request a sum aggregation of this attribute
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

attributeName	back to summary
private final String attributeName

Attribute	back to summary
public Attribute(String attributeName) Construct a new attribute instance. Instances are normally obtained from a specific `net.sf.ehcache.Cache` however Parameters attributeName:String the name of search attribute

Method Detail

average	back to summary
public Aggregator average() Request an average value aggregation of this attribute Returns:Aggregator average aggregator

average

back to summary

public Aggregator average()

Request an average value aggregation of this attribute

Returns:Aggregator: average aggregator

between back to summary

between	back to summary
public Criteria between(T min, T max) Create a range criteria between the given min/max (inclusive). This is the same as calling `between(min, max, true, true)` Parameters min:T the minimum value in the range max:T the maximum value in the range Returns:Criteria criteria instance

public Criteria between(T min, T max)

Create a range criteria between the given min/max (inclusive). This is the same as calling between(min, max, true, true)

Parameters

min:T: the minimum value in the range
max:T: the maximum value in the range

Returns:Criteria

criteria instance

between	back to summary
public Criteria between(T min, T max, boolean minInclusive, boolean maxInclusive) Create a range criteria between the given min/max with specified inclusiveness Parameters min:T the minimum value in the range max:T the maximum value in the range minInclusive:boolean is the minimum inclusive in the range maxInclusive:boolean is the maximum inclusive in the range Returns:Criteria criteria instance

between

back to summary

public Criteria between(T min, T max, boolean minInclusive, boolean maxInclusive)

Create a range criteria between the given min/max with specified inclusiveness

Parameters

min:T: the minimum value in the range
max:T: the maximum value in the range
minInclusive:boolean: is the minimum inclusive in the range
maxInclusive:boolean: is the maximum inclusive in the range

Returns:Criteria

criteria instance

count	back to summary
public Aggregator count() Request a count aggregation of this attribute Returns:Aggregator count aggregator

count

back to summary

public Aggregator count()

Request a count aggregation of this attribute

Returns:Aggregator: count aggregator

eq	back to summary
public Criteria eq(T value) Create a criteria where this attribute is equal to the given value Returns:Criteria criteria instance

back to summary

public Criteria eq(T value)

Create a criteria where this attribute is equal to the given value

Returns:Criteria: criteria instance

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

ge	back to summary
public Criteria ge(T value) Create a criteria where this attribute is greater than or equal to the given value Returns:Criteria criteria instance

back to summary

public Criteria ge(T value)

Create a criteria where this attribute is greater than or equal to the given value

Returns:Criteria: criteria instance

getAttributeName	back to summary
public String getAttributeName() Get the attribute name Returns:String the attribute name

getAttributeName

back to summary

public String getAttributeName()

Get the attribute name

Returns:String: the attribute name

gt	back to summary
public Criteria gt(T value) Create a criteria where this attribute is greater than the given value Returns:Criteria criteria instance

back to summary

public Criteria gt(T value)

Create a criteria where this attribute is greater than the given value

Returns:Criteria: criteria instance

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

ilike back to summary

ilike	back to summary
public Criteria ilike(String regex) Create a criteria where this attribute's toString() matches the given expression See `net.sf.ehcache.search.expression.ILike` for the expression syntax Returns:Criteria criteria instance

public Criteria ilike(String regex)

Create a criteria where this attribute's toString() matches the given expression See net.sf.ehcache.search.expression.ILike for the expression syntax

Returns:Criteria: criteria instance

in back to summary

in	back to summary
public Criteria in(Collection<? extends T> values) Create a criteria where this attribute is 'in' (ie. contained within) the given collection of values. With the exception of very small collections a `java.util.Set` should perform better here to get constant time `contains()` checks Returns:Criteria criteria instance

public Criteria in(Collection<? extends T> values)

Create a criteria where this attribute is 'in' (ie. contained within) the given collection of values. With the exception of very small collections a java.util.Set should perform better here to get constant time contains() checks

Returns:Criteria: criteria instance

isNull	back to summary
public Criteria isNull() Create a criteria that requires no value for this attribute Returns:Criteria criteria instance

isNull

back to summary

public Criteria isNull()

Create a criteria that requires no value for this attribute

Returns:Criteria: criteria instance

le	back to summary
public Criteria le(T value) Create a criteria where this attribute is less than or equal to the given value Returns:Criteria criteria instance

back to summary

public Criteria le(T value)

Create a criteria where this attribute is less than or equal to the given value

Returns:Criteria: criteria instance

lt	back to summary
public Criteria lt(T value) Create a criteria where this attribute is less than the given value Returns:Criteria criteria instance

back to summary

public Criteria lt(T value)

Create a criteria where this attribute is less than the given value

Returns:Criteria: criteria instance

max	back to summary
public Aggregator max() Request a maximum value aggregation of this attribute Returns:Aggregator max aggregator

max

back to summary

public Aggregator max()

Request a maximum value aggregation of this attribute

Returns:Aggregator: max aggregator

min	back to summary
public Aggregator min() Request a minimum value aggregation of this attribute Returns:Aggregator min aggregator

min

back to summary

public Aggregator min()

Request a minimum value aggregation of this attribute

Returns:Aggregator: min aggregator

ne	back to summary
public Criteria ne(T value) Create a criteria where this attribute is not equal to the given value Returns:Criteria criteria instance

back to summary

public Criteria ne(T value)

Create a criteria where this attribute is not equal to the given value

Returns:Criteria: criteria instance

notIlike back to summary

notIlike	back to summary
public Criteria notIlike(String regex) Create a criteria where this attribute's toString() does not match the given expression See `net.sf.ehcache.search.expression.ILike` for the expression syntax Returns:Criteria criteria instance

public Criteria notIlike(String regex)

Create a criteria where this attribute's toString() does not match the given expression See net.sf.ehcache.search.expression.ILike for the expression syntax

Returns:Criteria: criteria instance

notNull	back to summary
public Criteria notNull() Create a criteria that accepts any non-null value for this attribute Returns:Criteria criteria instance

notNull

back to summary

public Criteria notNull()

Create a criteria that accepts any non-null value for this attribute

Returns:Criteria: criteria instance

sum	back to summary
public Aggregator sum() Request a sum aggregation of this attribute Returns:Aggregator sum aggregator

sum

back to summary

public Aggregator sum()

Request a sum aggregation of this attribute

Returns:Aggregator: sum aggregator

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class Attribute<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail