Package graphql.normalized

Class ExecutableNormalizedField

java.lang.Object

graphql.normalized.ExecutableNormalizedField

@PublicApi
public class ExecutableNormalizedField
extends Object

An ExecutableNormalizedField represents a field in an executable graphql operation. Its models what could be executed during a given operation.

This class is intentionally mutable for performance reasons since building immutable parent child objects is too expensive.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecutableNormalizedField.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final String	alias
private final com.google.common.collect.ImmutableList<Argument>	astArguments
private final ArrayList<ExecutableNormalizedField>	children
private final String	fieldName
private final int	level
private final com.google.common.collect.ImmutableMap<String,NormalizedInputValue>	normalizedArguments
private final LinkedHashSet<String>	objectTypeNames
private ExecutableNormalizedField	parent
private final LinkedHashMap<String,Object>	resolvedArguments

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExecutableNormalizedField(ExecutableNormalizedField.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	addChild(ExecutableNormalizedField executableNormalizedField)
void	addObjectTypeNames(Collection<String> objectTypeNames)
void	clearChildren()
void	forEachFieldDefinition(GraphQLSchema schema, Consumer<GraphQLFieldDefinition> consumer)
String	getAlias()
com.google.common.collect.ImmutableList<Argument>	getAstArguments()
List<ExecutableNormalizedField>	getChildren()
List<ExecutableNormalizedField>	getChildren(int includingRelativeLevel)
List<ExecutableNormalizedField>	getChildren(String objectTypeName)	This returns the child fields that can be used if the object is of the specified object type
List<ExecutableNormalizedField>	getChildrenWithSameResultKey(String resultKey)	Returns the list of child fields that would have the same result key
List<GraphQLFieldDefinition>	getFieldDefinitions(GraphQLSchema schema)
String	getFieldName()
private Set<GraphQLInterfaceType>	getInterfacesCommonToAllOutputTypes(GraphQLSchema schema)	This tries to find interfaces common to all the field output types.
int	getLevel()	the level of the ExecutableNormalizedField in the operation hierarchy with top level fields starting at 1
List<String>	getListOfResultKeys()	This returns the list of the result keys (see getResultKey() that lead from this field upwards to its parent field
String	getName()	All merged fields have the same name so this is the name of the ExecutableNormalizedField.
NormalizedInputValue	getNormalizedArgument(String name)	Returns an argument value as a NormalizedInputValue which contains its type name and its current value
com.google.common.collect.ImmutableMap<String,NormalizedInputValue>	getNormalizedArguments()
Set<String>	getObjectTypeNames()	A ExecutableNormalizedField can sometimes (for non-concrete types like interfaces and unions) have more than one object type it could be when executed.
private GraphQLFieldDefinition	getOneFieldDefinition(GraphQLSchema schema)	This is NOT public as it is not recommended usage.
ExecutableNormalizedField	getParent()
LinkedHashMap<String,Object>	getResolvedArguments()
String	getResultKey()	Returns the result key of this ExecutableNormalizedField within the overall result.
String	getSingleObjectTypeName()	This returns the first entry in getObjectTypeNames().
GraphQLOutputType	getType(GraphQLSchema schema)
List<GraphQLOutputType>	getTypes(GraphQLSchema schema)
boolean	hasChildren()
boolean	isConditional(@NotNull GraphQLSchema schema)	Determines whether this ExecutableNormalizedField needs a fragment to select the field.
static ExecutableNormalizedField.Builder	newNormalizedField()
String	objectTypeNamesToString()
String	printDetails()
void	replaceParent(ExecutableNormalizedField newParent)
private static GraphQLFieldDefinition	resolveIntrospectionField(GraphQLSchema schema, Set<String> objectTypeNames, String fieldName)
void	setObjectTypeNames(Collection<String> objectTypeNames)
String	toString()
ExecutableNormalizedField	transform(Consumer<ExecutableNormalizedField.Builder> builderConsumer)	Allows this ExecutableNormalizedField to be transformed via a ExecutableNormalizedField.Builder consumer callback
private void	traverseImpl(ExecutableNormalizedField root, Consumer<ExecutableNormalizedField> consumer, int curRelativeLevel, int abortAfter)
void	traverseSubTree(Consumer<ExecutableNormalizedField> consumer)	Traverse from this ExecutableNormalizedField down into itself and all of its children

Methods inherited from class java.lang.Object

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

Field Details

alias

private final String alias

normalizedArguments

private final com.google.common.collect.ImmutableMap<String,NormalizedInputValue> normalizedArguments

resolvedArguments

private final LinkedHashMap<String,Object> resolvedArguments

astArguments

private final com.google.common.collect.ImmutableList<Argument> astArguments

objectTypeNames

private final LinkedHashSet<String> objectTypeNames

children

private final ArrayList<ExecutableNormalizedField> children

parent

private ExecutableNormalizedField parent

fieldName

private final String fieldName

level

private final int level

Constructor Details

ExecutableNormalizedField

private ExecutableNormalizedField(ExecutableNormalizedField.Builder builder)

Method Details

isConditional

public boolean isConditional(@NotNull
 @NotNull GraphQLSchema schema)

Determines whether this ExecutableNormalizedField needs a fragment to select the field. However, it considers the parent output type when determining whether it needs a fragment.

Consider the following schema

 interface Animal {
     name: String
     parent: Animal
 }
 type Cat implements Animal {
     name: String
     parent: Cat
 }
 type Dog implements Animal {
     name: String
     parent: Dog
     isGoodBoy: Boolean
 }
 type Query {
     animal: Animal
 }
 

and the following query

 {
     animal {
         parent {
             name
         }
     }
 }
 

Then we would get the following ExecutableNormalizedOperation

 -Query.animal: Animal
 --[Cat, Dog].parent: Cat, Dog
 ---[Cat, Dog].name: String
 

If we simply checked the parent's getFieldDefinitions(GraphQLSchema) that would point us to Cat.parent and Dog.parent whose output types would incorrectly answer our question whether this is conditional?

We MUST consider that the output type of the parent field is Animal and NOT Cat or Dog as their respective implementations would say.

Parameters:

schema - - the graphql schema in play

Returns:

true if the field is conditional

hasChildren

public boolean hasChildren()

getType

public GraphQLOutputType getType(GraphQLSchema schema)

getTypes

public List<GraphQLOutputType> getTypes(GraphQLSchema schema)

forEachFieldDefinition

public void forEachFieldDefinition(GraphQLSchema schema,
 Consumer<GraphQLFieldDefinition> consumer)

getFieldDefinitions

public List<GraphQLFieldDefinition> getFieldDefinitions(GraphQLSchema schema)

getOneFieldDefinition

private GraphQLFieldDefinition getOneFieldDefinition(GraphQLSchema schema)

This is NOT public as it is not recommended usage.

Internally there are cases where we know it is safe to use this, so this exists.

resolveIntrospectionField

private static GraphQLFieldDefinition resolveIntrospectionField(GraphQLSchema schema,
 Set<String> objectTypeNames,
 String fieldName)

addObjectTypeNames

public void addObjectTypeNames(Collection<String> objectTypeNames)

setObjectTypeNames

public void setObjectTypeNames(Collection<String> objectTypeNames)

addChild

public void addChild(ExecutableNormalizedField executableNormalizedField)

clearChildren

public void clearChildren()

getName

public String getName()

All merged fields have the same name so this is the name of the ExecutableNormalizedField.

WARNING: This is not always the key in the execution result, because of possible field aliases.

Returns:

the name of this ExecutableNormalizedField

See Also:

• getResultKey()
• getAlias()

getFieldName

public String getFieldName()

Returns:

the same value as getName()

See Also:

• getResultKey()
• getAlias()

getResultKey

public String getResultKey()

Returns the result key of this ExecutableNormalizedField within the overall result. This is either a field alias or the value of getName()

Returns:

the result key for this ExecutableNormalizedField.

See Also:

• getName()

getAlias

public String getAlias()

Returns:

the field alias used or null if there is none

See Also:

• getResultKey()
• getName()

getAstArguments

public com.google.common.collect.ImmutableList<Argument> getAstArguments()

Returns:

a list of the Arguments on the field

getNormalizedArgument

public NormalizedInputValue getNormalizedArgument(String name)

Returns an argument value as a NormalizedInputValue which contains its type name and its current value

Parameters:

name - the name of the argument

Returns:

an argument value

getNormalizedArguments

public com.google.common.collect.ImmutableMap<String,NormalizedInputValue> getNormalizedArguments()

Returns:

a map of all the arguments in NormalizedInputValue form

getResolvedArguments

public LinkedHashMap<String,Object> getResolvedArguments()

Returns:

a map of the resolved argument values

getObjectTypeNames

public Set<String> getObjectTypeNames()

A ExecutableNormalizedField can sometimes (for non-concrete types like interfaces and unions) have more than one object type it could be when executed. There is no way to know what it will be until the field is executed over data and the type is resolved via a TypeResolver.

This method returns all the possible types a field can be which is one or more GraphQLObjectType names.

Warning: This returns a Mutable Set. No defensive copy is made for performance reasons.

Returns:

a set of the possible type names this field could be.

getSingleObjectTypeName

public String getSingleObjectTypeName()

This returns the first entry in getObjectTypeNames(). Sometimes you know a field cant be more than one type and this method is a shortcut one to help you.

Returns:

the first entry from

printDetails

public String printDetails()

Returns:

a helper method show field details

objectTypeNamesToString

public String objectTypeNamesToString()

Returns:

a helper method to show the object types names as a string

getListOfResultKeys

public List<String> getListOfResultKeys()

This returns the list of the result keys (see getResultKey() that lead from this field upwards to its parent field

Returns:

a list of the result keys from this ExecutableNormalizedField to the top of the operation via parent fields

getChildren

public List<ExecutableNormalizedField> getChildren()

Returns:

the children of the ExecutableNormalizedField

getChildrenWithSameResultKey

public List<ExecutableNormalizedField> getChildrenWithSameResultKey(String resultKey)

Returns the list of child fields that would have the same result key

Parameters:

resultKey - the result key to check

Returns:

a list of all direct ExecutableNormalizedField children with the specified result key

getChildren

public List<ExecutableNormalizedField> getChildren(int includingRelativeLevel)

getChildren

public List<ExecutableNormalizedField> getChildren(String objectTypeName)

This returns the child fields that can be used if the object is of the specified object type

Parameters:

objectTypeName - the object type

Returns:

a list of child fields that would apply to that object type

getLevel

public int getLevel()

the level of the ExecutableNormalizedField in the operation hierarchy with top level fields starting at 1

Returns:

the level of the ExecutableNormalizedField in the operation hierarchy

getParent

public ExecutableNormalizedField getParent()

Returns:

the parent of this ExecutableNormalizedField or null if it's a top level field

replaceParent

public void replaceParent(ExecutableNormalizedField newParent)

toString

public String toString()

Overrides:

toString in class Object

traverseSubTree

public void traverseSubTree(Consumer<ExecutableNormalizedField> consumer)

Traverse from this ExecutableNormalizedField down into itself and all of its children

Parameters:

consumer - the callback for each ExecutableNormalizedField in the hierarchy.

traverseImpl

private void traverseImpl(ExecutableNormalizedField root,
 Consumer<ExecutableNormalizedField> consumer,
 int curRelativeLevel,
 int abortAfter)

getInterfacesCommonToAllOutputTypes

private Set<GraphQLInterfaceType> getInterfacesCommonToAllOutputTypes(GraphQLSchema schema)

This tries to find interfaces common to all the field output types.

i.e. goes through getFieldDefinitions(GraphQLSchema) and finds interfaces that all the field's unwrapped output types are assignable to.

newNormalizedField

public static ExecutableNormalizedField.Builder newNormalizedField()

Returns:

a ExecutableNormalizedField.Builder of ExecutableNormalizedFields

transform

public ExecutableNormalizedField transform(Consumer<ExecutableNormalizedField.Builder> builderConsumer)

Allows this ExecutableNormalizedField to be transformed via a ExecutableNormalizedField.Builder consumer callback

Parameters:

builderConsumer - the consumer given a builder

Returns:

a new transformed ExecutableNormalizedField