Package org.topbraidlive.client.java.graphql.platform

Class GraphQuery

java.lang.Object

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

org.topbraidlive.client.java.graphql.platform.GraphQuery

public class GraphQuery
extends AbstractQuery<GraphQuery>

An (RDF) graph managed by the TopBraid Platform.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GraphQuery.CreationTimeStampArguments
static interface	GraphQuery.CreationTimeStampArgumentsDefinition
class	GraphQuery.CreatorArguments
static interface	GraphQuery.CreatorArgumentsDefinition
class	GraphQuery.DescriptionArguments
static interface	GraphQuery.DescriptionArgumentsDefinition

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method	Description
GraphQuery	addFragmentReference(Fragment<GraphQuery> fragment)	Adds a GraphQuery fragment reference at the current position of the query.
static Fragment<GraphQuery>	createFragment(String name, GraphQueryDefinition queryDef)	Creates a GraphQL "named" fragment with the specified query type definition.
GraphQuery	creationTimeStamp()	The time stamp that this graph was created (if known).
GraphQuery	creationTimeStamp(GraphQuery.CreationTimeStampArgumentsDefinition argsDef)	The time stamp that this graph was created (if known).
GraphQuery	creator(GraphQuery.CreatorArgumentsDefinition argsDef, UserQueryDefinition queryDef)	The user who created this graph (if known).
GraphQuery	creator(UserQueryDefinition queryDef)	The user who created this graph (if known).
GraphQuery	description()	A human-readable description of the graph (in the user's preferred language).
GraphQuery	description(GraphQuery.DescriptionArgumentsDefinition argsDef)	A human-readable description of the graph (in the user's preferred language).
GraphQuery	label()	A human-readable display label.
GraphQuery	Results(_ValidationResultQueryDefinition queryDef)	The (validation) results for the surrounding object, e.g.
GraphQuery	type(_ResourceQueryDefinition queryDef)	The types of this Graph
GraphQuery	uri()	The URI of the resource.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

Results

public GraphQuery Results(_ValidationResultQueryDefinition queryDef)

The (validation) results for the surrounding object, e.g. current constraint violations.

creationTimeStamp

public GraphQuery creationTimeStamp()

The time stamp that this graph was created (if known).

creationTimeStamp

public GraphQuery creationTimeStamp(GraphQuery.CreationTimeStampArgumentsDefinition argsDef)

The time stamp that this graph was created (if known).

creator

public GraphQuery creator(UserQueryDefinition queryDef)

The user who created this graph (if known).

creator

public GraphQuery creator(GraphQuery.CreatorArgumentsDefinition argsDef,
                          UserQueryDefinition queryDef)

The user who created this graph (if known).

description

public GraphQuery description()

A human-readable description of the graph (in the user's preferred language).

description

public GraphQuery description(GraphQuery.DescriptionArgumentsDefinition argsDef)

A human-readable description of the graph (in the user's preferred language).

label

public GraphQuery label()

A human-readable display label.

type

public GraphQuery type(_ResourceQueryDefinition queryDef)

The types of this Graph

uri

public GraphQuery uri()

The URI of the resource.

createFragment

public static Fragment<GraphQuery> createFragment(String name,
                                                  GraphQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public GraphQuery addFragmentReference(Fragment<GraphQuery> fragment)

Adds a GraphQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.