EntityFetchOptions (GORM for Hibernate 5

org.grails.gorm.graphql.entity.EntityFetchOptions

```
public class EntityFetchOptions
extends java.lang.Object
```
Helper class to determine which properties should be eagerly fetched based on the fields in a graphql.schema.DataFetchingEnvironment.
Authors:
James Kleeh
Since:
1.0.0

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Set<java.lang.String>`	`associationNames`
`protected PersistentEntity`	`entity`
`protected java.lang.String`	`propertyName`

Constructor Summary

Constructors
Constructor and description
`EntityFetchOptions(java.lang.Class<?> entityClass)`
`EntityFetchOptions(java.lang.Class<?> entityClass, java.lang.String projectionName)`
`EntityFetchOptions(PersistentEntity entity)`
`EntityFetchOptions(PersistentEntity entity, java.lang.String projectionName)` Designed for use when a projection query is used.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public java.util.Map<java.lang.String, Association>`	`getAssociations()` Returns: The associations of the PersistentEntity.
	`public java.util.Map<java.lang.String, java.util.Map>`	`getFetchArgument(java.util.Set<java.lang.String> properties)` Creates the fetch argument prepared to pass to DetachedCriteria.list
	`public java.util.Map<java.lang.String, java.util.Map>`	`getFetchArgument(graphql.schema.DataFetchingEnvironment environment)`
	`public java.util.Map<java.lang.String, java.util.Map>`	`getFetchArgument(graphql.schema.DataFetchingEnvironment environment, boolean skipCollections)` Inspects the environment for requested fields and compares against the PersistentEntity associations to determine which fields should be eagerly fetched.
	`public java.util.Set<java.lang.String>`	`getJoinProperties(java.util.List<graphql.language.Field> fields)`
	`public java.util.Set<java.lang.String>`	`getJoinProperties(java.util.List<graphql.language.Field> fields, boolean skipCollections)` Designed for internal use to inspect nested selections
	`public java.util.Set<java.lang.String>`	`getJoinProperties(graphql.schema.DataFetchingEnvironment environment)`
	`public java.util.Set<java.lang.String>`	`getJoinProperties(graphql.schema.DataFetchingEnvironment environment, boolean skipCollections)` Inspects the environment for requested fields and compares against the PersistentEntity associations to determine which fields should be eagerly fetched.
	`protected void`	`handleField(java.lang.String parentName, Field selectedField, java.util.Set<java.lang.String> joinProperties)`
	`protected boolean`	`isForeignKeyInChild(Association association)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - protected java.util.Set<java.lang.String> associationNames
  - protected PersistentEntity entity
  - protected java.lang.String propertyName
- Constructor Detail
  - public EntityFetchOptions(java.lang.Class<?> entityClass)
  - public EntityFetchOptions(java.lang.Class<?> entityClass, java.lang.String projectionName)
  - public EntityFetchOptions(PersistentEntity entity)
  - public EntityFetchOptions(PersistentEntity entity, java.lang.String projectionName)
    
    Designed for use when a projection query is used. The fetch arguments need prepended with the projection property name.
    Parameters:
    entity - The PersistentEntity being queried
    projectionName - The name of the property being projected
- Method Detail
  - public java.util.Map<java.lang.String, Association> getAssociations()
    
    Returns:
    The associations of the PersistentEntity. The key is the property name and the value is the association.
  - public java.util.Map<java.lang.String, java.util.Map> getFetchArgument(java.util.Set<java.lang.String> properties)
    
    Creates the fetch argument prepared to pass to DetachedCriteria.list
    Parameters:
    properties - The properties to fetch
    Returns:
    The fetch argument
  - public java.util.Map<java.lang.String, java.util.Map> getFetchArgument(graphql.schema.DataFetchingEnvironment environment)
  - public java.util.Map<java.lang.String, java.util.Map> getFetchArgument(graphql.schema.DataFetchingEnvironment environment, boolean skipCollections)
    
    Inspects the environment for requested fields and compares against the PersistentEntity associations to determine which fields should be eagerly fetched. Creates the fetch argument prepared to pass to DetachedCriteria.list
    Parameters:
    environment - The fetching environment
    skipCollections - Whether to exclude associations that are collections
    Returns:
    The fetch argument
  - public java.util.Set<java.lang.String> getJoinProperties(java.util.List<graphql.language.Field> fields)
  - public java.util.Set<java.lang.String> getJoinProperties(java.util.List<graphql.language.Field> fields, boolean skipCollections)
    
    Designed for internal use to inspect nested selections
    Parameters:
    fields - The list of fields to search
    skipCollections - Whether to exclude associations that are collections
    Returns:
    The list of properties to eagerly fetch
  - public java.util.Set<java.lang.String> getJoinProperties(graphql.schema.DataFetchingEnvironment environment)
  - public java.util.Set<java.lang.String> getJoinProperties(graphql.schema.DataFetchingEnvironment environment, boolean skipCollections)
    
    Inspects the environment for requested fields and compares against the PersistentEntity associations to determine which fields should be eagerly fetched.
    Parameters:
    environment - The data fetching environment
    skipCollections - Whether to exclude associations that are collections
    Returns:
    The list of properties to eagerly fetch
  - protected void handleField(java.lang.String parentName, Field selectedField, java.util.Set<java.lang.String> joinProperties)
  - protected boolean isForeignKeyInChild(Association association)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class EntityFetchOptions

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.util.Set<java.lang.String> associationNames

protected PersistentEntity entity

protected java.lang.String propertyName

Constructor Detail

public EntityFetchOptions(java.lang.Class<?> entityClass)

public EntityFetchOptions(java.lang.Class<?> entityClass, java.lang.String projectionName)

public EntityFetchOptions(PersistentEntity entity)

public EntityFetchOptions(PersistentEntity entity, java.lang.String projectionName)

Method Detail

public java.util.Map<java.lang.String, Association> getAssociations()

public java.util.Map<java.lang.String, java.util.Map> getFetchArgument(java.util.Set<java.lang.String> properties)

public java.util.Map<java.lang.String, java.util.Map> getFetchArgument(graphql.schema.DataFetchingEnvironment environment)

public java.util.Map<java.lang.String, java.util.Map> getFetchArgument(graphql.schema.DataFetchingEnvironment environment, boolean skipCollections)

public java.util.Set<java.lang.String> getJoinProperties(java.util.List<graphql.language.Field> fields)

public java.util.Set<java.lang.String> getJoinProperties(java.util.List<graphql.language.Field> fields, boolean skipCollections)

public java.util.Set<java.lang.String> getJoinProperties(graphql.schema.DataFetchingEnvironment environment)

public java.util.Set<java.lang.String> getJoinProperties(graphql.schema.DataFetchingEnvironment environment, boolean skipCollections)

protected void handleField(java.lang.String parentName, Field selectedField, java.util.Set<java.lang.String> joinProperties)

protected boolean isForeignKeyInChild(Association association)