Package graphql.normalized.nf

Class NormalizedOperation

java.lang.Object

graphql.normalized.nf.NormalizedOperation

@ExperimentalApi
public class NormalizedOperation
extends Object

A NormalizedOperation 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 NormalizedFields in a parent child hierarchy

Constructor Summary

Constructors

Constructor

Description

NormalizedOperation(OperationDefinition.Operation operation, String operationName, List<NormalizedField> rootFields, com.google.common.collect.ImmutableListMultimap<Field,NormalizedField> fieldToNormalizedField, Map<NormalizedField,MergedField> normalizedFieldToMergedField, Map<NormalizedField,QueryDirectives> normalizedFieldToQueryDirectives, com.google.common.collect.ImmutableListMultimap<FieldCoordinates,NormalizedField> coordinatesToNormalizedFields, int operationFieldCount, int operationDepth)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

NormalizedOperation

public NormalizedOperation(OperationDefinition.Operation operation,
 String operationName,
 List<NormalizedField> rootFields,
 com.google.common.collect.ImmutableListMultimap<Field,NormalizedField> fieldToNormalizedField,
 Map<NormalizedField,MergedField> normalizedFieldToMergedField,
 Map<NormalizedField,QueryDirectives> normalizedFieldToQueryDirectives,
 com.google.common.collect.ImmutableListMultimap<FieldCoordinates,NormalizedField> coordinatesToNormalizedFields,
 int operationFieldCount,
 int operationDepth)

Method Details

getOperation

public OperationDefinition.Operation getOperation()

Returns:

operation AST being executed

getOperationName

public String getOperationName()

Returns:

the operation name, which can be null

getOperationFieldCount

public int getOperationFieldCount()

Returns:

This returns how many NormalizedFields are in the operation.

getOperationDepth

public int getOperationDepth()

Returns:

This returns the depth of the operation

getCoordinatesToNormalizedFields

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

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

Returns:

a multimap of fields to schema field coordinates

getRootFields

public List<NormalizedField> getRootFields()

Returns:

a list of the top level NormalizedFields in this operation.

getFieldToNormalizedField

public com.google.common.collect.ImmutableListMultimap<Field,NormalizedField> 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 NormalizedField

getNormalizedFields

public List<NormalizedField> getNormalizedFields(Field field)

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

Parameters:

field - the field to look up

Returns:

zero, one or more possible NormalizedFields that represent that field

getNormalizedFieldToMergedField

public Map<NormalizedField,MergedField> getNormalizedFieldToMergedField()

Returns:

a map of NormalizedField to MergedFields

getMergedField

public MergedField getMergedField(NormalizedField NormalizedField)

Looks up the MergedField given a NormalizedField

Parameters:

NormalizedField - the field to use the key

Returns:

a MergedField or null if its not present

getNormalizedFieldToQueryDirectives

public Map<NormalizedField,QueryDirectives> getNormalizedFieldToQueryDirectives()

Returns:

a map of NormalizedField to its QueryDirectives

getQueryDirectives

public QueryDirectives getQueryDirectives(NormalizedField NormalizedField)

This looks up the QueryDirectives associated with the given NormalizedField

Parameters:

NormalizedField - the executable normalised field in question

Returns:

the fields query directives or null

getNormalizedField

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

This will find a NormalizedField 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 NormalizedField