gsp-graphql-core/edu.gemini.grackle/Cursor

Cursor

trait Cursor

Indicates a position within an abstract data model during the interpretation of a GraphQL query.

Companion:
object
class Object
trait Matchable
class Any

Value members

Abstract methods

def asLeaf: Result[Json]

Yield the value at this Cursor rendered as Json if it is of a scalar or enum type, an error or the left hand side otherwise.

Yield the value at this Cursor rendered as Json if it is of a scalar or enum type, an error or the left hand side otherwise.

def asList: Result[List[Cursor]]

Yield a list of Cursors corresponding to the elements of the value at this Cursor if it is of a list type, or an error or the left hand side otherwise.

Yield a list of Cursors corresponding to the elements of the value at this Cursor if it is of a list type, or an error or the left hand side otherwise.

def asNullable: Result[Option[Cursor]]

Yield an optional Cursors corresponding to the value at this Cursor if it is of a nullable type, or an error on the left hand side otherwise. The resulting Cursor will be present iff the current value is present in the model.

Yield an optional Cursors corresponding to the value at this Cursor if it is of a nullable type, or an error on the left hand side otherwise. The resulting Cursor will be present iff the current value is present in the model.

def env: Env
def field(fieldName: String, resultName: Option[String]): Result[Cursor]

Yield a Cursor corresponding to the value of the field fieldName of the value at this Cursor, or an error on the left hand side if there is no such field.

Yield a Cursor corresponding to the value of the field fieldName of the value at this Cursor, or an error on the left hand side if there is no such field.

def focus: Any

The value at the position represented by this Cursor.

The value at the position represented by this Cursor.

def hasField(fieldName: String): Boolean

Does the value at this Cursor have a field named fieldName?

Does the value at this Cursor have a field named fieldName?

def isLeaf: Boolean

Is the value at this Cursor of a scalar or enum type?

Is the value at this Cursor of a scalar or enum type?

def isList: Boolean

Is the value at this Cursor of a list type?

Is the value at this Cursor of a list type?

def isNullable: Boolean

Is the value at this Cursor of a nullable type?

Is the value at this Cursor of a nullable type?

def narrow(subtpe: TypeRef): Result[Cursor]

Yield a Cursor corresponding to the value at this Cursor narrowed to type subtpe, or an error on the left hand side if such a narrowing is not possible.

Yield a Cursor corresponding to the value at this Cursor narrowed to type subtpe, or an error on the left hand side if such a narrowing is not possible.

def narrowsTo(subtpe: TypeRef): Boolean

Is the value at this Cursor narrowable to subtpe?

Is the value at this Cursor narrowable to subtpe?

def withEnv(env: Env): Cursor

Concrete methods

def as[T : ClassTag]: Result[T]

Yield the value at this Cursor as a value of type T if possible, an error or the left hand side otherwise.

Yield the value at this Cursor as a value of type T if possible, an error or the left hand side otherwise.

def env[T : ClassTag](nme: String): Option[T]
def fieldAs[T : ClassTag](fieldName: String): Result[T]

Yield the value of the field fieldName of this Cursor as a value of type T if possible, an error or the left hand side otherwise.

Yield the value of the field fieldName of this Cursor as a value of type T if possible, an error or the left hand side otherwise.

def flatListPath(fns: List[String]): Result[List[Cursor]]

Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path. If the field at the end of the path is a list then yield the concatenation of the lists of cursors corresponding to the field elements.

Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path. If the field at the end of the path is a list then yield the concatenation of the lists of cursors corresponding to the field elements.

def hasListPath(fns: List[String]): Boolean

Does the value at this Cursor generate a list along the path fns?

Does the value at this Cursor generate a list along the path fns?

true if fns is a valid path from the value at this Cursor and passes through at least one field with a list type.

def hasPath(fns: List[String]): Boolean

Does the value at this Cursor have a field identified by the path fns?

Does the value at this Cursor have a field identified by the path fns?

def listPath(fns: List[String]): Result[List[Cursor]]

Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path.

Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path.

def nullableField(fieldName: String): Result[Cursor]

Yield a Cursor corresponding to the value of the possibly nullable field fieldName of the value at this Cursor, or an error on the left hand side if there is no such field.

Yield a Cursor corresponding to the value of the possibly nullable field fieldName of the value at this Cursor, or an error on the left hand side if there is no such field.

def nullableHasField(fieldName: String): Boolean

Does the possibly nullable value at this Cursor have a field named fieldName?

Does the possibly nullable value at this Cursor have a field named fieldName?

def path: List[String]

The selection path from the root

The selection path from the root

def path(fns: List[String]): Result[Cursor]

Yield a Cursor corresponding to the value of the field identified by path fns starting from the value at this Cursor, or an error on the left hand side if there is no such field.

Yield a Cursor corresponding to the value of the field identified by path fns starting from the value at this Cursor, or an error on the left hand side if there is no such field.

def resultPath: List[String]

The selection path from the root modified by query aliases

The selection path from the root modified by query aliases

def tpe: Type

The GraphQL type of the value at the position represented by this Cursor.

The GraphQL type of the value at the position represented by this Cursor.