graphql.normalized

Class ExecutableNormalizedOperation

java.lang.Object

graphql.normalized.ExecutableNormalizedOperation

@PublicApi
public class ExecutableNormalizedOperation
extends java.lang.Object

A ExecutableNormalizedOperation represent how the text of a graphql operation (sometimes known colloquially as a query) will be executed at runtime according to the graphql specification. It handles complex mechanisms like merging duplicate fields into one and also detecting when the types of a given field may actually be for more than one possible object type.

An operation consists of a list of ExecutableNormalizedFields in a parent child hierarchy

Constructor Summary

Constructors

Constructor and Description

ExecutableNormalizedOperation(OperationDefinition.Operation operation, java.lang.String operationName, java.util.List<ExecutableNormalizedField> topLevelFields, com.google.common.collect.ImmutableListMultimap<Field,ExecutableNormalizedField> fieldToNormalizedField, java.util.Map<ExecutableNormalizedField,MergedField> normalizedFieldToMergedField, java.util.Map<ExecutableNormalizedField,QueryDirectives> normalizedFieldToQueryDirectives, com.google.common.collect.ImmutableListMultimap<FieldCoordinates,ExecutableNormalizedField> coordinatesToNormalizedFields, int operationFieldCount, int operationDepth)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableListMultimap<FieldCoordinates,ExecutableNormalizedField>	getCoordinatesToNormalizedFields() This multimap shows how a given ExecutableNormalizedField maps to a one or more field coordinate in the schema
com.google.common.collect.ImmutableListMultimap<Field,ExecutableNormalizedField>	getFieldToNormalizedField() This is a multimap and the size of it reflects all the normalized fields in the operation
MergedField	getMergedField(ExecutableNormalizedField executableNormalizedField) Looks up the MergedField given a ExecutableNormalizedField
ExecutableNormalizedField	getNormalizedField(MergedField mergedField, GraphQLFieldsContainer fieldsContainer, ResultPath resultPath) This will find a ExecutableNormalizedField given a merged field and a result path.
java.util.List<ExecutableNormalizedField>	getNormalizedFields(Field field) Looks up one or more ExecutableNormalizedFields given a Field AST element in the operation
java.util.Map<ExecutableNormalizedField,MergedField>	getNormalizedFieldToMergedField()
java.util.Map<ExecutableNormalizedField,QueryDirectives>	getNormalizedFieldToQueryDirectives()
OperationDefinition.Operation	getOperation()
int	getOperationDepth()
int	getOperationFieldCount()
java.lang.String	getOperationName()
QueryDirectives	getQueryDirectives(ExecutableNormalizedField executableNormalizedField) This looks up the QueryDirectives associated with the given ExecutableNormalizedField
java.util.List<ExecutableNormalizedField>	getTopLevelFields()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutableNormalizedOperation

public ExecutableNormalizedOperation(OperationDefinition.Operation operation,
                                     java.lang.String operationName,
                                     java.util.List<ExecutableNormalizedField> topLevelFields,
                                     com.google.common.collect.ImmutableListMultimap<Field,ExecutableNormalizedField> fieldToNormalizedField,
                                     java.util.Map<ExecutableNormalizedField,MergedField> normalizedFieldToMergedField,
                                     java.util.Map<ExecutableNormalizedField,QueryDirectives> normalizedFieldToQueryDirectives,
                                     com.google.common.collect.ImmutableListMultimap<FieldCoordinates,ExecutableNormalizedField> coordinatesToNormalizedFields,
                                     int operationFieldCount,
                                     int operationDepth)

Method Detail

getOperation

public OperationDefinition.Operation getOperation()

Returns:

operation AST being executed

getOperationName

public java.lang.String getOperationName()

Returns:

the operation name, which can be null

getOperationFieldCount

public int getOperationFieldCount()

Returns:

This returns how many ExecutableNormalizedFields are in the operation.

getOperationDepth

public int getOperationDepth()

Returns:

This returns the depth of the operation

getCoordinatesToNormalizedFields

public com.google.common.collect.ImmutableListMultimap<FieldCoordinates,ExecutableNormalizedField> getCoordinatesToNormalizedFields()

This multimap shows how a given ExecutableNormalizedField maps to a one or more field coordinate in the schema

Returns:

a multimap of fields to schema field coordinates

getTopLevelFields

public java.util.List<ExecutableNormalizedField> getTopLevelFields()

Returns:

a list of the top level ExecutableNormalizedFields in this operation.

getFieldToNormalizedField

public com.google.common.collect.ImmutableListMultimap<Field,ExecutableNormalizedField> getFieldToNormalizedField()

This is a multimap and the size of it reflects all the normalized fields in the operation

Returns:

an immutable list multimap of Field to ExecutableNormalizedField

getNormalizedFields

public java.util.List<ExecutableNormalizedField> getNormalizedFields(Field field)

Looks up one or more ExecutableNormalizedFields given a Field AST element in the operation

Parameters:

field - the field to look up

Returns:

zero, one or more possible ExecutableNormalizedFields that represent that field

getNormalizedFieldToMergedField

public java.util.Map<ExecutableNormalizedField,MergedField> getNormalizedFieldToMergedField()

Returns:

a map of ExecutableNormalizedField to MergedFields

getMergedField

public MergedField getMergedField(ExecutableNormalizedField executableNormalizedField)

Looks up the MergedField given a ExecutableNormalizedField

Parameters:

executableNormalizedField - the field to use the key

Returns:

a MergedField or null if its not present

getNormalizedFieldToQueryDirectives

public java.util.Map<ExecutableNormalizedField,QueryDirectives> getNormalizedFieldToQueryDirectives()

Returns:

a map of ExecutableNormalizedField to its QueryDirectives

getQueryDirectives

public QueryDirectives getQueryDirectives(ExecutableNormalizedField executableNormalizedField)

This looks up the QueryDirectives associated with the given ExecutableNormalizedField

Parameters:

executableNormalizedField - the executable normalised field in question

Returns:

the fields query directives or null

getNormalizedField

public ExecutableNormalizedField getNormalizedField(MergedField mergedField,
                                                    GraphQLFieldsContainer fieldsContainer,
                                                    ResultPath resultPath)

This will find a ExecutableNormalizedField given a merged field and a result path. If this does not find a field it will assert with an exception

Parameters:

mergedField - the merged field

fieldsContainer - the containing type of that field

resultPath - the result path in play

Returns:

the ExecutableNormalizedField