er.extensions.eof

Enum ERXKey.Type

java.lang.Object

java.lang.Enum<ERXKey.Type>

er.extensions.eof.ERXKey.Type

All Implemented Interfaces:

Serializable, Comparable<ERXKey.Type>

Enclosing class:

ERXKey<T>

public static enum ERXKey.Type
extends Enum<ERXKey.Type>

Enums to describe the type of key this represents.

Author:

mschrag

Enum Constant Summary

Enum Constants

Enum Constant and Description
Attribute Indicates that this key represents an EOAttribute defined in the EOModel.
NonModelAttribute Indicates that this key represents a visible method or ivar that returns an object of type T, but does not have a corresponding relationship entry in the EOModel and therefore cannot be used to instantiate objects that will impact SQL generation.
NonModelToManyRelationship Indicates that this key represents a visible instance member that returns an array of EOEnterpriseObject instances of type T, but does not have a corresponding relationship entry in the EOModel and therefore cannot be used to instantiate objects that will impact SQL generation.
NonModelToOneRelationship Indicates that this key represents a visible instance member that returns an instance of EOEnterpriseObject of type T, but does not have a corresponding relationship entry in the EOModel and therefore cannot be used to instantiate objects that will impact SQL generation.
Operator Indicates that this key represents an NSArray.Operator, e.g., @sum, @flatten, @fetchSpec, @min
ToManyRelationship Indicates that this key represents an EORelationship defined in the EOModel that will return true for EORelationship.isToMany().
ToOneRelationship Indicates that this key represents an EORelationship defined in the EOModel that will return false for EORelationship.isToMany().

Method Summary

Modifier and Type	Method and Description
static ERXKey.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static ERXKey.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Attribute

public static final ERXKey.Type Attribute

Indicates that this key represents an EOAttribute defined in the EOModel. Since it is defined in the model it can be used when instantiating Objects that impact SQL generation, e.g., EOQualifier and EOSortOrdering.

ToOneRelationship

public static final ERXKey.Type ToOneRelationship

Indicates that this key represents an EORelationship defined in the EOModel that will return false for EORelationship.isToMany(). Since it is defined in the model it can be used when instantiating Objects that impact SQL generation, e.g., EOQualifier and EOSortOrdering.

ToManyRelationship

public static final ERXKey.Type ToManyRelationship

Indicates that this key represents an EORelationship defined in the EOModel that will return true for EORelationship.isToMany(). Since it is defined in the model it can be used when instantiating Objects that impact SQL generation, e.g., EOQualifier and EOSortOrdering.

Operator

public static final ERXKey.Type Operator

Indicates that this key represents an NSArray.Operator, e.g., @sum, @flatten, @fetchSpec, @min

Note: this Type is not recognized by the ERXKeyFilter#matches(ERXKey, Type) and will not be included in ERXKeyFilter.includeAll(), ERXKeyFilter.includeAttributes() nor ERXKeyFilter.includeAttributesAndToOneRelationships() because ERXKeyFilter can only be used with ERXKeys that represent a single key NSArray.Operators represent a keypath.

NonModelAttribute

public static final ERXKey.Type NonModelAttribute

Indicates that this key represents a visible method or ivar that returns an object of type T, but does not have a corresponding relationship entry in the EOModel and therefore cannot be used to instantiate objects that will impact SQL generation. e.g., EOQualifier and EOSortOrdering.

Note: this ERXKey.Type is not recognized by the ERXKeyFilter#matches(ERXKey, Type) and will not be included in ERXKeyFilter.includeAll(), ERXKeyFilter.includeAttributes() nor ERXKeyFilter.includeAttributesAndToOneRelationships().

TODO: Additional work needs to be done to validate that ERRest's use of ERXKeyFilter is compatible with this ERXKey.Type.

NonModelToOneRelationship

public static final ERXKey.Type NonModelToOneRelationship

Indicates that this key represents a visible instance member that returns an instance of EOEnterpriseObject of type T, but does not have a corresponding relationship entry in the EOModel and therefore cannot be used to instantiate objects that will impact SQL generation. e.g., EOQualifier and EOSortOrdering.

Note: this ERXKey.Type is not recognized by the ERXKeyFilter#matches(ERXKey, Type) and will not be included in ERXKeyFilter.includeAll(), ERXKeyFilter.includeAttributes() nor ERXKeyFilter.includeAttributesAndToOneRelationships().

TODO: Additional work needs to be done to validate that ERRest's use of ERXKeyFilter is compatible with this ERXKey.Type.

NonModelToManyRelationship

public static final ERXKey.Type NonModelToManyRelationship

Indicates that this key represents a visible instance member that returns an array of EOEnterpriseObject instances of type T, but does not have a corresponding relationship entry in the EOModel and therefore cannot be used to instantiate objects that will impact SQL generation. e.g., EOQualifier and EOSortOrdering.

Note: this ERXKey.Type is not recognized by the ERXKeyFilter#matches(ERXKey, Type) and will not be included in ERXKeyFilter.includeAll(), ERXKeyFilter.includeAttributes() nor ERXKeyFilter.includeAttributesAndToOneRelationships().

TODO: Additional work needs to be done to validate that ERRest's use of ERXKeyFilter is compatible with this ERXKey.Type.

Method Detail

values

public static ERXKey.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ERXKey.Type c : ERXKey.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ERXKey.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null