com.yahoo.elide.core.dictionary

Class EntityBinding

java.lang.Object

com.yahoo.elide.core.dictionary.EntityBinding

public class EntityBinding
extends Object

Entity Dictionary maps JSON API Entity beans to/from Entity type names.

See Also:

Include.name()

Field Summary

Fields

Modifier and Type	Field and Description
ConcurrentHashMap<String,String>	aliasesToFields
ConcurrentHashMap<Object,Annotation>	annotations
List<String>	apiAttributes
List<String>	apiRelationships
ConcurrentHashMap<AccessibleObject,Set<ArgumentType>>	attributeArguments
ConcurrentLinkedDeque<String>	attributesDeque
org.apache.commons.collections4.MultiValuedMap<org.apache.commons.lang3.tuple.Pair<LifeCycleHookBinding.Operation,LifeCycleHookBinding.TransactionPhase>,LifeCycleHook>	classTriggers
static Set<ArgumentType>	EMPTY_ATTRIBUTES_ARGS
static EntityBinding	EMPTY_BINDING
ConcurrentHashMap<String,ArgumentType>	entityArguments
Type<?>	entityClass
EntityPermissions	entityPermissions
ConcurrentHashMap<String,Type<?>>	fieldsToTypes
ConcurrentHashMap<String,AccessibleObject>	fieldsToValues
org.apache.commons.collections4.MultiValuedMap<org.apache.commons.lang3.tuple.Triple<String,LifeCycleHookBinding.Operation,LifeCycleHookBinding.TransactionPhase>,LifeCycleHook>	fieldTriggers
boolean	idGenerated
List<Type<?>>	inheritedTypes
String	jsonApiType
ConcurrentLinkedDeque<String>	relationshipsDeque
ConcurrentHashMap<String,javax.persistence.CascadeType[]>	relationshipToCascadeTypes
ConcurrentHashMap<String,String>	relationshipToInverse
ConcurrentHashMap<String,RelationshipType>	relationshipTypes
ConcurrentHashMap<Method,Boolean>	requestScopeableMethods

Constructor Summary

Constructors

Constructor and Description
EntityBinding(EntityDictionary dictionary, Type<?> cls, String type) Constructor
EntityBinding(EntityDictionary dictionary, Type<?> cls, String type, String apiVersion, Set<Class<? extends Annotation>> hiddenAnnotations) Constructor

Method Summary

Modifier and Type	Method and Description
void	addArgumentsToAttribute(String attribute, Set<ArgumentType> arguments) Add a collection of arguments to the attributes of this Entity.
void	addArgumentToEntity(ArgumentType argument) Add argument to this Entity.
void	bindTrigger(LifeCycleHookBinding.Operation operation, LifeCycleHookBinding.TransactionPhase phase, LifeCycleHook hook)
void	bindTrigger(LifeCycleHookBinding.Operation operation, LifeCycleHookBinding.TransactionPhase phase, String fieldOrMethodName, LifeCycleHook hook)
List<AccessibleObject>	getAllFields() Get all fields of the entity class, including fields of superclasses (excluding Object).
List<AccessibleObject>	getAllMethods()
<A extends Annotation> A	getAnnotation(Class<A> annotationClass) Return annotation from class, parents or package.
Set<ArgumentType>	getAttributeArguments(String attribute) Returns the Collection of all attributes of an argument.
Set<ArgumentType>	getEntityArguments() Returns the Collection of all attributes of an Entity.
static String	getFieldName(AccessibleObject fieldOrMethod) Returns name of field whether public member or method.
static Type<?>	getFieldType(Type<?> parentClass, AccessibleObject fieldOrMethod) Returns type of field whether member or method.
static Type<?>	getFieldType(Type<?> parentClass, AccessibleObject fieldOrMethod, Optional<Integer> index) Returns type of field whether member or method.
<A extends Annotation> A	getMethodAnnotation(Class<A> annotationClass, String method) Return annotation for provided method.
Collection<LifeCycleHook>	getTriggers(LifeCycleHookBinding.Operation op, LifeCycleHookBinding.TransactionPhase phase)
Collection<LifeCycleHook>	getTriggers(LifeCycleHookBinding.Operation op, LifeCycleHookBinding.TransactionPhase phase, String fieldName)
static boolean	isComputedMethod(Method method) Check whether or not the provided method described a computed attribute or relationship.
static boolean	isRequestScopeableMethod(Method method) Check whether or not method expects a RequestScope.

Methods inherited from class java.lang.Object

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

Field Detail

entityClass

public final Type<?> entityClass

jsonApiType

public final String jsonApiType

idGenerated

public boolean idGenerated

entityPermissions

public final EntityPermissions entityPermissions

apiAttributes

public final List<String> apiAttributes

apiRelationships

public final List<String> apiRelationships

inheritedTypes

public final List<Type<?>> inheritedTypes

attributesDeque

public final ConcurrentLinkedDeque<String> attributesDeque

relationshipsDeque

public final ConcurrentLinkedDeque<String> relationshipsDeque

relationshipTypes

public final ConcurrentHashMap<String,RelationshipType> relationshipTypes

relationshipToInverse

public final ConcurrentHashMap<String,String> relationshipToInverse

relationshipToCascadeTypes

public final ConcurrentHashMap<String,javax.persistence.CascadeType[]> relationshipToCascadeTypes

fieldsToValues

public final ConcurrentHashMap<String,AccessibleObject> fieldsToValues

fieldTriggers

public final org.apache.commons.collections4.MultiValuedMap<org.apache.commons.lang3.tuple.Triple<String,LifeCycleHookBinding.Operation,LifeCycleHookBinding.TransactionPhase>,LifeCycleHook> fieldTriggers

classTriggers

public final org.apache.commons.collections4.MultiValuedMap<org.apache.commons.lang3.tuple.Pair<LifeCycleHookBinding.Operation,LifeCycleHookBinding.TransactionPhase>,LifeCycleHook> classTriggers

fieldsToTypes

public final ConcurrentHashMap<String,Type<?>> fieldsToTypes

aliasesToFields

public final ConcurrentHashMap<String,String> aliasesToFields

requestScopeableMethods

public final ConcurrentHashMap<Method,Boolean> requestScopeableMethods

attributeArguments

public final ConcurrentHashMap<AccessibleObject,Set<ArgumentType>> attributeArguments

entityArguments

public final ConcurrentHashMap<String,ArgumentType> entityArguments

annotations

public final ConcurrentHashMap<Object,Annotation> annotations

EMPTY_BINDING

public static final EntityBinding EMPTY_BINDING

EMPTY_ATTRIBUTES_ARGS

public static final Set<ArgumentType> EMPTY_ATTRIBUTES_ARGS

Constructor Detail

EntityBinding

public EntityBinding(EntityDictionary dictionary,
                     Type<?> cls,
                     String type)

Constructor

Parameters:

dictionary - Dictionary to use

cls - Entity class

type - Declared Elide type name

EntityBinding

public EntityBinding(EntityDictionary dictionary,
                     Type<?> cls,
                     String type,
                     String apiVersion,
                     Set<Class<? extends Annotation>> hiddenAnnotations)

Constructor

Parameters:

dictionary - Dictionary to use

cls - Entity class

type - Declared Elide type name

hiddenAnnotations - Annotations for hiding a field in API

Method Detail

getAllFields

public List<AccessibleObject> getAllFields()

Get all fields of the entity class, including fields of superclasses (excluding Object).

Returns:

All fields of the EntityBindings entity class and all superclasses (excluding Object)

getAllMethods

public List<AccessibleObject> getAllMethods()

getFieldName

public static String getFieldName(AccessibleObject fieldOrMethod)

Returns name of field whether public member or method.

Parameters:

fieldOrMethod - field or method

Returns:

field or method name

isRequestScopeableMethod

public static boolean isRequestScopeableMethod(Method method)

Check whether or not method expects a RequestScope.

Parameters:

method - Method to check

Returns:

True if accepts a RequestScope, false otherwise

isComputedMethod

public static boolean isComputedMethod(Method method)

Check whether or not the provided method described a computed attribute or relationship.

Parameters:

method - Method to check

Returns:

True if method is a computed type, false otherwise

getFieldType

public static Type<?> getFieldType(Type<?> parentClass,
                                   AccessibleObject fieldOrMethod)

Returns type of field whether member or method.

Parameters:

parentClass - The class which owns the given field or method

fieldOrMethod - field or method

Returns:

field type

getFieldType

public static Type<?> getFieldType(Type<?> parentClass,
                                   AccessibleObject fieldOrMethod,
                                   Optional<Integer> index)

Returns type of field whether member or method.

Parameters:

parentClass - The class which owns the given field or method

fieldOrMethod - field or method

index - Optional parameter index for parameterized types that take one or more parameters. If an index is provided, the type returned is the parameter type. Otherwise it is the parameterized type.

Returns:

field type

bindTrigger

public void bindTrigger(LifeCycleHookBinding.Operation operation,
                        LifeCycleHookBinding.TransactionPhase phase,
                        String fieldOrMethodName,
                        LifeCycleHook hook)

bindTrigger

public void bindTrigger(LifeCycleHookBinding.Operation operation,
                        LifeCycleHookBinding.TransactionPhase phase,
                        LifeCycleHook hook)

getTriggers

public Collection<LifeCycleHook> getTriggers(LifeCycleHookBinding.Operation op,
                                             LifeCycleHookBinding.TransactionPhase phase,
                                             String fieldName)

getTriggers

public Collection<LifeCycleHook> getTriggers(LifeCycleHookBinding.Operation op,
                                             LifeCycleHookBinding.TransactionPhase phase)

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationClass)

Return annotation from class, parents or package.

Type Parameters:

A - annotation type

Parameters:

annotationClass - the annotation class

Returns:

the annotation

getMethodAnnotation

public <A extends Annotation> A getMethodAnnotation(Class<A> annotationClass,
                                                    String method)

Return annotation for provided method.

Type Parameters:

A - annotation type

Parameters:

annotationClass - the annotation class

method - the method

Returns:

the annotation

addArgumentsToAttribute

public void addArgumentsToAttribute(String attribute,
                                    Set<ArgumentType> arguments)

Add a collection of arguments to the attributes of this Entity.

Parameters:

attribute - attribute name to which argument has to be added

arguments - Set of Argument Type for the attribute

getAttributeArguments

public Set<ArgumentType> getAttributeArguments(String attribute)

Returns the Collection of all attributes of an argument.

Parameters:

attribute - Name of the argument for ehich arguments are to be retrieved.

Returns:

A Set of ArgumentType for the given attribute.

addArgumentToEntity

public void addArgumentToEntity(ArgumentType argument)

Add argument to this Entity.

Parameters:

argument - Argument Type for the attribute

getEntityArguments

public Set<ArgumentType> getEntityArguments()

Returns the Collection of all attributes of an Entity.

Returns:

A Set of ArgumentType for the given entity.