ERXKey< T > Class Reference

Collaboration diagram for ERXKey< T >:

Collaboration graph
[legend]

List of all members.

Classes

interface  ValueCoding

Public Types

enum  Type { Attribute, ToOneRelationship, ToManyRelationship }

Public Member Functions

ERXKeyComparisonQualifier after (ERXKey<?extends NSTimestamp > when)
ERXKeyValueQualifier after (NSTimestamp when)
NSArray< T > arrayValueInObject (Object obj)
ERXSortOrdering asc ()
ERXSortOrdering ascInsensitive ()
ERXSortOrdering.ERXSortOrderings ascInsensitives ()
ERXSortOrdering.ERXSortOrderings ascs ()
ERXKey< BigDecimal > atAvg ()
ERXKey< BigDecimal > atAvg (ERXKey<?> key)
ERXKey< BigDecimal > atAvgNonNull ()
ERXKey< BigDecimal > atAvgNonNull (ERXKey<?> key)
ERXKey< Integer > atCount ()
ERXKey< Boolean > atIsEmpty ()
ERXKey< BigDecimal > atMedian (ERXKey<?> key)
ERXKey< BigDecimal > atMedian ()
ERXKey< BigDecimal > atPopStdDev (ERXKey<?> key)
ERXKey< BigDecimal > atPopStdDev ()
ERXKey< BigDecimal > atStdDev (ERXKey<?> key)
ERXKey< BigDecimal > atStdDev ()
ERXKey< BigDecimal > atSum ()
ERXKey< BigDecimal > atSum (ERXKey<?> key)
ERXKeyComparisonQualifier before (ERXKey<?extends NSTimestamp > when)
ERXKeyValueQualifier before (NSTimestamp when)
EOQualifier between (T lowerBound, T upperBound, boolean inclusive)
EOQualifier between (T lowerBound, T upperBound)
ERXKeyValueQualifier contains (String value)
ERXAndQualifier containsAll (String[] tokens)
ERXAndQualifier containsAll (String tokens)
ERXOrQualifier containsAny (String[] tokens)
ERXOrQualifier containsAny (String tokens)
ERXKeyValueQualifier containsObject (Object obj)
ERXSortOrdering desc ()
ERXSortOrdering descInsensitive ()
ERXSortOrdering.ERXSortOrderings descInsensitives ()
ERXSortOrdering.ERXSortOrderings descs ()
ERXKeyValueQualifier endsWith (String value)
ERXKeyValueQualifier endsWithInsensitive (String value)
ERXKeyComparisonQualifier eq (ERXKey< T > value)
ERXKeyValueQualifier eq (T value)
boolean equals (Object obj)
 ERXKey (String key)
ERXKeyComparisonQualifier greaterThan (ERXKey< T > value)
ERXKeyValueQualifier greaterThan (T value)
ERXKeyComparisonQualifier greaterThanOrEqualTo (ERXKey< T > value)
ERXKeyValueQualifier greaterThanOrEqualTo (T value)
ERXKeyComparisonQualifier gt (ERXKey< T > value)
ERXKeyValueQualifier gt (T value)
ERXKeyComparisonQualifier gte (ERXKey< T > value)
ERXKeyValueQualifier gte (T value)
int hashCode ()
ERXKeyValueQualifier hasValues (NSArray< T > values)
ERXKeyValueQualifier ilike (String value)
ERXOrQualifier in (NSArray< T > values)
ERXOrQualifier inObjects (T...values)
ERXKeyComparisonQualifier is (ERXKey< T > value)
ERXKeyValueQualifier is (T value)
ERXKeyValueQualifier isFalse ()
ERXKeyComparisonQualifier isNot (ERXKey< T > value)
ERXKeyValueQualifier isNot (T value)
ERXKeyValueQualifier isNotNull ()
ERXKeyValueQualifier isNull ()
ERXKeyValueQualifier isTrue ()
ERXKeyValueQualifier isUnlessNull (T value)
String key ()
ERXKeyComparisonQualifier lessThan (ERXKey< T > value)
ERXKeyValueQualifier lessThan (T value)
ERXKeyComparisonQualifier lessThanOrEqualTo (ERXKey< T > value)
ERXKeyValueQualifier lessThanOrEqualTo (T value)
ERXKeyValueQualifier like (String value)
ERXKeyValueQualifier likeInsensitive (String value)
ERXKeyComparisonQualifier lt (ERXKey< T > value)
ERXKeyValueQualifier lt (T value)
ERXKeyComparisonQualifier lte (ERXKey< T > value)
ERXKeyValueQualifier lte (T value)
ERXKeyComparisonQualifier ne (ERXKey< T > value)
ERXKeyValueQualifier ne (T value)
ERXAndQualifier notIn (NSArray< T > values)
EOQualifier prefix (EOQualifier qualifier)
Object rawValueInObject (Object obj)
ERXKeyValueQualifier startsWith (String value)
ERXKeyValueQualifier startsWithInsensitive (String value)
void takeValueInObject (T value, Object obj)
String toString ()
valueInObject (Object obj)

Static Public Member Functions

static ERXKey< BigDecimal > avg ()
static ERXKey< BigDecimal > avg (ERXKey<?> key)
static ERXKey< BigDecimal > avgNonNull ()
static ERXKey< BigDecimal > avgNonNull (ERXKey<?> key)
static ERXKey< Integer > count ()
static< U > ERXKey< U > fetchSpec (String fetchSpecName)
static< U > ERXKey< NSArray< U > > fetchSpec (String fetchSpecName, ERXKey< U > key)
static< U > ERXKey< U > flatten ()
static< U > ERXKey< NSArray< U > > flatten (ERXKey< U > key)
static ERXKey< Boolean > isEmpty ()
static< U > ERXKey< U > limit (Integer limit)
static< U > ERXKey< NSArray< U > > limit (Integer limit, ERXKey< U > key)
static< U > ERXKey< U > max ()
static< U > ERXKey< U > max (ERXKey< U > key)
static ERXKey< BigDecimal > median (ERXKey<?> key)
static ERXKey< BigDecimal > median ()
static< U > ERXKey< U > min ()
static< U > ERXKey< U > min (ERXKey< U > key)
static< U > ERXKey< U > objectAtIndex (Integer index)
static< U > ERXKey< U > objectAtIndex (Integer index, ERXKey< U > key)
static ERXKey< BigDecimal > popStdDev (ERXKey<?> key)
static ERXKey< BigDecimal > popStdDev ()
static< U > ERXKey< U > removeNullValues ()
static< U > ERXKey< U > removeNullValues (ERXKey< U > key)
static< U > ERXKey< U > reverse ()
static< U > ERXKey< NSArray< U > > reverse (ERXKey< U > key)
static< U > ERXKey< U > sort (ERXKey<?>...sortKeys)
static< U > ERXKey< U > sortAsc (ERXKey<?>...sortKeys)
static< U > ERXKey< U > sortDesc (ERXKey<?>...sortKeys)
static< U > ERXKey< U > sortInsensitiveAsc (ERXKey<?>...sortKeys)
static< U > ERXKey< U > sortInsensitiveDesc (ERXKey<?>...sortKeys)
static ERXKey< BigDecimal > stdDev (ERXKey<?> key)
static ERXKey< BigDecimal > stdDev ()
static< U > ERXKey< U > subarrayWithRange (NSRange range)
static< U > ERXKey< NSArray< U > > subarrayWithRange (NSRange range, ERXKey< U > key)
static ERXKey< BigDecimal > sum ()
static ERXKey< BigDecimal > sum (ERXKey<?> key)
static< U > ERXKey< U > unique ()
static< U > ERXKey< NSArray< U > > unique (ERXKey< U > key)

Package Functions

public< U > ERXKey< U > append (ERXKey< U > key)
public< U > ERXKey< U > append (String key)
public< U > ERXKey< NSArray< U > > appendAsArray (ERXKey< U > key)
public< U > ERXKey< U > atFetchSpec (String fetchSpecName)
public< U > ERXKey< NSArray< U > > atFetchSpec (String fetchSpecName, ERXKey< U > key)
public< U > ERXKey< U > atFlatten ()
public< U > ERXKey< NSArray< U > > atFlatten (ERXKey< U > key)
public< U > ERXKey< U > atLimit (Integer limit)
public< U > ERXKey< NSArray< U > > atLimit (Integer limit, ERXKey< U > key)
public< U > ERXKey< U > atMax ()
public< U > ERXKey< U > atMax (ERXKey< U > key)
public< U > ERXKey< U > atMin ()
public< U > ERXKey< U > atMin (ERXKey< U > key)
public< U > ERXKey< U > atObjectAtIndex (Integer index)
public< U > ERXKey< U > atObjectAtIndex (Integer index, ERXKey< U > key)
public< U > ERXKey< U > atRemoveNullValues ()
public< U > ERXKey< U > atRemoveNullValues (ERXKey< U > key)
public< U > ERXKey< U > atReverse ()
public< U > ERXKey< NSArray< U > > atReverse (ERXKey< U > key)
public< U > ERXKey< U > atSort (ERXKey<?>...sortKeys)
public< U > ERXKey< U > atSortAsc (ERXKey<?>...sortKeys)
public< U > ERXKey< U > atSortDesc (ERXKey<?>...sortKeys)
public< U > ERXKey< U > atSortInsensitiveAsc (ERXKey<?>...sortKeys)
public< U > ERXKey< U > atSortInsensitiveDesc (ERXKey<?>...sortKeys)
public< U > ERXKey< U > atSubarrayWithRange (NSRange range)
public< U > ERXKey< NSArray< U > > atSubarrayWithRange (NSRange range, ERXKey< U > key)
public< U > ERXKey< U > atUnique ()
public< U > ERXKey< NSArray< U > > atUnique (ERXKey< U > key)
public< U > ERXKey< U > dot (ERXKey< U > key)
public< U > ERXKey< U > dot (String key)
public< U > ERXKey< NSArray< U > > dotArray (ERXKey< U > key)

Private Attributes

String _key

Static Private Attributes

static final ERXKey< BigDecimal > AVG = new ERXKey<BigDecimal>("@avg")
static final ERXKey< BigDecimal > AVG_NON_NULL = new ERXKey<BigDecimal>("@avgNonNull")
static final ERXKey< Integer > COUNT = new ERXKey<Integer>("@count")
static final ERXKey<?> FETCH_SPEC = new ERXKey<Object>("@fetchSpec")
static final ERXKey<?> FLATTEN = new ERXKey<Object>("@flatten")
static final ERXKey< Boolean > IS_EMPTY = new ERXKey<Boolean>("@isEmpty")
static final ERXKey<?> LIMIT = new ERXKey<Object>("@limit")
static final ERXKey<?> MAX = new ERXKey<Object>("@max")
static final ERXKey< BigDecimal > MEDIAN = new ERXKey<BigDecimal>("@median")
static final ERXKey<?> MIN = new ERXKey<Object>("@min")
static final ERXKey<?> OBJECT_AT_INDEX = new ERXKey<Object>("@objectAtIndex")
static final ERXKey< BigDecimal > POP_STD_DEV = new ERXKey<BigDecimal>("@popStdDev")
static final ERXKey<?> REMOVE_NULL_VALUES = new ERXKey<Object>("@removeNullValues")
static final ERXKey<?> REVERSE = new ERXKey<Object>("@reverse")
static final ERXKey<?> SORT = new ERXKey<Object>("@sort")
static final ERXKey<?> SORT_ASC = new ERXKey<Object>("@sortAsc")
static final ERXKey<?> SORT_DESC = new ERXKey<Object>("@sortDesc")
static final ERXKey<?> SORT_INSENSITIVE_ASC = new ERXKey<Object>("@sortInsensitiveAsc")
static final ERXKey<?> SORT_INSENSITIVE_DESC = new ERXKey<Object>("@sortInsensitiveDesc")
static final ERXKey< BigDecimal > STD_DEV = new ERXKey<BigDecimal>("@stdDev")
static final ERXKey<?> SUBARRAY_WITH_RANGE = new ERXKey<Object>("@subarrayWithRange")
static final ERXKey< BigDecimal > SUM = new ERXKey<BigDecimal>("@sum")
static final ERXKey<?> UNIQUE = new ERXKey<Object>("@unique")


Detailed Description

ERXKey provides a rich wrapper around a keypath. When combined with chainable qualifiers, ERXKey provides a starting point for the qualifier chain. As an example:

 <code>
 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));
 </code>
 

Parameters:
<T> the type of the value of this key
Author:
mschrag

Member Enumeration Documentation

enum Type

Enums to desribe the type of key this represents.

Author:
mschrag
Enumerator:
Attribute 
ToOneRelationship 
ToManyRelationship 


Constructor & Destructor Documentation

ERXKey ( String  key  ) 

Constructs an ERXKey.

Parameters:
key the underlying keypath


Member Function Documentation

ERXKeyComparisonQualifier after ( ERXKey<?extends NSTimestamp >  when  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorGreaterThan, value);

Parameters:
when the date to compare with
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier after ( NSTimestamp  when  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorGreaterThan, value);

Parameters:
when the date to compare with
Returns:
an ERXKeyValueQualifier

public<U> ERXKey<U> append ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that appends the given key to this keypath. For instance, if this key is "person" and you add "firstName" to it, this will return a new ERXKey "person.firstName".

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.

Parameters:
<U> the type of the next key
key the key to append to this keypath
Returns:
the new appended key

public<U> ERXKey<U> append ( String  key  )  [package]

Returns a new ERXKey that appends the given key to this keypath. For instance, if this key is "person" and you add "firstName" to it, this will return a new ERXKey "person.firstName".

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.

Parameters:
<U> the type of the next key
key the key to append to this keypath
Returns:
the new appended key

public<U> ERXKey<NSArray<U> > appendAsArray ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that appends the given key to this keypath. For instance, if this key is "person" and you add "firstName" to it, this will return a new ERXKey "person.firstName".

 <code>
 		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);
 </code>
 

Parameters:
<U> the type of the next key in the array
key the key to append to this keypath
Returns:
the new appended key

NSArray<T> arrayValueInObject ( Object  obj  ) 

Returns the value of this keypath on the given object cast as an NSArray.

Parameters:
obj the target object to apply this keypath on
Returns:
the value of the keypath on the target object

ERXSortOrdering asc (  ) 

Equivalent to ERXS.asc(key())

Returns:
asc sort ordering for key

ERXSortOrdering ascInsensitive (  ) 

Equivalent to ERXS.ascInsensitive(key())

Returns:
ascInsensitive sort ordering for key

ERXSortOrdering.ERXSortOrderings ascInsensitives (  ) 

Equivalent to ERXS.ascInsensitives(key())

Returns:
ascInsensitive sort ordering for key

ERXSortOrdering.ERXSortOrderings ascs (  ) 

Equivalent to ERXS.ascs(key())

Returns:
asc sort ordering for key

ERXKey<BigDecimal> atAvg (  ) 

Returns a new ERXKey that uses NSArray's AVERAGE aggregate operator .

Returns:
the new key

ERXKey<BigDecimal> atAvg ( ERXKey<?>  key  ) 

Returns a new ERXKey that prepends the given key with NSArray's AVERAGE aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@avg.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key

ERXKey<BigDecimal> atAvgNonNull (  ) 

Returns a new ERXKey that appends ERXArrayUtilities' avgNonNull aggregate operator .

Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.AvgNonNullOperator AvgNonNullOperator

ERXKey<BigDecimal> atAvgNonNull ( ERXKey<?>  key  ) 

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' avgNonNull aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@avgNonNull.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.AvgNonNullOperator AvgNonNullOperator

ERXKey<Integer> atCount (  ) 

Returns a new ERXKey that uses NSArray's COUNT operator . Since any keypath beyond is ignored, only a no arg method is available.

Returns:
the new key

public<U> ERXKey<U> atFetchSpec ( String  fetchSpecName  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' fetchSpec operator . For instance, if the fetchSpecName is "newHomes" this will return a new ERXKey "@fetchSpec.newHomes".

Parameters:
fetchSpecName the fetchSpec name
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FetchSpecOperator FetchSpecOperator

public<U> ERXKey<NSArray<U> > atFetchSpec ( String  fetchSpecName,
ERXKey< U >  key 
) [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' fetchSpec operator . For instance, if the key is "price" and fetchSpecName is "newHomes" this will return a new ERXKey "@fetchSpec.newHomes.price".

Parameters:
fetchSpecName the fetchSpec name
<U> the type of the next key
key the key to use for this keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FetchSpecOperator FetchSpecOperator

public<U> ERXKey<U> atFlatten (  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' flatten operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FlattenOperator FlattenOperator

public<U> ERXKey<NSArray<U> > atFlatten ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' flatten operator . For instance, if the key is "price" this will return a new ERXKey "@flatten.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FlattenOperator FlattenOperator

ERXKey<Boolean> atIsEmpty (  ) 

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' isEmpty operator . Since any keypath beyond is ignored, only a no arg method is available.

Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.IsEmptyOperator IsEmptyOperator

public<U> ERXKey<U> atLimit ( Integer  limit  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' limit operator . For instance, if the limit is 3 this will return a new ERXKey "@limit.3".

Parameters:
limit the maximum number of objects allowed by the limit
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.LimitOperator LimitOperator

public<U> ERXKey<NSArray<U> > atLimit ( Integer  limit,
ERXKey< U >  key 
) [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' limit operator . For instance, if the key is "price" and limit is 3 this will return a new ERXKey "@limit.3.price".

Parameters:
limit the maximum number of objects allowed by the limit
<U> the type of the next key
key the key to use for this keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.LimitOperator LimitOperator

public<U> ERXKey<U> atMax (  )  [package]

Returns a new ERXKey that uses NSArray's MAX aggregate operator .

Parameters:
<U> the type of the next key
Returns:
the new key

public<U> ERXKey<U> atMax ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that prepends the given key with NSArray's MAX aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@max.price".

Parameters:
<U> the type of the next key
key the key to use for this aggregate keypath
Returns:
the new appended key

ERXKey<BigDecimal> atMedian ( ERXKey<?>  key  ) 

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' median aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@median.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.MedianOperator MedianOperator

ERXKey<BigDecimal> atMedian (  ) 

Returns a new ERXKey that appends the given key with ERXArrayUtilities' median aggregate operator .

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.MedianOperator MedianOperator

public<U> ERXKey<U> atMin (  )  [package]

Returns a new ERXKey that uses NSArray's MIN aggregate operator .

Parameters:
<U> the type of the next key
Returns:
the new key

public<U> ERXKey<U> atMin ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that prepends the given key with NSArray's MIN aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@min.price".

Parameters:
<U> the type of the next key
key the key to use for this aggregate keypath
Returns:
the new appended key

public<U> ERXKey<U> atObjectAtIndex ( Integer  index  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' objectAtIndex operator . For instance, if the index is 3 then this will return a new ERXKey "@objectAtIndex.3".

Parameters:
<U> the type of the next key
index The index of the object to return from the array
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ObjectAtIndexOperator ObjectAtIndexOperator

public<U> ERXKey<U> atObjectAtIndex ( Integer  index,
ERXKey< U >  key 
) [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' objectAtIndex operator . For instance, if the index is 3 and the key is "price" then this will return a new ERXKey "@objectAtIndex.3.price".

Parameters:
<U> the type of the next key
index The index of the object to return from the array
key the key following the operator
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ObjectAtIndexOperator ObjectAtIndexOperator

ERXKey<BigDecimal> atPopStdDev ( ERXKey<?>  key  ) 

Returns a new ERXKey that uses Wonder's standard deviation operator

Parameters:
key the key to append
Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

ERXKey<BigDecimal> atPopStdDev (  ) 

Returns a new ERXKey that uses Wonder's standard deviation operator

Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

public<U> ERXKey<U> atRemoveNullValues (  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' RemoveNullValues operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.RemoveNullValuesOperator RemoveNullValuesOperator

public<U> ERXKey<U> atRemoveNullValues ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' RemoveNullValues operator . For instance, if the key is "price" this will return a new ERXKey "@removeNullValues.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.RemoveNullValuesOperator RemoveNullValuesOperator

public<U> ERXKey<U> atReverse (  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Reverse operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ReverseOperator ReverseOperator

public<U> ERXKey<NSArray<U> > atReverse ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Reverse operator . For instance, if the key is "price" this will return a new ERXKey "@reverse.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ReverseOperator ReverseOperator

public<U> ERXKey<U> atSort ( ERXKey<?>...  sortKeys  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Sort operator . For instance, atSort(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

public<U> ERXKey<U> atSortAsc ( ERXKey<?>...  sortKeys  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortAsc operator . For instance, atSortAsc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

public<U> ERXKey<U> atSortDesc ( ERXKey<?>...  sortKeys  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortDescending operator . For instance, atSortDesc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

public<U> ERXKey<U> atSortInsensitiveAsc ( ERXKey<?>...  sortKeys  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortInsensitiveAscending operator . For instance, atSortInsensitiveAsc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

public<U> ERXKey<U> atSortInsensitiveDesc ( ERXKey<?>...  sortKeys  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortInsensitiveDescending operator . For instance, atSortInsensitiveDesc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

ERXKey<BigDecimal> atStdDev ( ERXKey<?>  key  ) 

Returns a new ERXKey that uses Wonder's standard deviation operator

Parameters:
key the key to append
Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

ERXKey<BigDecimal> atStdDev (  ) 

Returns a new ERXKey that uses Wonder's standard deviation operator

Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

public<U> ERXKey<U> atSubarrayWithRange ( NSRange  range  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SubarrayWithRange operator . For instance, if the range is new NSRange(4,2) this will return a new ERXKey "@subarrayWithRange.4-2.price".

Parameters:
range the range for the operator
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SubarrayWithRangeOperator SubarrayWithRangeOperator

public<U> ERXKey<NSArray<U> > atSubarrayWithRange ( NSRange  range,
ERXKey< U >  key 
) [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SubarrayWithRange operator . 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".

Parameters:
key the key to use for this keypath
range the range for the operator
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SubarrayWithRangeOperator SubarrayWithRangeOperator

ERXKey<BigDecimal> atSum (  ) 

Returns a new ERXKey that uses NSArray's SUM aggregate operator .

Returns:
the new key

ERXKey<BigDecimal> atSum ( ERXKey<?>  key  ) 

Returns a new ERXKey that prepends the given key with NSArray's SUM aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@sum.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key

public<U> ERXKey<U> atUnique (  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Unique operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.UniqueOperator UniqueOperator

public<U> ERXKey<NSArray<U> > atUnique ( ERXKey< U >  key  )  [package]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Unique operator . For instance, if the key is "price" this will return a new ERXKey "@unique.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.UniqueOperator UniqueOperator

static ERXKey<BigDecimal> avg (  )  [static]

Returns a new ERXKey that uses NSArray's AVERAGE aggregate operator .

Returns:
the new key

static ERXKey<BigDecimal> avg ( ERXKey<?>  key  )  [static]

Returns a new ERXKey that prepends the given key with NSArray's AVERAGE aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@avg.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key

static ERXKey<BigDecimal> avgNonNull (  )  [static]

Returns ERXArrayUtilities' avgNonNull aggregate operator .

Returns:
the avgNonNull key
See also:
er.extensions.foundation.ERXArrayUtilities.AvgNonNullOperator AvgNonNullOperator

static ERXKey<BigDecimal> avgNonNull ( ERXKey<?>  key  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' avgNonNull aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@avgNonNull.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.AvgNonNullOperator AvgNonNullOperator

ERXKeyComparisonQualifier before ( ERXKey<?extends NSTimestamp >  when  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorLessThan, value);

Parameters:
when the date to compare with
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier before ( NSTimestamp  when  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorLessThan, value);

Parameters:
when the date to compare with
Returns:
an ERXKeyValueQualifier

EOQualifier between ( lowerBound,
upperBound,
boolean  inclusive 
)

Equivalent to key >= lowerBound and key <= upperBound (inclusive). Note that this does not return an ERXBetweenQualifier.

Parameters:
lowerBound the lower bound value
upperBound the upper bound value
inclusive whether or not the between includes the endpoints
Returns:
the qualifier

EOQualifier between ( lowerBound,
upperBound 
)

Equivalent to key > lowerBound and key < upperBound (exclusive). Note that this does not return an ERXBetweenQualifier.

Parameters:
lowerBound the lower bound value
upperBound the upper bound value
Returns:
the qualifier

ERXKeyValueQualifier contains ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorCaseInsensitiveLike, "*" + value + "*").

Parameters:
value the substring value
Returns:
an ERXKeyValueQualifier

ERXAndQualifier containsAll ( String[]  tokens  ) 

Returns a qualifier that evalutes to true when the value of the given key contains all of the given tokens (insensitively).

Parameters:
tokens the list of tokens to search for
Returns:
an ERXAndQualifier

ERXAndQualifier containsAll ( String  tokens  ) 

Returns a qualifier that evalutes to true when the value of the given key contains all of the given tokens (insensitively) in the search string. The search string will be tokenized by splitting on space characters.

Parameters:
tokens a whitespace separated list of tokens to search for
Returns:
an ERXAndQualifier

ERXOrQualifier containsAny ( String[]  tokens  ) 

Returns a qualifier that evalutes to true when the value of the given key contains any of the given tokens (insensitively).

Parameters:
tokens the list of tokens to search for
Returns:
an ERXOrQualifier

ERXOrQualifier containsAny ( String  tokens  ) 

Returns a qualifier that evalutes to true when the value of the given key contains any of the given tokens (insensitively) in the search string. The search string will be tokenized by splitting on space characters.

Parameters:
tokens a whitespace separated list of tokens to search for
Returns:
an ERXOrQualifier

ERXKeyValueQualifier containsObject ( Object  obj  ) 

Returns a qualifier that evaluates to true when the given to many key contains the given object.

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorContains, value).

Parameters:
obj the object
Returns:
an EOKeyValueQualifier

static ERXKey<Integer> count (  )  [static]

Returns a new ERXKey that uses NSArray's COUNT operator . Since any keypath beyond is ignored, only a no arg method is available.

Returns:
the new key

ERXSortOrdering desc (  ) 

Equivalent to ERXS.desc(key())

Returns:
desc sort ordering for key

ERXSortOrdering descInsensitive (  ) 

Equivalent to ERXS.descInsensitive(key())

Returns:
descInsensitive sort ordering for key

ERXSortOrdering.ERXSortOrderings descInsensitives (  ) 

Equivalent to ERXS.descInsensitives(key())

Returns:
descInsensitive sort ordering for key

ERXSortOrdering.ERXSortOrderings descs (  ) 

Equivalent to ERXS.descs(key())

Returns:
desc sort ordering for key

public<U> ERXKey<U> dot ( ERXKey< U >  key  )  [package]

Calls append(key)

Parameters:
<U> the key type
key the key to append to this keypath
Returns:
the new appended key

public<U> ERXKey<U> dot ( String  key  )  [package]

Calls append(key)

Parameters:
<U> the key type
key the key to append to this keypath
Returns:
the new appended key

public<U> ERXKey<NSArray<U> > dotArray ( ERXKey< U >  key  )  [package]

Calls appendAsArray(key).

Parameters:
<U> the type
key the key to append to this keypath
Returns:
the new append to this keypath

ERXKeyValueQualifier endsWith ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorLike, "*" + value).

Parameters:
value the substring value
Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier endsWithInsensitive ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorCaseInsensitiveLike, "*" + value).

Parameters:
value the substring value
Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier eq ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorEqual, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier eq ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorEqual, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

boolean equals ( Object  obj  ) 

static <U> ERXKey<U> fetchSpec ( String  fetchSpecName  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' fetchSpec operator . For instance, if the fetchSpecName is "newHomes" this will return a new ERXKey "@fetchSpec.newHomes".

Parameters:
fetchSpecName the fetchSpec name
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FetchSpecOperator FetchSpecOperator

static <U> ERXKey<NSArray<U> > fetchSpec ( String  fetchSpecName,
ERXKey< U >  key 
) [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' fetchSpec operator . For instance, if the key is "price" and fetchSpecName is "newHomes" this will return a new ERXKey "@fetchSpec.newHomes.price".

Parameters:
fetchSpecName the fetchSpec name
<U> the type of the next key
key the key to use for this keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FetchSpecOperator FetchSpecOperator

static <U> ERXKey<U> flatten (  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' flatten operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FlattenOperator FlattenOperator

static <U> ERXKey<NSArray<U> > flatten ( ERXKey< U >  key  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' flatten operator . For instance, if the key is "price" this will return a new ERXKey "@flatten.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.FlattenOperator FlattenOperator

ERXKeyComparisonQualifier greaterThan ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorGreaterThan, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier greaterThan ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorGreaterThan, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier greaterThanOrEqualTo ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier greaterThanOrEqualTo ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier gt ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorGreaterThan, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier gt ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorGreaterThan, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier gte ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier gte ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorGreaterThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

int hashCode (  ) 

ERXKeyValueQualifier hasValues ( NSArray< T >  values  ) 

Equivalent to new ERXInQualifier(key, values);

Parameters:
values the values
Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier ilike ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorCaseInsensitiveLike, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXOrQualifier in ( NSArray< T >  values  ) 

Equivalent to a new ERXOrQualifier of EOKeyValueQualifier with key equals value for each value.

Parameters:
values the values
Returns:
an ERXOrQualifier

ERXOrQualifier inObjects ( T...  values  ) 

Equivalent to a new ERXOrQualifier of EOKeyValueQualifier with key equals value for each value.

Parameters:
values the values
Returns:
an ERXOrQualifier

ERXKeyComparisonQualifier is ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorEqual, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier is ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorEqual, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

static ERXKey<Boolean> isEmpty (  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' isEmpty operator . Since any keypath beyond is ignored, only a no arg method is available.

Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.IsEmptyOperator IsEmptyOperator

ERXKeyValueQualifier isFalse (  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorEqual, Boolean.FALSE);

Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier isNot ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorNotEqual, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier isNot ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorNotEqual, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier isNotNull (  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorNotEqual, null);

Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier isNull (  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorEqual, null);

Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier isTrue (  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorEqual, Boolean.TRUE);

Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier isUnlessNull ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorEqual, value) only if the value is not null. If the value is null, this will return null, allowing you to conditionally chain an equals only if the value is non-null.

Parameters:
value the value
Returns:
an ERXKeyValueQualifier or null

String key (  ) 

Returns the keypath that this ERXKey represents.

Returns:
the keypath that this ERXKey represents

ERXKeyComparisonQualifier lessThan ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorLessThan, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier lessThan ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorLessThan, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier lessThanOrEqualTo ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorLessThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier lessThanOrEqualTo ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorLessThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier like ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorLike, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier likeInsensitive ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorCaseInsensitiveLike, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

static <U> ERXKey<U> limit ( Integer  limit  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' limit operator . For instance, if the limit is 3 this will return a new ERXKey "@limit.3".

Parameters:
limit the maximum number of objects allowed by the limit
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.LimitOperator LimitOperator

static <U> ERXKey<NSArray<U> > limit ( Integer  limit,
ERXKey< U >  key 
) [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' limit operator . For instance, if the key is "price" and limit is 3 this will return a new ERXKey "@limit.3.price".

Parameters:
limit the maximum number of objects allowed by the limit
<U> the type of the next key
key the key to use for this keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.LimitOperator LimitOperator

ERXKeyComparisonQualifier lt ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorLessThan, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier lt ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorLessThan, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXKeyComparisonQualifier lte ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorLessThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier lte ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorLessThanOrEqualTo, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

static <U> ERXKey<U> max (  )  [static]

Returns a new ERXKey that uses NSArray's MAX aggregate operator .

Parameters:
<U> the type of the next key
Returns:
the new key

static <U> ERXKey<U> max ( ERXKey< U >  key  )  [static]

Returns a new ERXKey that prepends the given key with NSArray's MAX aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@max.price".

Parameters:
<U> the type of the next key
key the key to use for this aggregate keypath
Returns:
the new appended key

static ERXKey<BigDecimal> median ( ERXKey<?>  key  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' median aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@median.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.MedianOperator MedianOperator

static ERXKey<BigDecimal> median (  )  [static]

Returns ERXArrayUtilities' median aggregate operator .

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.MedianOperator MedianOperator

static <U> ERXKey<U> min (  )  [static]

Returns a new ERXKey that uses NSArray's MIN aggregate operator .

Parameters:
<U> the type of the next key
Returns:
the new key

static <U> ERXKey<U> min ( ERXKey< U >  key  )  [static]

Returns a new ERXKey that prepends the given key with NSArray's MIN aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@min.price".

Parameters:
<U> the type of the next key
key the key to use for this aggregate keypath
Returns:
the new appended key

ERXKeyComparisonQualifier ne ( ERXKey< T >  value  ) 

Equivalent to new ERXKeyComparisonQualifier(key, EOQualifier.QualifierOperatorNotEqual, value);

Parameters:
value the value
Returns:
an ERXKeyComparisonQualifier

ERXKeyValueQualifier ne ( value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.QualifierOperatorNotEqual, value);

Parameters:
value the value
Returns:
an ERXKeyValueQualifier

ERXAndQualifier notIn ( NSArray< T >  values  ) 

Equivalent to a new ERXAndQualifier of EONotQualifier(EOKeyValueQualifier) with key equals value for each value.

Parameters:
values the values
Returns:
an ERXAndQualifier

static <U> ERXKey<U> objectAtIndex ( Integer  index  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' objectAtIndex operator . For instance, if the index is 3 then this will return a new ERXKey "@objectAtIndex.3".

Parameters:
<U> the type of the next key
index The index of the object to return from the array
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ObjectAtIndexOperator ObjectAtIndexOperator

static <U> ERXKey<U> objectAtIndex ( Integer  index,
ERXKey< U >  key 
) [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' objectAtIndex operator . For instance, if the index is 3 and the key is "price" then this will return a new ERXKey "@objectAtIndex.3.price".

Parameters:
<U> the type of the next key
index The index of the object to return from the array
key the key following the operator
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ObjectAtIndexOperator ObjectAtIndexOperator

static ERXKey<BigDecimal> popStdDev ( ERXKey<?>  key  )  [static]

Returns a new ERXKey that uses Wonder's standard deviation operator

Parameters:
key the key to append
Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

static ERXKey<BigDecimal> popStdDev (  )  [static]

Returns a new ERXKey that uses Wonder's standard deviation operator

Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

EOQualifier prefix ( EOQualifier  qualifier  ) 

Prefixes the keys in the given qualifier with this key. For example, if you have a qualifier on Company of name = 'mDT' and you want to find Person eo's whose companies match that qualifier, you need to prefix all the keys in the qualifier to be "company.whatever" (to go through the company relationship on Person) -- so in the example you would need company.name = 'mDT'. Prefix provides a mechanism to do that.

Person.COMPANY.prefix(ERXQ.is("name", "mDT")) is equivalent to ERXQ.is("company.name", "mDT")

Parameters:
qualifier the qualifier to prefix
Returns:
a qualifier with all of its keys prefixed with this key

Object rawValueInObject ( Object  obj  ) 

Returns the value of this keypath on the given object.

Parameters:
obj the target object to apply this keypath on
Returns:
the value of the keypath on the target object

static <U> ERXKey<U> removeNullValues (  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' RemoveNullValues operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.RemoveNullValuesOperator RemoveNullValuesOperator

static <U> ERXKey<U> removeNullValues ( ERXKey< U >  key  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' RemoveNullValues operator . For instance, if the key is "price" this will return a new ERXKey "@removeNullValues.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.RemoveNullValuesOperator RemoveNullValuesOperator

static <U> ERXKey<U> reverse (  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Reverse operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ReverseOperator ReverseOperator

static <U> ERXKey<NSArray<U> > reverse ( ERXKey< U >  key  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Reverse operator . For instance, if the key is "price" this will return a new ERXKey "@reverse.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.ReverseOperator ReverseOperator

static <U> ERXKey<U> sort ( ERXKey<?>...  sortKeys  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Sort operator . For instance, sort(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

static <U> ERXKey<U> sortAsc ( ERXKey<?>...  sortKeys  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortAscending operator . For instance, sortAsc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

static <U> ERXKey<U> sortDesc ( ERXKey<?>...  sortKeys  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortDescending operator . For instance, sortDesc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

static <U> ERXKey<U> sortInsensitiveAsc ( ERXKey<?>...  sortKeys  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortInsensitiveAscending operator . For instance, sortInsensitiveAsc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

static <U> ERXKey<U> sortInsensitiveDesc ( ERXKey<?>...  sortKeys  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SortInsensitiveDescending operator . For instance, sortInsensitiveDesc(Employee.FIRST_NAME, Employee.LAST_NAME) would return a key like .firstName,lastname

Parameters:
sortKeys the ERXKeys to append for sorting
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SortOperator SortOperator

ERXKeyValueQualifier startsWith ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorLike, value + "*").

Parameters:
value the substring value
Returns:
an ERXKeyValueQualifier

ERXKeyValueQualifier startsWithInsensitive ( String  value  ) 

Equivalent to new ERXKeyValueQualifier(key, EOQualifier.OperatorCaseInsensitiveLike, value + "*").

Parameters:
value the substring value
Returns:
an ERXKeyValueQualifier

static ERXKey<BigDecimal> stdDev ( ERXKey<?>  key  )  [static]

Returns a new ERXKey that uses Wonder's standard deviation operator

Parameters:
key the key to append
Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

static ERXKey<BigDecimal> stdDev (  )  [static]

Returns a new ERXKey that uses Wonder's standard deviation operator

Returns:
the new key
See also:
er.extensions.foundation.ERXArrayUtilities.StandardDeviationOperator StandardDeviationOperator

static <U> ERXKey<U> subarrayWithRange ( NSRange  range  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SubarrayWithRange operator . For instance, if the range is new NSRange(4,2) this will return a new ERXKey "@subarrayWithRange.4-2.price".

Parameters:
range the range for the operator
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SubarrayWithRangeOperator SubarrayWithRangeOperator

static <U> ERXKey<NSArray<U> > subarrayWithRange ( NSRange  range,
ERXKey< U >  key 
) [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' SubarrayWithRange operator . 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".

Parameters:
key the key to use for this keypath
range the range for the operator
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.SubarrayWithRangeOperator SubarrayWithRangeOperator

static ERXKey<BigDecimal> sum (  )  [static]

Returns a new ERXKey that uses NSArray's SUM aggregate operator .

Returns:
the new key

static ERXKey<BigDecimal> sum ( ERXKey<?>  key  )  [static]

Returns a new ERXKey that prepends the given key with NSArray's SUM aggregate operator . For instance, if the key is "price" this will return a new ERXKey "@sum.price".

Parameters:
key the key to use for this aggregate keypath
Returns:
the new appended key

void takeValueInObject ( value,
Object  obj 
)

Sets the value of this keypath on the given object.

Parameters:
value the value to set
obj the object to set the value on

String toString (  ) 

static <U> ERXKey<U> unique (  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Unique operator .

Parameters:
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.UniqueOperator UniqueOperator

static <U> ERXKey<NSArray<U> > unique ( ERXKey< U >  key  )  [static]

Returns a new ERXKey that prepends the given key with ERXArrayUtilities' Unique operator . For instance, if the key is "price" this will return a new ERXKey "@unique.price".

Parameters:
key the key to use for this keypath
<U> the type of the next key
Returns:
the new appended key
See also:
er.extensions.foundation.ERXArrayUtilities.UniqueOperator UniqueOperator

T valueInObject ( Object  obj  ) 

Returns the value of this keypath on the given object.

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.

Parameters:
obj the target object to apply this keypath on
Returns:
the value of the keypath on the target object


Member Data Documentation

String _key [private]

final ERXKey<BigDecimal> AVG = new ERXKey<BigDecimal>("@avg") [static, private]

final ERXKey<BigDecimal> AVG_NON_NULL = new ERXKey<BigDecimal>("@avgNonNull") [static, private]

final ERXKey<Integer> COUNT = new ERXKey<Integer>("@count") [static, private]

final ERXKey<?> FETCH_SPEC = new ERXKey<Object>("@fetchSpec") [static, private]

final ERXKey<?> FLATTEN = new ERXKey<Object>("@flatten") [static, private]

final ERXKey<Boolean> IS_EMPTY = new ERXKey<Boolean>("@isEmpty") [static, private]

final ERXKey<?> LIMIT = new ERXKey<Object>("@limit") [static, private]

final ERXKey<?> MAX = new ERXKey<Object>("@max") [static, private]

final ERXKey<BigDecimal> MEDIAN = new ERXKey<BigDecimal>("@median") [static, private]

final ERXKey<?> MIN = new ERXKey<Object>("@min") [static, private]

final ERXKey<?> OBJECT_AT_INDEX = new ERXKey<Object>("@objectAtIndex") [static, private]

final ERXKey<BigDecimal> POP_STD_DEV = new ERXKey<BigDecimal>("@popStdDev") [static, private]

final ERXKey<?> REMOVE_NULL_VALUES = new ERXKey<Object>("@removeNullValues") [static, private]

final ERXKey<?> REVERSE = new ERXKey<Object>("@reverse") [static, private]

final ERXKey<?> SORT = new ERXKey<Object>("@sort") [static, private]

final ERXKey<?> SORT_ASC = new ERXKey<Object>("@sortAsc") [static, private]

final ERXKey<?> SORT_DESC = new ERXKey<Object>("@sortDesc") [static, private]

final ERXKey<?> SORT_INSENSITIVE_ASC = new ERXKey<Object>("@sortInsensitiveAsc") [static, private]

final ERXKey<?> SORT_INSENSITIVE_DESC = new ERXKey<Object>("@sortInsensitiveDesc") [static, private]

final ERXKey<BigDecimal> STD_DEV = new ERXKey<BigDecimal>("@stdDev") [static, private]

final ERXKey<?> SUBARRAY_WITH_RANGE = new ERXKey<Object>("@subarrayWithRange") [static, private]

final ERXKey<BigDecimal> SUM = new ERXKey<BigDecimal>("@sum") [static, private]

final ERXKey<?> UNIQUE = new ERXKey<Object>("@unique") [static, private]


The documentation for this class was generated from the following file:

Generated on Sat May 26 06:43:11 2012 for Project Wonder by  doxygen 1.5.8