net.morimekta.providence.graphql.gql

Interface GQLSelection

All Known Subinterfaces:

GQLFragment

All Known Implementing Classes:

GQLField, GQLFragmentDefinition, GQLFragmentReference, GQLInlineFragment, GQLIntrospection, GQLMethodCall, GQLOperation

public interface GQLSelection

When defining a graphql each point in a selection set is called a 'selection'. A selection may be a field or a fragment, each having a distinct definition and uses. Most selections can be recursive, i.e. containing a selection set of it's own. The selection set is ordered, therefore it is returned as a list, not a set.

Method Summary

Modifier and Type	Method and Description
default List<GQLSelection>	getSelection(net.morimekta.providence.descriptor.PField<?> field) Get all selection entries related to the given field.
List<GQLSelection>	getSelectionSet()
default boolean	hasSelection(net.morimekta.providence.descriptor.PField<?>... fields) Check if any of the given fields are in the selection.
default boolean	hasSelectionPath(net.morimekta.providence.descriptor.PField<?>... fields) Browse downward fields so that we figure out if the selection (based on a field path based on the returning structure) if selected.

Method Detail

getSelectionSet

@Nullable
List<GQLSelection> getSelectionSet()

Returns:

List if selections contained within this selection.

hasSelection

default boolean hasSelection(@Nonnull
                             net.morimekta.providence.descriptor.PField<?>... fields)

Check if any of the given fields are in the selection. It will only look the the current struct, but check in all contained and referenced fragments. If only one field is given, this method will return true if and only if getSelection(PField) returns a non-empty list.

Parameters:

fields - Fields to check selection for.

Returns:

True only if the current selection set contains ony of the provided fields.

hasSelectionPath

default boolean hasSelectionPath(@Nonnull
                                 net.morimekta.providence.descriptor.PField<?>... fields)

Browse downward fields so that we figure out if the selection (based on a field path based on the returning structure) if selected. E.g. hasSelectionPath("a", "b") will first look for the selection of "a", then for selection of "b" within a. Will treat a non-selection as the selection being there.

Parameters:

fields - Fields as in a field path to check from the current selection.

Returns:

If the selection path is selected or on per default.

getSelection

@Nonnull
default List<GQLSelection> getSelection(@Nonnull
                                                 net.morimekta.providence.descriptor.PField<?> field)

Get all selection entries related to the given field. It will only look at the current struct, but look at all levels of fragments. The result will contain one entry for each time the field is requested, so if multiple fragments requests the same field, this will return one entry per reference. If it contains more than one, the query should only have one such without alias, and all others should use unique aliases, but is not required. This method will return a non-empty list if and only if hasSelection(PField[]) called with the same field returns true.

Parameters:

field - The field to get selection for.

Returns:

List of selection related to the field.