c

edu.gemini.grackle

ValueMapping

abstract class ValueMapping[F[_]] extends Mapping[F] with ValueMappingLike[F]

Linear Supertypes
ValueMappingLike[F], Mapping[F], QueryExecutor[F, Json], AnyRef, Any
Known Subclasses
IntrospectionMapping
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValueMapping
  2. ValueMappingLike
  3. Mapping
  4. QueryExecutor
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ValueMapping()(implicit M: Monad[F])

Type Members

  1. case class CursorField[T](fieldName: String, f: (Cursor) => Result[T], encoder: Encoder[T], required: List[String], hidden: Boolean)(implicit pos: SourcePos) extends FieldMapping with Product with Serializable
    Definition Classes
    Mapping
  2. case class Delegate(fieldName: String, mapping: Mapping[F], join: (Query, Cursor) => Result[Query] = ComponentElaborator.TrivialJoin)(implicit pos: SourcePos) extends FieldMapping with Product with Serializable
    Definition Classes
    Mapping
  3. case class EffectField(fieldName: String, handler: EffectHandler[F])(implicit pos: SourcePos) extends EffectMapping with Product with Serializable
    Definition Classes
    Mapping
  4. trait EffectMapping extends FieldMapping

    Abstract type of field mappings with effects.

    Abstract type of field mappings with effects.

    Definition Classes
    Mapping
  5. trait FieldMapping extends Product with Serializable
    Definition Classes
    Mapping
  6. case class LeafCursor(context: Context, focus: Any, parent: Option[Cursor], env: Env) extends Cursor with Product with Serializable

    Cursor positioned at a GraphQL result leaf

    Cursor positioned at a GraphQL result leaf

    Definition Classes
    Mapping
  7. trait LeafMapping[T] extends TypeMapping
    Definition Classes
    Mapping
  8. abstract class ObjectMapping extends TypeMapping
    Definition Classes
    Mapping
  9. case class PrefixedMapping(tpe: Type, mappings: List[(List[String], ObjectMapping)])(implicit pos: SourcePos) extends TypeMapping with Product with Serializable
    Definition Classes
    Mapping
  10. case class PrimitiveField(fieldName: String, hidden: Boolean = false)(implicit pos: SourcePos) extends FieldMapping with Product with Serializable
    Definition Classes
    Mapping
  11. case class PrimitiveMapping(tpe: Type)(implicit pos: SourcePos) extends TypeMapping with Product with Serializable
    Definition Classes
    Mapping
  12. case class RootCursor(context: Context, parent: Option[Cursor], env: Env) extends AbstractCursor with Product with Serializable

    Root Cursor focussed on the top level operation of a query

    Root Cursor focussed on the top level operation of a query

    Construction of mapping-specific cursors is handled by delegation to mkCursorForField which is typically overridden in Mapping subtypes.

    Definition Classes
    Mapping
  13. case class RootEffect extends EffectMapping with Product with Serializable

    Root effects can perform an intial effect prior to computing the resulting Cursor and effective Query.

    Root effects can perform an intial effect prior to computing the resulting Cursor and effective Query.

    These effects are used to perform initial effectful setup for a query or to perform the effect associated with a GraphQL mutation. Convenience methods are provided to cover the cases where only one of the query or the cursor are computed.

    If only the query is computed the default root cursor for the mapping will be used. If only the cursor is computed the client query (after elaboration) is used unmodified ... in this case results of the performed effect can only be passed to the result construction stage via the environment associated with the returned cursor.

    Definition Classes
    Mapping
  14. case class RootStream extends EffectMapping with Product with Serializable

    Root streams can perform an intial effect prior to emitting the resulting cursors and effective queries.

    Root streams can perform an intial effect prior to emitting the resulting cursors and effective queries.

    Stream effects are used for GraphQL subscriptions. Convenience methods are provided to cover the cases where only one of the query or the cursor are computed

    If only the query is computed the default root cursor for the mapping will be used. If only the cursor is computed the client query (after elaboration) is used unmodified ... in this case results of the performed effect can only be passed to the result construction stage via the environment associated with the returned cursor.

    Definition Classes
    Mapping
  15. trait TypeMapping extends Product with Serializable
    Definition Classes
    Mapping
  16. case class ValueCursor(context: Context, focus: Any, parent: Option[Cursor], env: Env) extends Cursor with Product with Serializable
    Definition Classes
    ValueMappingLike
  17. case class ValueField[T](fieldName: String, f: (T) => Any, hidden: Boolean = false)(implicit pos: SourcePos) extends ValueFieldMapping[T] with Product with Serializable
    Definition Classes
    ValueMappingLike
  18. sealed trait ValueFieldMapping[T] extends FieldMapping
    Definition Classes
    ValueMappingLike
  19. case class ValueObjectMapping[T](tpe: Type, fieldMappings: List[ValueMappingLike.FieldMapping], classTag: ClassTag[T])(implicit pos: SourcePos) extends ObjectMapping with Product with Serializable
    Definition Classes
    ValueMappingLike

Abstract Value Members

  1. abstract val schema: Schema
    Definition Classes
    Mapping
  2. abstract val typeMappings: List[TypeMapping]
    Definition Classes
    Mapping

Concrete Value Members

  1. object CursorField extends Serializable
    Definition Classes
    Mapping
  2. object EffectField extends Serializable
    Definition Classes
    Mapping
  3. object LeafMapping extends Serializable
    Definition Classes
    Mapping
  4. object ObjectMapping extends Serializable
    Definition Classes
    Mapping
  5. object RootEffect extends Serializable
    Definition Classes
    Mapping
  6. object RootStream extends Serializable
    Definition Classes
    Mapping
  7. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def ##: Int
    Definition Classes
    AnyRef → Any
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. implicit val M: Monad[F]
    Definition Classes
    ValueMapping → Mapping
  11. def ValueObjectMapping[T](tpe: Type, fieldMappings: List[ValueFieldMapping[T]])(implicit classTag: ClassTag[T], pos: SourcePos): ValueObjectMapping[T]
    Definition Classes
    ValueMappingLike
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. def combineAndRun(queries: List[(Query, Cursor)]): F[Result[List[ProtoJson]]]

    Combine and execute multiple queries.

    Combine and execute multiple queries.

    Each query is interpreted in the context of the Cursor it is paired with. The result list is aligned with the argument query list. For each query at most one stage will be run and the corresponding result may contain deferred components.

    Errors are aggregated across all the argument queries and are accumulated on the Left of the result.

    This method is typically called at the end of a stage to evaluate deferred subqueries in the result of that stage. These will be grouped by and passed jointly to the responsible mapping in the next stage using this method. Maappongs which are able to benefit from combining queries may do so by overriding this method to implement their specific combinging logic.

    Definition Classes
    Mapping
  15. def compileAndRun(text: String, name: Option[String] = None, untypedVars: Option[Json] = None, introspectionLevel: IntrospectionLevel = Full, env: Env = Env.empty)(implicit sc: Compiler[F, F]): F[Json]
    Definition Classes
    QueryExecutor
  16. def compileAndRunAll(text: String, name: Option[String] = None, untypedVars: Option[Json] = None, introspectionLevel: IntrospectionLevel = Full, env: Env = Env.empty): Stream[F, Json]
    Definition Classes
    Mapping → QueryExecutor
  17. def compileAndRunOne(text: String, name: Option[String] = None, untypedVars: Option[Json] = None, introspectionLevel: IntrospectionLevel = Full, env: Env = Env.empty)(implicit sc: Compiler[F, F]): F[Json]
    Definition Classes
    Mapping → QueryExecutor
  18. lazy val compiler: QueryCompiler
    Definition Classes
    Mapping
  19. def compilerPhases: List[Phase]
    Definition Classes
    Mapping
  20. lazy val componentElaborator: ComponentElaborator[[_]F[_]]
    Definition Classes
    Mapping
  21. def defaultRootCursor(query: Query, tpe: Type, parentCursor: Option[Cursor]): F[Result[(Query, Cursor)]]

    Yields a Cursor focused on the top level operation type of the query

    Yields a Cursor focused on the top level operation type of the query

    Definition Classes
    Mapping
  22. lazy val effectElaborator: EffectElaborator[[_]F[_]]
    Definition Classes
    Mapping
  23. def encoderForLeaf(tpe: Type): Option[Encoder[Any]]
    Definition Classes
    Mapping
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. def fieldMapping(context: Context, fieldName: String): Option[FieldMapping]
    Definition Classes
    Mapping
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. val interpreter: QueryInterpreter[F]
    Definition Classes
    Mapping
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isLeaf(tpe: Type): Boolean

    True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.

    True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.

    Definition Classes
    Mapping
  32. def leafMapping[T](tpe: Type): Option[LeafMapping[T]]
    Definition Classes
    Mapping
  33. def mkCursor(context: Context, focus: Any, parent: Option[Cursor], env: Env): Cursor
    Definition Classes
    ValueMappingLike
  34. def mkCursorForField(parent: Cursor, fieldName: String, resultName: Option[String]): Result[Cursor]

    Yields a Cursor suitable for traversing the query result corresponding to the fieldName child of parent.

    Yields a Cursor suitable for traversing the query result corresponding to the fieldName child of parent.

    This method is typically overridden in and delegated to by Mapping subtypes.

    Definition Classes
    ValueMappingLike → Mapping
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. def objectMapping(context: Context): Option[ObjectMapping]
    Definition Classes
    Mapping
  39. def rootEffect(context: Context, fieldName: String): Option[RootEffect]

    Yields the RootEffect, if any, associated with fieldName.

    Yields the RootEffect, if any, associated with fieldName.

    Definition Classes
    Mapping
  40. def rootStream(context: Context, fieldName: String): Option[RootStream]

    Yields the RootStream, if any, associated with fieldName.

    Yields the RootStream, if any, associated with fieldName.

    Definition Classes
    Mapping
  41. def run(op: Operation, env: Env = Env.empty): Stream[F, Json]
    Definition Classes
    Mapping
  42. def run(query: Query, rootTpe: Type, env: Env): Stream[F, Json]
    Definition Classes
    Mapping
  43. val selectElaborator: SelectElaborator
    Definition Classes
    Mapping
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. def typeMapping(tpe: NamedType): Option[TypeMapping]
    Definition Classes
    Mapping
  47. val validator: MappingValidator
    Definition Classes
    Mapping
  48. def valueCursor[T](path: Path, env: Env, t: T): Cursor
    Definition Classes
    ValueMappingLike
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. object ValueField extends Serializable
    Definition Classes
    ValueMappingLike
  53. object ValueFieldMapping extends Serializable
    Definition Classes
    ValueMappingLike

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ValueMappingLike[F]

Inherited from Mapping[F]

Inherited from QueryExecutor[F, Json]

Inherited from AnyRef

Inherited from Any

Ungrouped