com.shopify.graphql.support

Class AbstractQuery<T extends AbstractQuery>

java.lang.Object

com.shopify.graphql.support.AbstractQuery<T>

Direct Known Subclasses:

__DirectiveQuery, __EnumValueQuery, __FieldQuery, __InputValueQuery, __SchemaQuery, __TypeQuery, AddBundleProductsToCartOutputQuery, AddConfigurableProductsToCartOutputQuery, AddDownloadableProductsToCartOutputQuery, AddProductsToCartOutputQuery, AddProductsToWishlistOutputQuery, AddReturnCommentOutputQuery, AddReturnTrackingOutputQuery, AddSimpleProductsToCartOutputQuery, AddVirtualProductsToCartOutputQuery, AggregationOptionInterfaceQuery, AggregationOptionQuery, AggregationQuery, AppliedCouponQuery, AppliedGiftCardQuery, AppliedStoreCreditQuery, ApplyCouponToCartOutputQuery, ApplyGiftCardToCartOutputQuery, ApplyRewardPointsToCartOutputQuery, ApplyStoreCreditToCartOutputQuery, AssetsQuery, AssignCompareListToCustomerOutputQuery, AttributeOptionQuery, AttributeQuery, AvailablePaymentMethodQuery, AvailableShippingMethodQuery, BillingCartAddressQuery, BreadcrumbQuery, BundleCartItemQuery, BundleCreditMemoItemQuery, BundleInvoiceItemQuery, BundleItemOptionQuery, BundleItemQuery, BundleOrderItemQuery, BundleProductQuery, BundleShipmentItemQuery, BundleWishlistItemQuery, CartAddressCountryQuery, CartAddressInterfaceQuery, CartAddressRegionQuery, CartDiscountQuery, CartItemInterfaceQuery, CartItemPricesQuery, CartItemQuantityQuery, CartItemSelectedOptionValuePriceQuery, CartPricesQuery, CartQuery, CartTaxItemQuery, CartUserInputErrorQuery, CategoriesQuery, CategoryInterfaceQuery, CategoryProductsQuery, CategoryResultQuery, CategoryTreeQuery, CheckoutAgreementQuery, CheckoutUserInputErrorQuery, CmsBlockQuery, CmsBlocksQuery, CmsPageQuery, ColorSwatchDataQuery, ComparableAttributeQuery, ComparableItemQuery, CompareListQuery, ComplexTextValueQuery, ConfigurableAttributeOptionQuery, ConfigurableCartItemQuery, ConfigurableOptionAvailableForSelectionQuery, ConfigurableProductOptionsQuery, ConfigurableProductOptionsSelectionQuery, ConfigurableProductOptionsValuesQuery, ConfigurableProductQuery, ConfigurableVariantQuery, ConfigurableWishlistItemQuery, CopyProductsBetweenWishlistsOutputQuery, CountryQuery, createKlarnaPaymentsSessionOutputQuery, CreatePayflowProTokenOutputQuery, CreateProductReviewOutputQuery, CreateWishlistOutputQuery, CreditMemoItemInterfaceQuery, CreditMemoItemQuery, CreditMemoQuery, CreditMemoTotalQuery, CurrencyQuery, CustomAttributeMetadataQuery, CustomerAddressAttributeQuery, CustomerAddressQuery, CustomerAddressRegionQuery, CustomerDownloadableProductQuery, CustomerDownloadableProductsQuery, CustomerOrderQuery, CustomerOrdersQuery, CustomerOutputQuery, CustomerPaymentTokensQuery, CustomerQuery, CustomerStoreCreditHistoryItemQuery, CustomerStoreCreditHistoryQuery, CustomerStoreCreditQuery, CustomerTokenQuery, CustomFieldQuery, CustomizableAreaOptionQuery, CustomizableAreaValueQuery, CustomizableCheckboxOptionQuery, CustomizableCheckboxValueQuery, CustomizableDateOptionQuery, CustomizableDateValueQuery, CustomizableDropDownOptionQuery, CustomizableDropDownValueQuery, CustomizableFieldOptionQuery, CustomizableFieldValueQuery, CustomizableFileOptionQuery, CustomizableFileValueQuery, CustomizableMultipleOptionQuery, CustomizableMultipleValueQuery, CustomizableOptionInterfaceQuery, CustomizableProductInterfaceQuery, CustomizableRadioOptionQuery, CustomizableRadioValueQuery, DeleteCompareListOutputQuery, DeletePaymentTokenOutputQuery, DeleteWishlistOutputQuery, DiscountQuery, DownloadableCartItemQuery, DownloadableCreditMemoItemQuery, DownloadableInvoiceItemQuery, DownloadableItemsLinksQuery, DownloadableOrderItemQuery, DownloadableProductLinksQuery, DownloadableProductQuery, DownloadableProductSamplesQuery, DownloadableWishlistItemQuery, EntityUrlQuery, ExchangeRateQuery, FixedProductTaxQuery, GenerateCustomerTokenAsAdminOutputQuery, GiftCardAccountQuery, GiftCardAmountsQuery, GiftCardCartItemQuery, GiftCardCreditMemoItemQuery, GiftCardInvoiceItemQuery, GiftCardItemQuery, GiftCardOptionsQuery, GiftCardOrderItemQuery, GiftCardProductQuery, GiftCardShipmentItemQuery, GiftCardWishlistItemQuery, GiftMessageQuery, GiftOptionsPricesQuery, GiftWrappingImageQuery, GiftWrappingQuery, GroupedProductItemQuery, GroupedProductQuery, GroupedProductWishlistItemQuery, HostedProUrlQuery, HttpQueryParameterQuery, ImageSwatchDataQuery, InvoiceItemInterfaceQuery, InvoiceItemQuery, InvoiceQuery, InvoiceTotalQuery, IsEmailAvailableOutputQuery, ItemSelectedBundleOptionQuery, ItemSelectedBundleOptionValueQuery, KeyValueQuery, LayerFilterItemInterfaceQuery, LayerFilterItemQuery, LayerFilterQuery, MediaGalleryEntryQuery, MediaGalleryInterfaceQuery, MoneyQuery, MoveProductsBetweenWishlistsOutputQuery, MutationQuery, OrderAddressQuery, OrderItemInterfaceQuery, OrderItemOptionQuery, OrderItemQuery, OrderPaymentMethodQuery, OrderQuery, OrderShipmentQuery, OrderTotalQuery, PayflowLinkTokenQuery, PayflowProResponseOutputQuery, PayflowProTokenQuery, PaymentTokenQuery, PaypalExpressTokenOutputQuery, PaypalExpressTokenQuery, PaypalExpressUrlListQuery, PhysicalProductInterfaceQuery, PickupLocationQuery, PickupLocationsQuery, PlaceOrderOutputQuery, PriceAdjustmentQuery, PriceQuery, PriceRangeQuery, ProductAttributeQuery, ProductDiscountQuery, ProductImageQuery, ProductInterfaceQuery, ProductLinksInterfaceQuery, ProductLinksQuery, ProductMediaGalleryEntriesContentQuery, ProductMediaGalleryEntriesVideoContentQuery, ProductPriceQuery, ProductPricesQuery, ProductReviewQuery, ProductReviewRatingMetadataQuery, ProductReviewRatingQuery, ProductReviewRatingsMetadataQuery, ProductReviewRatingValueMetadataQuery, ProductReviewsQuery, ProductsQuery, ProductTierPricesQuery, ProductVideoQuery, QueryQuery, RegionQuery, RemoveCouponFromCartOutputQuery, RemoveGiftCardFromCartOutputQuery, RemoveItemFromCartOutputQuery, RemoveProductsFromWishlistOutputQuery, RemoveReturnTrackingOutputQuery, RemoveRewardPointsFromCartOutputQuery, RemoveStoreCreditFromCartOutputQuery, ReorderItemsOutputQuery, RequestReturnOutputQuery, ReturnCommentQuery, ReturnCustomAttributeQuery, ReturnCustomerQuery, ReturnItemQuery, ReturnQuery, ReturnShippingAddressQuery, ReturnShippingCarrierQuery, ReturnShippingQuery, ReturnShippingTrackingQuery, ReturnShippingTrackingStatusQuery, ReturnsQuery, RevokeCustomerTokenOutputQuery, RewardPointsAmountQuery, RewardPointsBalanceHistoryItemQuery, RewardPointsExchangeRatesQuery, RewardPointsQuery, RewardPointsRateQuery, RewardPointsSubscriptionStatusQuery, SalesCommentItemQuery, SalesItemInterfaceQuery, SearchResultPageInfoQuery, SelectedBundleOptionQuery, SelectedBundleOptionValueQuery, SelectedConfigurableOptionQuery, SelectedCustomizableOptionQuery, SelectedCustomizableOptionValueQuery, SelectedPaymentMethodQuery, SelectedShippingMethodQuery, SendEmailToFriendOutputQuery, SendEmailToFriendRecipientQuery, SendEmailToFriendSenderQuery, SendFriendConfigurationQuery, SetBillingAddressOnCartOutputQuery, SetGiftOptionsOnCartOutputQuery, SetGuestEmailOnCartOutputQuery, SetPaymentMethodOnCartOutputQuery, SetShippingAddressesOnCartOutputQuery, SetShippingMethodsOnCartOutputQuery, ShipmentItemInterfaceQuery, ShipmentItemQuery, ShipmentTrackingQuery, ShippingCartAddressQuery, ShippingDiscountQuery, ShippingHandlingQuery, SimpleCartItemQuery, SimpleProductQuery, SimpleWishlistItemQuery, SortFieldQuery, SortFieldsQuery, StoreConfigQuery, SubscribeEmailToNewsletterOutputQuery, SwatchDataInterfaceQuery, SwatchDataQuery, SwatchLayerFilterItemInterfaceQuery, SwatchLayerFilterItemQuery, TaxItemQuery, TextSwatchDataQuery, TierPriceQuery, UpdateCartItemsOutputQuery, UpdateProductsInWishlistOutputQuery, UpdateWishlistOutputQuery, UrlRewriteQuery, VirtualCartItemQuery, VirtualProductQuery, VirtualWishlistItemQuery, WebsiteQuery, WishlistItemInterfaceQuery, WishlistItemQuery, WishlistItemsQuery, WishlistOutputQuery, WishlistQuery, WishListUserInputErrorQuery

public abstract class AbstractQuery<T extends AbstractQuery>
extends Object

Created by eapache on 2015-11-17.

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuilder	_queryBuilder
static String	ALIAS_SUFFIX_SEPARATOR
static String	CUSTOM_FIELD_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQuery(StringBuilder queryBuilder)

Method Summary

Modifier and Type	Method and Description
T	addCustomObjectField(String fieldName, CustomFieldQueryDefinition queryDef) Adds a custom object field to the GraphQL query.
T	addCustomSimpleField(String fieldName) Adds a custom simple field to the GraphQL query.
static void	appendQuotedString(StringBuilder query, String string)
protected void	startField(String fieldName)
protected void	startInlineFragment(String typeName)
T	withAlias(String aliasSuffix)

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS_SUFFIX_SEPARATOR

public static final String ALIAS_SUFFIX_SEPARATOR

See Also:

Constant Field Values

CUSTOM_FIELD_LABEL

public static final String CUSTOM_FIELD_LABEL

See Also:

Constant Field Values

_queryBuilder

protected final StringBuilder _queryBuilder

Constructor Detail

AbstractQuery

protected AbstractQuery(StringBuilder queryBuilder)

Method Detail

appendQuotedString

public static void appendQuotedString(StringBuilder query,
                                      String string)

startInlineFragment

protected void startInlineFragment(String typeName)

startField

protected void startField(String fieldName)

withAlias

public T withAlias(String aliasSuffix)

addCustomSimpleField

public T addCustomSimpleField(String fieldName)

Adds a custom simple field to the GraphQL query. The adjective "simple" here refers to a scalar/primitive field like String, Integer, Double, Boolean, or an array of fields.

Parameters:

fieldName - The name of the field that will be added to the GraphQL request.

Returns:

The current query builder.

addCustomObjectField

public T addCustomObjectField(String fieldName,
                              CustomFieldQueryDefinition queryDef)

Adds a custom object field to the GraphQL query. The term "object" here refers to a GraphQL object, which means some fields of the custom object must also be defined in the query.

Parameters:

fieldName - The name of the field that will be added to the GraphQL request.

queryDef - The definition of the requested sub-fields of the object.

Returns:

The current query builder.