Trait/Object

quasar.physical.marklogic.qscript

StructuralPlanner

Related Docs: object StructuralPlanner | package qscript

Permalink

trait StructuralPlanner[F[_], FMT] extends AnyRef

Planner for QScript structural operations.

F

the effects employed by the library.

FMT

type index representing the data format supported by the library.

Self Type
StructuralPlanner[F, FMT]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StructuralPlanner
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def arrayAppend(array: XQuery, value: XQuery): F[XQuery]

    Permalink

    Returns the result of appending the value to the array.

  2. abstract def arrayConcat(a1: XQuery, a2: XQuery): F[XQuery]

    Permalink

    Returns the concatenation of the given arrays.

  3. abstract def arrayElementAt(array: XQuery, index: XQuery): F[XQuery]

    Permalink

    Returns the value at the (zero-based) index in the array or the empty seq if none.

  4. abstract def asSortKey(item: XQuery): F[XQuery]

    Permalink

    Returns a representation of the item for use as a sort key.

  5. abstract def isArray(item: XQuery): F[XQuery]

    Permalink

    Returns whether the given item() represents an EJson array.

  6. abstract def leftShift(node: XQuery): F[XQuery]

    Permalink

    Returns the inner array elements or object entries of the given node() as a sequence or the empty seq if it is neither an array or object.

  7. abstract def mkArray(elements: XQuery): F[XQuery]

    Permalink

    Returns a representation of an EJson array given a sequence of array elements obtained via mkArrayElt.

  8. abstract def mkArrayElt(item: XQuery): F[XQuery]

    Permalink

    Returns a representation of an array element given an, possibly empty, item().

  9. abstract def mkObject(entries: XQuery): F[XQuery]

    Permalink

    Returns a representation of an EJson object given a sequence of object entries obtained via mkObjectEntry.

  10. abstract def mkObjectEntry(key: XQuery, value: XQuery): F[XQuery]

    Permalink

    Returns a representation of an EJson object entry given a key name and, possibly empty, value item().

  11. abstract def nodeCast(node: XQuery): F[XQuery]

    Permalink

    Returns the given node() casted to a more precise XQuery type, if possible, or the node itself otherwise.

  12. abstract def nodeMetadata(node: XQuery): F[XQuery]

    Permalink

    Returns any metadata associated with the given node() or the empty seq if none.

  13. abstract def nodeToString(node: XQuery): F[XQuery]

    Permalink

    Returns a string representation of the given node().

  14. abstract def nodeType(node: XQuery): F[XQuery]

    Permalink

    Returns the name of the given node()'s type as an xs:string or the empty seq if unknown.

  15. abstract def null_: F[XQuery]

    Permalink

    The representation of EJson Null.

  16. abstract def objectDelete(obj: XQuery, key: XQuery): F[XQuery]

    Permalink

    Returns an updated version of the given EJson object where the given key is not associated with a value.

  17. abstract def objectInsert(obj: XQuery, key: XQuery, value: XQuery): F[XQuery]

    Permalink

    Returns an updated version of the given EJson object where the given value is associated with the given key.

  18. abstract def objectLookup(obj: XQuery, key: XQuery): F[XQuery]

    Permalink

    Returns the value associated with the given key in the given EJson object or the empty seq if none.

  19. abstract def objectMerge(o1: XQuery, o2: XQuery): F[XQuery]

    Permalink

    Returns the right-biased merge of the given EJson objects.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def asString(item: XQuery)(implicit F0: Bind[F], F1: PrologW[F]): F[XQuery]

    Permalink

    Returns the string representation of the given item.

  6. def castIfNode(item: XQuery)(implicit F0: Bind[F], F1: PrologW[F]): F[XQuery]

    Permalink

    Attempts to cast the given item() to a more specific type if it is a node().

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def seqToArray(seq: XQuery)(implicit F0: Bind[F], F1: PrologW[F]): F[XQuery]

    Permalink

    Converts a sequence of items into an array.

  18. def singletonArray(value: XQuery)(implicit F: Monad[F]): F[XQuery]

    Permalink

    Returns an array consisting of the given value.

  19. def singletonObject(key: XQuery, value: XQuery)(implicit F: Monad[F]): F[XQuery]

    Permalink

    Returns an object with the given value associated with the given key.

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. def transform[G[_]](f: ~>[F, G]): StructuralPlanner[G, FMT]

    Permalink

    Transform the effect type used by the planner.

  23. def typeOf(item: XQuery)(implicit F0: Bind[F], F1: PrologW[F]): F[XQuery]

    Permalink

    Returns the name of the type of the given item or the empty seq if unknown.

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped