Trait/Object

org.opencypher.tools.tck.api

Graph

Related Docs: object Graph | package api

Permalink

trait Graph extends ResultCreation

Mutable implementations implement .cypher Immutable implementations implement .execute

An implementation will not have to implement .cypher if .execute is overridden.

Linear Supertypes
ResultCreation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Graph
  2. ResultCreation
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Result = Either[ExecutionFailed, CypherValueRecords]

    Permalink

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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close(): Unit

    Permalink

    When the Graph is used by a Scenario, this method will be called at the end of execution, regardless if the result was an error or not.

    When the Graph is used by a Scenario, this method will be called at the end of execution, regardless if the result was an error or not. Immutable implementations that return different graphs have to close the old instances explicitly when returning a new reference.

    See also

    execute

  7. def cypher(query: String, params: Map[String, CypherValue], meta: QueryType): Result

    Permalink

    Executes a Cypher query with the provided parameters.

    Executes a Cypher query with the provided parameters.

    Additionally, this call provides a metadata tag for the step type that requests the query to be executed. This allows implementations to use the TCK for validation of supported subsets of Cypher functionality by mapping initial state setup and side effect validation to alternative functionality in the implementation. Implementations that support all the necessary constructs used in these steps should ignore this parameter.

    query

    the Cypher query to execute.

    params

    the parameters for the query.

    meta

    metadata tag which specifies what kind of step the query is executed in.

    returns

    the graph in its state after having executed the query, and the result table of the query.

  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def execute(query: String, params: Map[String, CypherValue], meta: QueryType): (Graph, Result)

    Permalink

    Executes a Cypher query with the provided parameters.

    Executes a Cypher query with the provided parameters. This version also returns the graph in its state after the query has been executed, for implementations that have immutable graphs.

    Additionally, this call provides a metadata tag for the step type that requests the query to be executed. This allows implementations to use the TCK for validation of supported subsets of Cypher functionality by mapping initial state setup and side effect validation to alternative functionality in the implementation. Implementations that support all the necessary constructs used in these steps should ignore this parameter.

    query

    the Cypher query to execute.

    params

    the parameters for the query.

    meta

    metadata tag which specifies what kind of step the query is executed in.

    returns

    the graph in its state after having executed the query, and the result table of the query.

  11. def finalize(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. implicit def resultFromError(error: ExecutionFailed): Graph.Result

    Permalink
    Definition Classes
    ResultCreation
  19. implicit def resultFromStringRecords(records: StringRecords): Graph.Result

    Permalink
    Definition Classes
    ResultCreation
  20. implicit def resultFromValueRecords(records: CypherValueRecords): Graph.Result

    Permalink
    Definition Classes
    ResultCreation
  21. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

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

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

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

Inherited from ResultCreation

Inherited from AnyRef

Inherited from Any

Ungrouped