T
- the type of the value of this keypublic class ERXKey<T> extends Object
public class Person extends ERXGenericRecord {
...
public static final ERXKey<Country> country = new ERXKey<Country>(Person.COUNTRY_KEY);
public static final ERXKey<NSTimestamp> birthDate = new ERXKey<NSTimestamp>(Person.BIRTH_DATE_KEY);
...
}
Country germany = ...;
NSTimestamp someRandomDate = ...;
EOQualifier qualifier = Person.country.is(germany).and(Person.birthDate.after(someRandomDate));
Modifier and Type | Class and Description |
---|---|
static class |
ERXKey.Type
Enums to describe the type of key this represents.
|
static interface |
ERXKey.ValueCoding |
Constructor and Description |
---|
ERXKey(String key)
Constructs an ERXKey.
|
ERXKey(String key,
ERXKey.Type type)
Constructs an ERXKey, specifying what
ERXKey.Type it is. |
ERXKey(String key,
String locale)
Constructs a localized ERXKey.
|
ERXKey(String key,
String locale,
ERXKey.Type type)
Constructs a localized ERXKey, specifying what
ERXKey.Type it is. |
Modifier and Type | Method and Description |
---|---|
ERXKeyComparisonQualifier |
after(ERXKey<T> when)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorGreaterThan, value);
|
ERXKeyValueQualifier |
after(T when)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorGreaterThan, value);
|
<U> ERXKey<U> |
append(ERXKey<U> key)
Return a new ERXKey that appends the given key to this keypath.
|
<U> ERXKey<U> |
append(String key)
Return a new ERXKey that appends the given key to this keypath.
|
<U> ERXKey<NSArray<U>> |
appendAsArray(ERXKey<U> key)
Return a new ERXKey that appends the given key to this keypath.
|
NSArray<T> |
arrayValueInObject(Object obj)
Return the value of this keypath on the given object cast as an NSArray.
|
ERXSortOrdering |
asc()
Equivalent to ERXS.asc(key())
|
ERXSortOrdering |
ascInsensitive()
Equivalent to ERXS.ascInsensitive(key())
|
ERXSortOrdering.ERXSortOrderings |
ascInsensitives()
Equivalent to ERXS.ascInsensitives(key())
|
ERXSortOrdering.ERXSortOrderings |
ascs()
Equivalent to ERXS.ascs(key())
|
ERXKey<BigDecimal> |
atAvg()
Creates a new ERXKey that appends this key with NSArray's
@avg
aggregate operator |
ERXKey<BigDecimal> |
atAvg(ERXKey<?> key)
Creates a new ERXKey that appends this key with NSArray's
@avg
aggregate operator and then appends the given key . |
ERXKey<BigDecimal> |
atAvgNonNull()
Creates a new ERXKey that appends ERXArrayUtilities'
@avgNonNull
aggregate operator to this key |
ERXKey<BigDecimal> |
atAvgNonNull(ERXKey<?> key)
Creates a new ERXKey that appends ERXArrayUtilities'
@avgNonNull
aggregate operator and the given key to this key. |
ERXKey<Integer> |
atCount()
Creates a new ERXKey that appends this key with NSArray's
@count
aggregate operator |
<U> ERXKey<U> |
atFetchSpec(String fetchSpecName)
Creates a new ERXKey that appends ERXArrayUtilities'
@fetchSpec
operator and the fetchSpecName to this key. |
<U> ERXKey<NSArray<U>> |
atFetchSpec(String fetchSpecName,
ERXKey<U> key)
Creates a new ERXKey that appends ERXArrayUtilities'
@fetchSpec operator, the fetchSpecName and
the key to this key. |
ERXKey<T> |
atFlatten()
Flattens this key
|
<U> ERXKey<NSArray<U>> |
atFlatten(ERXKey<U> key)
Flattens this key
|
ERXKey<Boolean> |
atIsEmpty()
Checks this key.
|
ERXKey<T> |
atLimit(Integer limit)
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@limit operator and then the limit quantity. |
<U> ERXKey<NSArray<U>> |
atLimit(Integer limit,
ERXKey<U> key)
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@limit operator and then the limit quantity and then the
key , which should resolve to an NSArray<U> when used. |
<U> ERXKey<U> |
atMax()
Creates a new ERXKey that appends this key with NSArray's
@max
aggregate operator |
<U> ERXKey<U> |
atMax(ERXKey<U> key)
Creates a new ERXKey that appends this key with NSArray's
@max
aggregate operator and then appends the given key . |
ERXKey<BigDecimal> |
atMedian()
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@median aggregate operator |
ERXKey<BigDecimal> |
atMedian(ERXKey<?> key)
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@median aggregate operator and then appends the given
key . |
<U> ERXKey<U> |
atMin()
Creates a new ERXKey that appends this key with NSArray's
@min
aggregate operator |
<U> ERXKey<U> |
atMin(ERXKey<U> key)
Creates a new ERXKey that appends this key with NSArray's
@min
aggregate operator and then appends the given key . |
ERXKey<T> |
atObjectAtIndex(Integer index)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
objectAtIndex operator
@objectAtIndex . |
<U> ERXKey<U> |
atObjectAtIndex(Integer index,
ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
objectAtIndex operator
@objectAtIndex . |
ERXKey<BigDecimal> |
atPopStdDev()
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@popStdDev aggregate operator |
ERXKey<BigDecimal> |
atPopStdDev(ERXKey<?> key)
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@popStdDev aggregate operator and then appends the given key
. |
ERXKey<T> |
atRemoveNullValues()
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
RemoveNullValues operator
@removeNullValues . |
<U> ERXKey<U> |
atRemoveNullValues(ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
RemoveNullValues operator
@removeNullValue s. |
ERXKey<T> |
atReverse()
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
Reverse operator @reverse.
|
<U> ERXKey<NSArray<U>> |
atReverse(ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
Reverse operator
@reverse . |
ERXKey<T> |
atSort(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
Sort operator
@sort . |
ERXKey<T> |
atSortAsc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortAsc operator
@sortAsc . |
ERXKey<T> |
atSortDesc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortDescending operator
@sortDesc . |
ERXKey<T> |
atSortInsensitiveAsc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortInsensitiveAscending operator
@sortInsensitiveAsc . |
ERXKey<T> |
atSortInsensitiveDesc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortInsensitiveDescending operator
sortInsensitiveDesc . |
ERXKey<BigDecimal> |
atStdDev()
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@stdDev aggregate operator |
ERXKey<BigDecimal> |
atStdDev(ERXKey<?> key)
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@stdDev aggregate operator and then appends the given key
. |
ERXKey<T> |
atSubarrayWithRange(NSRange range)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SubarrayWithRange operator
subarrayWithRange . |
<U> ERXKey<NSArray<U>> |
atSubarrayWithRange(NSRange range,
ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SubarrayWithRange operator
subarrayWithRange . |
ERXKey<BigDecimal> |
atSum()
Creates a new ERXKey that appends this key with NSArray's
@sum
aggregate operator |
ERXKey<BigDecimal> |
atSum(ERXKey<?> key)
Creates a new ERXKey that appends this key with NSArray's
@sum
aggregate operator and then appends the given key . |
ERXKey<T> |
atUnique()
Filters for unique values for this key
|
<U> ERXKey<NSArray<U>> |
atUnique(ERXKey<U> key)
Filters for unique values for this key
|
static ERXKey<BigDecimal> |
avg()
Creates a new ERXKey that wraps NSArray's
@avg aggregate
operator. |
static ERXKey<BigDecimal> |
avg(ERXKey<?> key)
Creates a new ERXKey that appends the given
key to NSArray's
@avg aggregate operator. |
static ERXKey<BigDecimal> |
avgNonNull()
Creates a new ERXKey that wraps ERXArrayUtilities'
@avgNonNull
aggregate operator. |
static ERXKey<BigDecimal> |
avgNonNull(ERXKey<?> key)
Creates a new ERXKey that prepends the given
key with
ERXArrayUtilities' @avgNonNull aggregate operator. |
ERXKeyComparisonQualifier |
before(ERXKey<T> when)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorLessThan, value);
|
ERXKeyValueQualifier |
before(T when)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorLessThan, value);
|
EOQualifier |
between(T lowerBound,
T upperBound)
Equivalent to key > lowerBound and key < upperBound (exclusive).
|
EOQualifier |
between(T lowerBound,
T upperBound,
boolean inclusive)
Equivalent to key >= lowerBound and key <= upperBound (inclusive).
|
ERXKeyValueQualifier |
contains(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.OperatorCaseInsensitiveLike, "*" + value + "*").
|
ERXAndQualifier |
containsAll(String tokens)
Return a qualifier that evaluates to true when the value of the given key
contains all of the given tokens (insensitively) in the search string.
|
ERXAndQualifier |
containsAll(String[] tokens)
Return a qualifier that evaluates to true when the value of the given key
contains all of the given tokens (insensitively).
|
ERXOrQualifier |
containsAny(String tokens)
Return a qualifier that evaluates to true when the value of the given key
contains any of the given tokens (insensitively) in the search string.
|
ERXOrQualifier |
containsAny(String[] tokens)
Return a qualifier that evaluates to true when the value of the given key
contains any of the given tokens (insensitively).
|
ERXExistsQualifier |
containsAnyObjectSatisfying(EOQualifier qualifier)
Equivalent to
new ERXExistsQualifier(qualifier, key) . |
ERXExistsQualifier |
containsAnyObjectSatisfyingUsingIn(EOQualifier qualifier)
Equivalent to containsAnyObjectSatisfying() but set the ERXExistsQualifier to uses IN instead of EXISTS.
|
ERXExistsQualifier |
containsAnyOfTheseObjects(NSArray<? extends ERXGenericRecord> valueArray)
Uses ERXExistsQualifier to build a qualifier that returns true if at least one the objects
specified is found in the to many relationship represented by this key.
|
ERXKeyValueQualifier |
containsObject(Object obj)
Return a qualifier that evaluates to true when the given to many key
contains the given object.
|
static ERXKey<Integer> |
count()
Creates a new ERXKey that wraps NSArray's
@count aggregate
operator. |
ERXSortOrdering |
desc()
Equivalent to ERXS.desc(key())
|
ERXSortOrdering |
descInsensitive()
Equivalent to ERXS.descInsensitive(key())
|
ERXSortOrdering.ERXSortOrderings |
descInsensitives()
Equivalent to ERXS.descInsensitives(key())
|
ERXSortOrdering.ERXSortOrderings |
descs()
Equivalent to ERXS.descs(key())
|
ERXNotQualifier |
doesNotContainsAnyObjectSatisfying(EOQualifier qualifier)
Equivalent to
new ERXExistsQualifier(qualifier, key) . |
ERXNotQualifier |
doesNotContainsAnyObjectSatisfyingUsingIn(EOQualifier qualifier)
Equivalent to doesNotContainsAnyObjectSatisfying() but set the ERXExistsQualifier to uses IN instead of EXISTS.
|
EOQualifier |
dot(EOQualifier qualifier)
Simple cover method for
prefix(EOQualifier) . |
ERXSortOrdering |
dot(EOSortOrdering sortOrdering)
Simple cover method for
prefix(EOSortOrdering) . |
<U> ERXKey<U> |
dot(ERXKey<U> key)
Call append(key)
|
ERXSortOrdering.ERXSortOrderings |
dot(NSArray<EOSortOrdering> sortOrderings)
Simple cover method for
prefix(NSArray) . |
<U> ERXKey<U> |
dot(String key)
Call append(key)
|
<U> ERXKey<NSArray<U>> |
dotArray(ERXKey<U> key)
Call appendAsArray(key).
|
ERXKeyValueQualifier |
endsWith(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.OperatorLike, "*" + value).
|
ERXKeyValueQualifier |
endsWithInsensitive(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.OperatorCaseInsensitiveLike, "*" + value).
|
ERXKeyComparisonQualifier |
eq(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorEqual, value);
|
ERXKeyValueQualifier |
eq(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorEqual, value);
|
boolean |
equals(Object obj) |
static <U> ERXKey<U> |
fetchSpec(String fetchSpecName)
Creates a new ERXKey that appends the
fetchSpecName to
ERXArrayUtilities' @fetchSpec operator. |
static <U> ERXKey<NSArray<U>> |
fetchSpec(String fetchSpecName,
ERXKey<U> key)
Creates a new ERXKey that prepends the
key with
ERXArrayUtilities' @fetchSpec operator and the
fetchSpecName . |
static <U> ERXKey<U> |
flatten()
Will flatten an array of arrays or a key it is appended to
|
static <U> ERXKey<NSArray<U>> |
flatten(ERXKey<U> key)
Will flatten an array of arrays or a key it is appended to
|
ERXKeyComparisonQualifier |
greaterThan(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorGreaterThan, value);
|
ERXKeyValueQualifier |
greaterThan(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorGreaterThan, value);
|
ERXKeyComparisonQualifier |
greaterThanOrEqualTo(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);
|
ERXKeyValueQualifier |
greaterThanOrEqualTo(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);
|
ERXKeyComparisonQualifier |
gt(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorGreaterThan, value);
|
ERXKeyValueQualifier |
gt(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorGreaterThan, value);
|
ERXKeyComparisonQualifier |
gte(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);
|
ERXKeyValueQualifier |
gte(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);
|
int |
hashCode() |
ERXKeyValueQualifier |
hasValues(NSArray<T> values)
Equivalent to new ERXInQualifier(key, values);
|
ERXKeyValueQualifier |
ilike(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorCaseInsensitiveLike, value);
|
ERXOrQualifier |
in(NSArray<T> values)
Equivalent to a new ERXOrQualifier of EOKeyValueQualifier with key equals
value for each value.
|
ERXOrQualifier |
inObjects(T... values)
Equivalent to a new ERXOrQualifier of EOKeyValueQualifier with key equals
value for each value.
|
ERXKeyComparisonQualifier |
is(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorEqual, value);
|
ERXKeyValueQualifier |
is(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorEqual, value);
|
boolean |
isAttribute()
Checks this key's
ERXKey.Type to determine if it represents an
EOAttribute . |
static ERXKey<Boolean> |
isEmpty()
Checks an array or a key it is appended to to
|
ERXNotQualifier |
isEmptyRelationship()
Determines if there are any objects in the to-one or to-many
EORelationship that this ERXKey represents.
|
ERXKeyValueQualifier |
isFalse()
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorEqual, Boolean.FALSE);
|
ERXKeyComparisonQualifier |
isNot(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorNotEqual, value);
|
ERXKeyValueQualifier |
isNot(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorNotEqual, value);
|
ERXExistsQualifier |
isNotEmptyRelationship()
Determines if there are any objects in the to-one or to-many
EORelationship that this ERXKey represents. |
ERXKeyValueQualifier |
isNotNull()
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorNotEqual, null);
|
ERXKeyValueQualifier |
isNull()
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorEqual, null);
|
boolean |
isToManyRelationship()
Checks this key's
ERXKey.Type to determine if it represents a
to-many EORelationship . |
boolean |
isToOneRelationship()
Checks this key's
ERXKey.Type to determine if it represents a
to-one EORelationship . |
ERXKeyValueQualifier |
isTrue()
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorEqual, Boolean.TRUE);
|
ERXKeyValueQualifier |
isUnlessNull(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorEqual, value) only if the value is not null.
|
String |
key()
Return the keypath that this ERXKey represents.
|
ERXKeyComparisonQualifier |
lessThan(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorLessThan, value);
|
ERXKeyValueQualifier |
lessThan(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorLessThan, value);
|
ERXKeyComparisonQualifier |
lessThanOrEqualTo(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorLessThanOrEqualTo, value);
|
ERXKeyValueQualifier |
lessThanOrEqualTo(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorLessThanOrEqualTo, value);
|
ERXKeyValueQualifier |
like(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorLike, value);
|
ERXKeyValueQualifier |
likeInsensitive(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorCaseInsensitiveLike, value);
|
static <U> ERXKey<U> |
limit(Integer limit)
Limits the size of the array it is called on or the key it is appended
to.
|
static <U> ERXKey<NSArray<U>> |
limit(Integer limit,
ERXKey<U> key)
Limits the size of the array it is called on or the key it is appended
to.
|
ERXKey<T> |
loc(Locale locale)
Returns a localized key.
|
ERXKey<T> |
loc(String locale)
Returns a localized key.
|
ERXKeyComparisonQualifier |
lt(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorLessThan, value);
|
ERXKeyValueQualifier |
lt(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorLessThan, value);
|
ERXKeyComparisonQualifier |
lte(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorLessThanOrEqualTo, value);
|
ERXKeyValueQualifier |
lte(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorLessThanOrEqualTo, value);
|
static <U> ERXKey<U> |
max()
Creates a new ERXKey that wraps NSArray's
@max aggregate
operator. |
static <U> ERXKey<U> |
max(ERXKey<U> key)
Creates a new ERXKey that appends the given
key to NSArray's
@max aggregate operator. |
static ERXKey<BigDecimal> |
median()
Creates a new ERXKey that wraps ERXArrayUtilities'
@median
aggregate operator. |
static ERXKey<BigDecimal> |
median(ERXKey<?> key)
Creates a new ERXKey that appends the given
key to
ERXArrayUtilities' @median aggregate operator. |
static <U> ERXKey<U> |
min()
Creates a new ERXKey that wraps NSArray's
@min aggregate
operator. |
static <U> ERXKey<U> |
min(ERXKey<U> key)
Creates a new ERXKey that appends the given
key to NSArray's
@min aggregate operator. |
ERXKeyComparisonQualifier |
ne(ERXKey<T> value)
Equivalent to new ERXKeyComparisonQualifier(key,
EOQualifier.QualifierOperatorNotEqual, value);
|
ERXKeyValueQualifier |
ne(T value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.QualifierOperatorNotEqual, value);
|
ERXAndQualifier |
notIn(NSArray<T> values)
Equivalent to a new ERXAndQualifier of
EONotQualifier(EOKeyValueQualifier) with key equals value for each value.
|
ERXAndQualifier |
notInObjects(T... values)
Equivalent to a new ERXAndQualifier of
EONotQualifier(EOKeyValueQualifier) with key equals value for each value.
|
static <U> ERXKey<U> |
objectAtIndex(Integer index)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
objectAtIndex operator
@objectAtIndex . |
static <U> ERXKey<U> |
objectAtIndex(Integer index,
ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
objectAtIndex operator
@objectAtIndex . |
static ERXKey<BigDecimal> |
popStdDev()
Creates a new ERXKey that wraps ERXArrayUtilities'
@popStdDev
aggregate operator. |
static ERXKey<BigDecimal> |
popStdDev(ERXKey<?> key)
Creates a new ERXKey that appends the given
key to
ERXArrayUtilities' @popStdDev aggregate operator. |
EOQualifier |
prefix(EOQualifier qualifier)
Prefix the keys in the given qualifier with this key.
|
ERXSortOrdering |
prefix(EOSortOrdering sortOrder)
Prefix the key in the given sort ordering with this key.
|
ERXSortOrdering.ERXSortOrderings |
prefix(NSArray<EOSortOrdering> sortOrderings)
Prefix the keys in the given array of sort orderings with this key.
|
Object |
rawValueInObject(Object obj)
Return the value of this keypath on the given object.
|
static <U> ERXKey<U> |
removeNullValues()
Return a new ERXKey that uses ERXArrayUtilities' remove null values operator
@removeNullValues . |
static <U> ERXKey<U> |
removeNullValues(ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
RemoveNullValues operator
@removeNullValues . |
static <U> ERXKey<U> |
reverse()
Return a new ERXKey that uses ERXArrayUtilities' reverse operator
@reverse . |
static <U> ERXKey<NSArray<U>> |
reverse(ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
Reverse operator @reverse.
|
void |
setType(ERXKey.Type type) |
static <U> ERXKey<U> |
sort(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
Sort operator
@sort . |
static <U> ERXKey<U> |
sortAsc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortAscending operator
@sortAsc . |
static <U> ERXKey<U> |
sortDesc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortDescending operator
@sortDesc . |
static <U> ERXKey<U> |
sortInsensitiveAsc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortInsensitiveAscending operator
@sortInsensitiveAsc . |
static <U> ERXKey<U> |
sortInsensitiveDesc(ERXKey<?>... sortKeys)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SortInsensitiveDescending operator
@sortInsensitiveDesc . |
ERXKeyValueQualifier |
startsWith(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.OperatorLike, value + "*").
|
ERXKeyValueQualifier |
startsWithInsensitive(String value)
Equivalent to new ERXKeyValueQualifier(key,
EOQualifier.OperatorCaseInsensitiveLike, value + "*").
|
static ERXKey<BigDecimal> |
stdDev()
Creates a new ERXKey that wraps ERXArrayUtilities'
@stdDev
aggregate operator. |
static ERXKey<BigDecimal> |
stdDev(ERXKey<?> key)
Creates a new ERXKey that appends the given
key to
ERXArrayUtilities' @stdDev aggregate operator. |
static <U> ERXKey<U> |
subarrayWithRange(NSRange range)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SubarrayWithRange operator
subarrayWithRange . |
static <U> ERXKey<NSArray<U>> |
subarrayWithRange(NSRange range,
ERXKey<U> key)
Return a new ERXKey that prepends the given key with ERXArrayUtilities'
SubarrayWithRange operator
subarrayWithRange . |
static ERXKey<BigDecimal> |
sum()
Creates a new ERXKey that wraps NSArray's
@sum aggregate
operator. |
static ERXKey<BigDecimal> |
sum(ERXKey<?> key)
Creates a new ERXKey that appends the given
key to NSArray's
@sum aggregate operator. |
void |
takeValueInObject(T value,
Object obj)
Set the value of this keypath on the given object.
|
String |
toString() |
ERXKey.Type |
type()
See
ERXKey(String, Type) for information on how to automatically
set this. |
static <U> ERXKey<U> |
unique()
Filters the array it is called on or the key it is appended
to.
|
static <U> ERXKey<NSArray<U>> |
unique(ERXKey<U> key)
Will filter an array or a key it is appended to
|
T |
valueInObject(Object obj)
Return the value of this keypath on the given object.
|
public ERXKey(String key)
key
- the underlying keypathpublic ERXKey(String key, ERXKey.Type type)
ERXKey.Type
it is.
You can have EOGenerator use this constructor by using the following code
in the EOGenerator template that generates your _Entity.java files.
Replace the existing code that creates the ERXKeys declarations for the
Entity's attributes, to-one relationships and to-many relationships.
public static final ERXKey<$attribute.javaClassName> ${attribute.uppercaseUnderscoreName} = new ERXKey<$attribute.javaClassName>("$attribute.name", ERXKey.Type.Attribute);
public static final ERXKey<$relationship.actualDestination.classNameWithDefault> ${relationship.uppercaseUnderscoreName} = new ERXKey<$relationship.actualDestination.classNameWithDefault>("$relationship.name", ERXKey.Type.ToOneRelationship);
public static final ERXKey<$relationship.actualDestination.classNameWithDefault> ${relationship.uppercaseUnderscoreName} = new ERXKey<$relationship.actualDestination.classNameWithDefault>("$relationship.name", ERXKey.Type.ToManyRelationship);
key
- the underlying key or keypathtype
- the ERXKey.Type
public ERXKey(String key, String locale)
key
- the underlying keypathlocale
- the locale for the keypublic ERXKey(String key, String locale, ERXKey.Type type)
ERXKey.Type
it is.key
- the underlying keypathlocale
- the locale for the keytype
- the ERXKey.Type
ERXKey(String, Type)
public static ERXKey<BigDecimal> avgNonNull(ERXKey<?> key)
key
with
ERXArrayUtilities' @avgNonNull
aggregate operator.key
- the key(path) to the value to be averagedERXKey<BigDecimal>
wrapping the
@avgNonNull.key
keypathAvgNonNullOperator
public static ERXKey<BigDecimal> avgNonNull()
@avgNonNull
aggregate operator.ERXKey<BigDecimal>
wrapping the @avgNonNull
keyAvgNonNullOperator
public ERXKey<BigDecimal> atAvgNonNull(ERXKey<?> key)
@avgNonNull
aggregate operator and the given key
to this key.key
- the key(path) to the value to be averagedERXKey<BigDecimal>
wrapping the
thisKey.@avgNonNull.key
keypathAvgNonNullOperator
public ERXKey<BigDecimal> atAvgNonNull()
@avgNonNull
aggregate operator to this keyERXKey<BigDecimal>
wrapping the
thisKey.@avgNonNull
keypathAvgNonNullOperator
public static <U> ERXKey<NSArray<U>> fetchSpec(String fetchSpecName, ERXKey<U> key)
key
with
ERXArrayUtilities' @fetchSpec
operator and the
fetchSpecName
.
This ERXKey does not perform a fetch itself. It simply makes use of an
EOFetchSpecification that is defined on the key
's Entity for its
qualifier(s) and sortOrdering(s) and uses them to filter and sort the
values for key
For example, if the fetchSpecName
is "newHomes" and the
key
is "price" this will return a new ERXKey wrapping
"@fetchSpec.newHomes.price".
U
- the type of the next keyfetchSpecName
- the name of the fetchSpeckey
- the key(path) to the values to be filtered and sortedERXKey<U>
wrapping the
@fetchSpec.fetchSpecName.key
keypathFetchSpecOperator
public <U> ERXKey<NSArray<U>> atFetchSpec(String fetchSpecName, ERXKey<U> key)
@fetchSpec
operator, the fetchSpecName
and
the key
to this key.
This ERXKey does not perform a fetch itself. It simply makes use of an
EOFetchSpecification that is defined on the key
's Entity for its
qualifier(s) and sortOrdering(s) and uses them to filter and sort the
values for key
For example, if the fetchSpecName
is "newHomes" and the
key
is "price" this will return a new ERXKey wrapping
"thisKey.@fetchSpec.newHomes.price".
U
- the type of the next keyfetchSpecName
- the fetchSpec namekey
- the key to use for this keypathERXKey<NSArray<U>>
wrapping the
thisKey.@fetchSpec.fetchSpecName.key
keypathFetchSpecOperator
public static <U> ERXKey<U> fetchSpec(String fetchSpecName)
fetchSpecName
to
ERXArrayUtilities' @fetchSpec
operator.
This ERXKey does not perform a fetch itself. It simply makes use of an
EOFetchSpecification that is defined on the key
's Entity for its
qualifier(s) and sortOrdering(s) and uses them to filter and sort the
values for key
For example, if the fetchSpecName
is "newHomes" this will return
a new ERXKey wrapping "@fetchSpec.newHomes".
U
- the type of the next keyfetchSpecName
- the fetchSpec nameERXKey<U>
wrapping the
@fetchSpec.fetchSpecName
keypathFetchSpecOperator
public <U> ERXKey<U> atFetchSpec(String fetchSpecName)
@fetchSpec
operator and the fetchSpecName
to this key.
This ERXKey does not perform a fetch itself. It simply makes use of an
EOFetchSpecification that is defined on the key
's Entity for its
qualifier(s) and sortOrdering(s) and uses them to filter and sort the
values for key
For example, if the fetchSpecName
is "newHomes" this will return
a new ERXKey wrapping thisKey.@fetchSpec.newHomes
keypath
U
- the type of the next keyfetchSpecName
- the fetchSpec nameERXKey<U>
wrapping the
thisKey.@fetchSpec.fetchSpecName
keypathFetchSpecOperator
public static <U> ERXKey<NSArray<U>> flatten(ERXKey<U> key)
Creates a new ERXKey that prepends the key
with
ERXArrayUtilities' @flatten
operator. The key
should
resolve to an NSArray<U>
when used.
Note: the @flatten
operator is applied to the array it is
called on or the key immediately preceding it, not the key (if any)
following it. This method is useful for flattening an existing array or
key that is already included in a keypath.
For example, if you are chaining ERXKeys such as
Customer.ORDERS.dot(Order.ORDER_LINES)
which if called on a
Customer would return an NSArray<NSArray<OrderLine>>
, you can add
dot(ERXKey.flatten(OrderLine.PRICE) to get a new ERXKey wrapping the
orders.orderlines.@flatten.price
, which will return an array of
prices when called on any Customer object.
U
- the type of the next keykey
- the key following the key to be flattenedERXKey<U>
wrapping the @flatten.key
keypathFlattenOperator
public <U> ERXKey<NSArray<U>> atFlatten(ERXKey<U> key)
Creates a new ERXKey that appends ERXArrayUtilities' @flatten
operator and the key
to this key. The key
should resolve
to an NSArray<U>
when used.
Note: the @flatten
operator will be applied to this key,
not the key specified by the key
parameter.
For example, if the key
is "price" this will return a new ERXKey
wrapping the thisKey.@flatten.price
keypath.
U
- the type of the next keykey
- the following keyERXKey<U>
wrapping the thisKey.@flatten.key
keypathFlattenOperator
public static <U> ERXKey<U> flatten()
Creates a new ERXKey that wraps ERXArrayUtilities' @flatten
aggregate operator.
U
- the type of the next key@flatten
keyFlattenOperator
public ERXKey<T> atFlatten()
Creates a new ERXKey that appends ERXArrayUtilities'
@flatten
operator to this key.
ERXKey<U>
wrapping the thisKey.@flatten
keypathFlattenOperator
public static ERXKey<Boolean> isEmpty()
Creates a new ERXKey that wraps ERXArrayUtilities' @isEmpty
aggregate operator.
Note: any key(path) following @isEmpty
is ignored.
ERXKey<Boolean>
wrapping the @isEmpty
keyIsEmptyOperator
public ERXKey<Boolean> atIsEmpty()
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@isEmpty
operator.
Note: any key(path) following @isEmpty
is ignored.
ERXKey<Boolean>
wrapping the thisKey.@isEmpty
keypathIsEmptyOperator
public static <U> ERXKey<NSArray<U>> limit(Integer limit, ERXKey<U> key)
Creates a new ERXKey that appends ERXArrayUtilities' @limit
operator and then the limit
quantity and then the key
,
which should resolve to an NSArray<U>
when used.
Note: the @limit
operator will be applied to the array it
is called on or the key immediately preceding it, not the key specified
by the key
parameter.
For example, if the key
is "price" and limit is 3 this will
return a new ERXKey @limit.3.price
.
U
- the type of the next keylimit
- the maximum number of objects allowed by the limitkey
- the key following the key to be limitedERXKey<NSArray<U>>
wrapping the
@limit.quantity.key
keypathLimitOperator
public <U> ERXKey<NSArray<U>> atLimit(Integer limit, ERXKey<U> key)
@limit
operator and then the limit
quantity and then the
key
, which should resolve to an NSArray<U>
when used.
Note: the @limit
operator will be applied to this key not
the key specified by the key
parameter.
For example, if the key
is "price" and limit is 3 this will
return a new ERXKey thiskey.@limit.3.price
.
U
- the type of the next keylimit
- the maximum number of objects allowed by the limitkey
- the key following the key to be limitedERXKey<NSArray<U>>
wrapping the
thisKey.@limit.quantity.key
keypathLimitOperator
public static <U> ERXKey<U> limit(Integer limit)
Creates a new ERXKey that appends ERXArrayUtilities' @limit
operator and then the limit
quantity.
Note: the @limit
operator will be applied to the array it
is called on or the key immediately preceding it, not the key (if any)
following it.
For example, if the key
is "price" and limit is 3 this will
return a new ERXKey @limit.3
.
U
- the type of the next keylimit
- the maximum number of objects allowed by the limitERXKey<NSArray<U>>
wrapping the
@limit.quantity
keypathLimitOperator
public ERXKey<T> atLimit(Integer limit)
@limit
operator and then the limit
quantity.
Note: the @limit
operator will be applied to this key not
the key specified by the key
parameter.
For example, if the key
is "price" and limit is 3 this will
return a new ERXKey thiskey.@limit.3
.
limit
- the maximum number of objects allowed by the limitERXKey<NSArray<U>>
wrapping the
thisKey.@limit.quantity
keypathLimitOperator
public static ERXKey<BigDecimal> median()
@median
aggregate operator.ERXKey<BigDecimal>
wrapping the @median
keyMedianOperator
public static ERXKey<BigDecimal> median(ERXKey<?> key)
key
to
ERXArrayUtilities' @median
aggregate operator.key
- the key(path) to the value to be averagedERXKey<BigDecimal>
wrapping the @median.key
keypathMedianOperator
public ERXKey<BigDecimal> atMedian()
@median
aggregate operatorERXKey<BigDecimal>
wrapping the
thisKey.@median
keypathMedianOperator
public ERXKey<BigDecimal> atMedian(ERXKey<?> key)
@median
aggregate operator and then appends the given
key
.key
- the key(path) to the value to be averagedERXKey<BigDecimal>
wrapping the
thisKey.@median.key
keypathMedianOperator
public static <U> ERXKey<U> objectAtIndex(Integer index, ERXKey<U> key)
@objectAtIndex
. For instance, if the index is 3
and the key is "price" then this will return a new ERXKey "@objectAtIndex.3.price".U
- the type of the next keyindex
- The index of the object to return from the arraykey
- the key following the operatorObjectAtIndexOperator
public <U> ERXKey<U> atObjectAtIndex(Integer index, ERXKey<U> key)
@objectAtIndex
. For instance, if the index is 3
and the key is "price" then this will return a new ERXKey "@objectAtIndex.3.price".U
- the type of the next keyindex
- The index of the object to return from the arraykey
- the key following the operatorObjectAtIndexOperator
public static <U> ERXKey<U> objectAtIndex(Integer index)
@objectAtIndex
. For instance, if the index is 3
then this will return a new ERXKey "@objectAtIndex.3".U
- the type of the next keyindex
- The index of the object to return from the arrayObjectAtIndexOperator
public ERXKey<T> atObjectAtIndex(Integer index)
@objectAtIndex
. For instance, if the index is 3
then this will return a new ERXKey "@objectAtIndex.3".index
- The index of the object to return from the arrayObjectAtIndexOperator
public static <U> ERXKey<U> removeNullValues(ERXKey<U> key)
@removeNullValues
. For instance, if the key is "price"
this will return a new ERXKey "@removeNullValues.price".U
- the type of the next keykey
- the key to use for this keypathRemoveNullValuesOperator
public <U> ERXKey<U> atRemoveNullValues(ERXKey<U> key)
@removeNullValue
s. For instance, if the key is "price"
this will return a new ERXKey "@removeNullValues.price".U
- the type of the next keykey
- the key to use for this keypathRemoveNullValuesOperator
public static <U> ERXKey<U> removeNullValues()
@removeNullValues
.U
- the type of the next keyRemoveNullValuesOperator
public ERXKey<T> atRemoveNullValues()
@removeNullValues
.RemoveNullValuesOperator
public static <U> ERXKey<NSArray<U>> reverse(ERXKey<U> key)
U
- the type of the next keykey
- the key to use for this keypathReverseOperator
public <U> ERXKey<NSArray<U>> atReverse(ERXKey<U> key)
@reverse
. For instance, if the key is "price"
this will return a new ERXKey "@reverse.price".U
- the type of the next keykey
- the key to use for this keypathReverseOperator
public static <U> ERXKey<U> reverse()
@reverse
.U
- the type of the next keyReverseOperator
public ERXKey<T> atReverse()
ReverseOperator
public static <U> ERXKey<U> sort(ERXKey<?>... sortKeys)
@sort
. For instance,
sort(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sort.firstName,lastname
.U
- the type of the next keysortKeys
- the ERXKeys to append for sortingSortOperator
public ERXKey<T> atSort(ERXKey<?>... sortKeys)
@sort
. For instance,
atSort(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sort.firstName,lastname
.sortKeys
- the ERXKeys to append for sortingSortOperator
public static <U> ERXKey<U> sortAsc(ERXKey<?>... sortKeys)
@sortAsc
. For instance,
sortAsc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortAsc.firstName,lastname
.U
- the type of the next keysortKeys
- the ERXKeys to append for sortingSortOperator
public ERXKey<T> atSortAsc(ERXKey<?>... sortKeys)
@sortAsc
. For instance,
atSortAsc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortAsc.firstName,lastname
.sortKeys
- the ERXKeys to append for sortingSortOperator
public static <U> ERXKey<U> sortDesc(ERXKey<?>... sortKeys)
@sortDesc
. For instance,
sortDesc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortDesc.firstName,lastname
.U
- the type of the next keysortKeys
- the ERXKeys to append for sortingSortOperator
public ERXKey<T> atSortDesc(ERXKey<?>... sortKeys)
@sortDesc
. For instance,
atSortDesc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortDesc.firstName,lastname
.sortKeys
- the ERXKeys to append for sortingSortOperator
public static <U> ERXKey<U> sortInsensitiveAsc(ERXKey<?>... sortKeys)
@sortInsensitiveAsc
. For instance,
sortInsensitiveAsc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortInsensitiveAsc.firstName,lastname
.U
- the type of the next keysortKeys
- the ERXKeys to append for sortingSortOperator
public ERXKey<T> atSortInsensitiveAsc(ERXKey<?>... sortKeys)
@sortInsensitiveAsc
. For instance,
atSortInsensitiveAsc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortInsensitiveAsc.firstName,lastname
.sortKeys
- the ERXKeys to append for sortingSortOperator
public static <U> ERXKey<U> sortInsensitiveDesc(ERXKey<?>... sortKeys)
@sortInsensitiveDesc
. For instance,
sortInsensitiveDesc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like @sortInsensitiveDesc.firstName,lastname
.U
- the type of the next keysortKeys
- the ERXKeys to append for sortingSortOperator
public ERXKey<T> atSortInsensitiveDesc(ERXKey<?>... sortKeys)
sortInsensitiveDesc
. For instance,
atSortInsensitiveDesc(Employee.FIRST_NAME, Employee.LAST_NAME)
would return a key like sortInsensitiveDesc.firstName,lastname
sortKeys
- the ERXKeys to append for sortingSortOperator
public static <U> ERXKey<NSArray<U>> subarrayWithRange(NSRange range, ERXKey<U> key)
subarrayWithRange
. For instance, if the key is "price"
and the range is new NSRange(4,2)
this will return a new ERXKey @subarrayWithRange.4-2.price
.U
- the type of the next keykey
- the key to use for this keypathrange
- the range for the operatorSubarrayWithRangeOperator
public <U> ERXKey<NSArray<U>> atSubarrayWithRange(NSRange range, ERXKey<U> key)
subarrayWithRange
. For instance, if the key is "price"
and the range is new NSRange(4,2)
this will return a new ERXKey subarrayWithRange.4-2.price
.U
- the type of the next keykey
- the key to use for this keypathrange
- the range for the operatorSubarrayWithRangeOperator
public static <U> ERXKey<U> subarrayWithRange(NSRange range)
subarrayWithRange
. For instance, if the range
is new NSRange(4,2)
this will return a new ERXKey subarrayWithRange.4-2.price
.U
- the type of the next keyrange
- the range for the operatorSubarrayWithRangeOperator
public ERXKey<T> atSubarrayWithRange(NSRange range)
subarrayWithRange
. For instance, if the range
is new NSRange(4,2)
this will return a new ERXKey subarrayWithRange.4-2.price
.range
- the range for the operatorSubarrayWithRangeOperator
public static <U> ERXKey<NSArray<U>> unique(ERXKey<U> key)
Creates a new ERXKey that appends ERXArrayUtilities' @unique
operator with the key
, which should resolve to an NSArray<U> when
used.
Note: the @unique
operator is applied to the array it is
called on or the key immediately preceding it, not the key (if any)
following it. This method is useful for flattening an existing array or
key that is already included in a keypath.
For example, if the key
is "price" this will return a new ERXKey
wrapping the @unique.price
keypath.
U
- the type of the next keykey
- the key following the key to be flattenedERXKey<U>
wrapping the @unique.key
keypathFlattenOperator
public <U> ERXKey<NSArray<U>> atUnique(ERXKey<U> key)
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@unique
operator and then with the key
, which should
resolve to an NSArray<U>
when used.
Note: the @unique
operator will be applied to this key,
not the key specified by the key
parameter.
For example, if the key
is "price" this will return a new ERXKey
wrapping the thisKey.@unique.price
keypath.
U
- the type of the next keykey
- the key following the key to be flattenedERXKey<U>
wrapping the thisKey.@flatten.key
keypathFlattenOperator
public static <U> ERXKey<U> unique()
Creates a new ERXKey that wraps ERXArrayUtilities' @unique
aggregate operator.
U
- the type of the next key@unique
keyUniqueOperator
public ERXKey<T> atUnique()
Creates a new ERXKey that appends this key with ERXArrayUtilities'
@unique
operator.
ERXKey<U>
wrapping the thisKey.@unique
keypathUniqueOperator
public static ERXKey<BigDecimal> sum(ERXKey<?> key)
key
to NSArray's
@sum
aggregate operator.key
- the key(path) to the value to be summedERXKey<BigDecimal>
wrapping the @sum.key
keypathpublic ERXKey<BigDecimal> atSum(ERXKey<?> key)
@sum
aggregate operator and then appends the given key
.key
- the key(path) to the value to be summedERXKey<BigDecimal>
wrapping the
thisKey.@sum.key
keypathpublic ERXKey<BigDecimal> atSum()
@sum
aggregate operatorERXKey<BigDecimal>
wrapping the thisKey.@sum
keypathpublic static ERXKey<BigDecimal> sum()
@sum
aggregate
operator.ERXKey<BigDecimal>
wrapping the @sum
keypublic static ERXKey<BigDecimal> popStdDev()
@popStdDev
aggregate operator.ERXKey<BigDecimal>
wrapping the @popStdDev
keyStandardDeviationOperator
public ERXKey<BigDecimal> atPopStdDev()
@popStdDev
aggregate operatorERXKey<BigDecimal>
wrapping the
thisKey.@popStdDev
keypathStandardDeviationOperator
public static ERXKey<BigDecimal> popStdDev(ERXKey<?> key)
key
to
ERXArrayUtilities' @popStdDev
aggregate operator.key
- the key(path) to the values used to derive the standard deviationERXKey<BigDecimal>
wrapping the @popStdDev.key
keypathStandardDeviationOperator
public ERXKey<BigDecimal> atPopStdDev(ERXKey<?> key)
@popStdDev
aggregate operator and then appends the given key
.key
- the key(path) to the values used to derive the standard deviationERXKey<BigDecimal>
wrapping the
thisKey.@popStdDev.key
keypathStandardDeviationOperator
public static ERXKey<BigDecimal> stdDev()
@stdDev
aggregate operator.ERXKey<BigDecimal>
wrapping the @stdDev
keyStandardDeviationOperator
public ERXKey<BigDecimal> atStdDev()
@stdDev
aggregate operatorERXKey<BigDecimal>
wrapping the
thisKey.@stdDev
keypathStandardDeviationOperator
public static ERXKey<BigDecimal> stdDev(ERXKey<?> key)
key
to
ERXArrayUtilities' @stdDev
aggregate operator.key
- the key(path) to the values used to derive the standard deviationERXKey<BigDecimal>
wrapping the @stdDev.key
keypathStandardDeviationOperator
public ERXKey<BigDecimal> atStdDev(ERXKey<?> key)
@stdDev
aggregate operator and then appends the given key
.key
- the key(path) to the values used to derive the standard deviationERXKey<BigDecimal>
wrapping the
thisKey.@stdDev.key
keypathStandardDeviationOperator
public static ERXKey<BigDecimal> avg(ERXKey<?> key)
key
to NSArray's
@avg
aggregate operator.key
- the key(path) to the value to be averagedERXKey<BigDecimal>
wrapping the @avg.key
keypathpublic ERXKey<BigDecimal> atAvg(ERXKey<?> key)
@avg
aggregate operator and then appends the given key
.key
- the key(path) to the value to be averagedERXKey<BigDecimal>
wrapping the
thisKey.@avg.key
keypathpublic static ERXKey<BigDecimal> avg()
@avg
aggregate
operator.ERXKey<BigDecimal>
wrapping the @avg
keypublic ERXKey<BigDecimal> atAvg()
@avg
aggregate operatorERXKey<BigDecimal>
wrapping the thisKey.@avg
keypathpublic static <U> ERXKey<U> min(ERXKey<U> key)
key
to NSArray's
@min
aggregate operator.U
- the type of the next keykey
- the key(path) to the values to be filtered for the minimum
valueERXKey<BigDecimal>
wrapping the @min.key
keypathpublic <U> ERXKey<U> atMin(ERXKey<U> key)
@min
aggregate operator and then appends the given key
.U
- the type of the next keykey
- the key(path) to the values to be filtered for the minimum
valueERXKey<U>
wrapping the thisKey.@min.key
keypathpublic static <U> ERXKey<U> min()
@min
aggregate
operator.U
- the type of the next keyERXKey<BigDecimal>
wrapping the @min
keypublic <U> ERXKey<U> atMin()
@min
aggregate operatorU
- the type of the next keyERXKey<BigDecimal>
wrapping the thisKey.@min
keypathpublic static <U> ERXKey<U> max(ERXKey<U> key)
key
to NSArray's
@max
aggregate operator.U
- the type of the next keykey
- the key(path) to the values to be filtered for the maximum
valueERXKey<U>
wrapping the @max.key
keypathpublic <U> ERXKey<U> atMax(ERXKey<U> key)
@max
aggregate operator and then appends the given key
.U
- the type of the next keykey
- the key(path) to the values to be filtered for the maximum
valueERXKey<U>
wrapping the
thisKey.@max.key
keypathpublic static <U> ERXKey<U> max()
@max
aggregate
operator.U
- the type of the next keyERXKey<U>
wrapping the @max
keypublic <U> ERXKey<U> atMax()
@max
aggregate operatorU
- the type of the next keyERXKey<U>
wrapping the thisKey.@max
keypathpublic static ERXKey<Integer> count()
@count
aggregate
operator.
Note: any key(path) following @count
is ignored.
ERXKey<BigDecimal>
wrapping the @count
keypublic ERXKey<Integer> atCount()
@count
aggregate operator
Note: any key(path) following @count
is ignored.
ERXKey<Integer>
wrapping the thisKey.@count
keypathpublic ERXSortOrdering asc()
public ERXSortOrdering.ERXSortOrderings ascs()
public ERXSortOrdering desc()
public ERXSortOrdering.ERXSortOrderings descs()
public ERXSortOrdering ascInsensitive()
public ERXSortOrdering.ERXSortOrderings ascInsensitives()
public ERXSortOrdering descInsensitive()
public ERXSortOrdering.ERXSortOrderings descInsensitives()
public String key()
public ERXKey<T> loc(String locale)
locale
- locale for the new key.public ERXKey<T> loc(Locale locale)
locale
- locale for the new key.public ERXKeyValueQualifier isTrue()
public ERXKeyValueQualifier isFalse()
public ERXKeyValueQualifier isUnlessNull(T value)
value
- the valuepublic ERXKeyValueQualifier is(T value)
value
- the valuepublic ERXKeyComparisonQualifier is(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier eq(T value)
value
- the valuepublic ERXKeyComparisonQualifier eq(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier isNot(T value)
value
- the valuepublic ERXKeyComparisonQualifier isNot(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier ne(T value)
value
- the valuepublic ERXKeyComparisonQualifier ne(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier greaterThan(T value)
value
- the valuepublic ERXKeyComparisonQualifier greaterThan(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier gt(T value)
value
- the valuepublic ERXKeyComparisonQualifier gt(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier lessThan(T value)
value
- the valuepublic ERXKeyComparisonQualifier lessThan(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier lt(T value)
value
- the valuepublic ERXKeyComparisonQualifier lt(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier greaterThanOrEqualTo(T value)
value
- the valuepublic ERXKeyComparisonQualifier greaterThanOrEqualTo(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier gte(T value)
value
- the valuepublic ERXKeyComparisonQualifier gte(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier lessThanOrEqualTo(T value)
value
- the valuepublic ERXKeyComparisonQualifier lessThanOrEqualTo(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier lte(T value)
value
- the valuepublic ERXKeyComparisonQualifier lte(ERXKey<T> value)
value
- the valuepublic ERXKeyValueQualifier like(String value)
value
- the valuepublic ERXKeyValueQualifier likeInsensitive(String value)
value
- the valuepublic ERXKeyValueQualifier ilike(String value)
value
- the valuepublic ERXKeyValueQualifier isNull()
isEmptyRelationship
public ERXKeyValueQualifier isNotNull()
public ERXOrQualifier inObjects(T... values)
values
- the valuespublic ERXAndQualifier notInObjects(T... values)
values
- the valuespublic ERXOrQualifier in(NSArray<T> values)
values
- the valuespublic ERXAndQualifier notIn(NSArray<T> values)
values
- the valuespublic ERXKeyValueQualifier before(T when)
when
- the date to compare withpublic ERXKeyComparisonQualifier before(ERXKey<T> when)
when
- the date to compare withpublic ERXKeyValueQualifier after(T when)
when
- the date to compare withpublic ERXKeyComparisonQualifier after(ERXKey<T> when)
when
- the date to compare withpublic EOQualifier between(T lowerBound, T upperBound)
lowerBound
- the lower bound valueupperBound
- the upper bound valuepublic EOQualifier between(T lowerBound, T upperBound, boolean inclusive)
lowerBound
- the lower bound valueupperBound
- the upper bound valueinclusive
- whether or not the between includes the endpointspublic ERXKeyValueQualifier startsWith(String value)
value
- the substring valuepublic ERXKeyValueQualifier startsWithInsensitive(String value)
value
- the substring valuepublic ERXKeyValueQualifier endsWith(String value)
value
- the substring valuepublic ERXKeyValueQualifier endsWithInsensitive(String value)
value
- the substring valuepublic ERXKeyValueQualifier contains(String value)
value
- the substring valuepublic ERXOrQualifier containsAny(String tokens)
tokens
- a whitespace separated list of tokens to search forpublic ERXOrQualifier containsAny(String[] tokens)
tokens
- the list of tokens to search forpublic ERXAndQualifier containsAll(String tokens)
tokens
- a whitespace separated list of tokens to search forpublic ERXAndQualifier containsAll(String[] tokens)
tokens
- the list of tokens to search forpublic ERXKeyValueQualifier containsObject(Object obj)
Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorContains, value).
obj
- the objectpublic ERXExistsQualifier containsAnyOfTheseObjects(NSArray<? extends ERXGenericRecord> valueArray)
valueArray
- an array of ERXGenericRecord
we want to have in this to many relationship.valueArray
is found in the to many EORelationship
represented by this ERXKey.public ERXExistsQualifier containsAnyObjectSatisfying(EOQualifier qualifier)
new ERXExistsQualifier(qualifier, key)
.qualifier
- a qualifier for the destinationEntity
of the EORelationship
represented
by this ERXKeyEORelationship
represented by this ERXKey contains at least one object matching
the given qualifier
public ERXNotQualifier doesNotContainsAnyObjectSatisfying(EOQualifier qualifier)
new ERXExistsQualifier(qualifier, key)
.
Since this qualifier will not result in a join in the database,
it can be very useful when testing relationships that use the
InnerJoin
joinSemantic
yet the relationship may be empty (to-many relationships) or
null
(to-one relationships).
qualifier
- a qualifier for the destinationEntity
of the EORelationship
represented
by this ERXKeyEORelationship
represented by this ERXKey does not
contain any objects that satisfy the given qualifier
public ERXExistsQualifier containsAnyObjectSatisfyingUsingIn(EOQualifier qualifier)
qualifier
- a qualifier for the destinationEntity
of the EORelationship
represented
by this ERXKeyEORelationship
represented by this ERXKey contains at least one object matching
the given qualifier
public ERXNotQualifier doesNotContainsAnyObjectSatisfyingUsingIn(EOQualifier qualifier)
qualifier
- a qualifier for the destinationEntity
of the EORelationship
represented
by this ERXKeyEORelationship
represented by this ERXKey does not contains at least one object matching
the given qualifier
public ERXExistsQualifier isNotEmptyRelationship()
EORelationship
that this ERXKey represents.true
when the
EORelationship
represented by this ERXKey contains at
least one objectpublic ERXNotQualifier isEmptyRelationship()
Since this qualifier will not result in a join in the database,
it can be very useful when testing relationships that use the
InnerJoin
joinSemantic
and the relationship could be empty (to-many relationships) or
null
(to-one relationships).
true
when the
EORelationship
represented by this ERXKey is emptypublic ERXKeyValueQualifier hasValues(NSArray<T> values)
values
- the valuespublic <U> ERXKey<U> append(String key)
Note: ERXKey has a limitation that it will not return the proper generic type if you attempt to build a keypath extension of an NSArray. For instance, ERXKey<NSArray<Person>>.append(ERXKey<String>) will return ERXKey<String> when, in fact, it should be ERXKey<NSArray<String>>. This is a limitation due to type erasure with generics that we cannot currently resolve this problem.
U
- the type of the next keykey
- the key to append to this keypathpublic <U> ERXKey<U> dot(String key)
U
- the key typekey
- the key to append to this keypathpublic <U> ERXKey<U> append(ERXKey<U> key)
Note: ERXKey has a limitation that it will not return the proper generic type if you attempt to build a keypath extension of an NSArray. For instance, ERXKey<NSArray<Person>>.append(ERXKey<String>) will return ERXKey<String> when, in fact, it should be ERXKey<NSArray<String>>. This is a limitation due to type erasure with generics that we cannot currently resolve this problem.
U
- the type of the next keykey
- the key to append to this keypathpublic <U> ERXKey<U> dot(ERXKey<U> key)
U
- the key typekey
- the key to append to this keypathpublic <U> ERXKey<NSArray<U>> appendAsArray(ERXKey<U> key)
ERXKey<String> k = new ERXKey<String>("foo");
ERXKey<NSArray<String>> a = new ERXKey<NSArray<String>>("foos");
k = k.append(k);
a = a.append(k);
a = k.appendAsArray(k);
k = k.appendAsArray(k);
a = k.appendAsArray(a);
a = a.appendAsArray(k);
a = a.appendAsArray(a);
U
- the type of the next key in the arraykey
- the key to append to this keypathpublic <U> ERXKey<NSArray<U>> dotArray(ERXKey<U> key)
U
- the typekey
- the key to append to this keypathpublic T valueInObject(Object obj)
Note: If you ERXKey representation a keypath through an NSArray, this method will result in a ClassCastException. See the 'Note' on .append(..) for further explanation.
obj
- the target object to apply this keypath onpublic Object rawValueInObject(Object obj)
obj
- the target object to apply this keypath onpublic NSArray<T> arrayValueInObject(Object obj)
obj
- the target object to apply this keypath onpublic void takeValueInObject(T value, Object obj)
value
- the value to setobj
- the object to set the value onpublic EOQualifier prefix(EOQualifier qualifier)
qualifier
- the qualifier to prefixpublic ERXSortOrdering prefix(EOSortOrdering sortOrder)
sortOrder
- the sort ordering to prefixpublic ERXSortOrdering.ERXSortOrderings prefix(NSArray<EOSortOrdering> sortOrderings)
sortOrderings
- an Array of sort orderings to prefixprefix(EOSortOrdering)
public EOQualifier dot(EOQualifier qualifier)
prefix(EOQualifier)
.qualifier
- the qualifier to prefixpublic ERXSortOrdering dot(EOSortOrdering sortOrdering)
prefix(EOSortOrdering)
.sortOrdering
- the sort ordering to prefixpublic ERXSortOrdering.ERXSortOrderings dot(NSArray<EOSortOrdering> sortOrderings)
prefix(NSArray)
.sortOrderings
- an Array of sort orderings to prefixpublic ERXKey.Type type()
ERXKey(String, Type)
for information on how to automatically
set this.ERXKey.Type
, if specified, for this key.public void setType(ERXKey.Type type)
public boolean isAttribute()
ERXKey.Type
to determine if it represents an
EOAttribute
.
Note: if type()
has not been set, then this will return
false
. To set it, you have the following options:
setType(Type)
ERXKey(String, Type)
constructor. If this
key was declared in code generated by EOGenerator (i.e. in a _Entity.java
class), you will need to modify your EOGenerator template. See
ERXKey(String, Type)
for details.true
if type()
returns either
ERXKey.Type.Attribute
or
ERXKey.Type.NonModelAttribute
, false
otherwise.isToOneRelationship
,
isToManyRelationship
public boolean isToOneRelationship()
ERXKey.Type
to determine if it represents a
to-one EORelationship
.
Note: if type()
has not been set, then this will return
false
. To set it, you have the following options:
setType(Type)
ERXKey(String, Type)
constructor. If this
key was declared in code generated by EOGenerator (i.e. in a _Entity.java
class), you will need to modify your EOGenerator template. See
ERXKey(String, Type)
for details.true
if type()
returns either
ERXKey.Type.ToOneRelationship
or
ERXKey.Type.NonModelToOneRelationship
, false
otherwise.isAttribute
,
isToManyRelationship
public boolean isToManyRelationship()
ERXKey.Type
to determine if it represents a
to-many EORelationship
.
Note: if type()
has not been set, then this will return
false
. To set it, you have the following options:
setType(Type)
ERXKey(String, Type)
constructor. If this
key was declared in code generated by EOGenerator (i.e. in a _Entity.java
class), you will need to modify your EOGenerator template. See
ERXKey(String, Type)
for details.true
if type()
returns either
ERXKey.Type.ToOneRelationship
or
ERXKey.Type.NonModelToOneRelationship
, false
otherwise.isAttribute
,
isToOneRelationship
Copyright © 2002 – 2024 Project Wonder.