Package oracle.pgx.api

Interface PgqlResultSet

  • All Superinterfaces:
    java.lang.AutoCloseable, oracle.pgx.common.IdentifiableResultSet, java.lang.Iterable<PgxResult>, oracle.pgql.lang.ResultAccess, oracle.pgql.lang.ResultSet<PgxResult>, oracle.pgql.lang.spatial.STResultAccess
    public interface PgqlResultSet
extends oracle.pgql.lang.ResultSet<PgxResult>, oracle.pgql.lang.spatial.STResultAccess, oracle.pgx.common.IdentifiableResultSet
    Result set of a pattern matching query. Note: retrieving results from the server is not thread-safe

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void close()  
      PgxEdge getEdge​(int elementIdx)
      Gets the value of the designated element by element index as a PgxEdge
      PgxEdge getEdge​(java.lang.String elementName)
      Gets the value of the designated element by element name as a PgxEdge
      PgxGraph getGraph()
      Gets the graph of this result set.
      java.lang.String getId()
      Gets the ID of this result set.
      long getNumResults()
      Gets the number of results
      java.util.List<? extends PgqlResultElement> getPgqlResultElements()
      Gets the list of PGQL result elements information
      <ID extends java.lang.Comparable<ID>>
      PgxVertex<ID>      		 getVertex​(int elementIdx)
      Gets the value of the designated element by element index as a PgxVertex
      <ID extends java.lang.Comparable<ID>>
      PgxVertex<ID>      		 getVertex​(java.lang.String elementName)
      Gets the value of the designated element by element name as a PgxVertex
      PgqlResultSet print()
      Prints all results to System.out.
      default PgqlResultSet print​(long numResults)
      Prints numResults results to System.out.
      default PgqlResultSet print​(long numResults, int from)
      Prints numResults results from fromth result to System.out.
      PgqlResultSet print​(java.io.PrintStream printStream, long numResults, int from)
      Same as print(long, int) except that this method prints content to printStream.
      default PgxFrame toFrame()
      Copies the content of this result set into a new PgxFrame.
      default PgxFuture<PgxFrame> toFrameAsync()
      Copies the content of this result set into a new PgxFrame.

      • Methods inherited from interface java.lang.Iterable

        forEach, iterator, spliterator

      • Methods inherited from interface oracle.pgql.lang.ResultAccess

        getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLegacyDate, getLegacyDate, getList, getList, getLong, getLong, getObject, getObject, getString, getString, getTime, getTime, getTimestamp, getTimestamp, getTimestampWithTimezone, getTimestampWithTimezone, getTimeWithTimezone, getTimeWithTimezone, getVertexLabels, getVertexLabels

      • Methods inherited from interface oracle.pgql.lang.ResultSet

        absolute, afterLast, beforeFirst, first, getMetaData, last, next, previous, relative

      • Methods inherited from interface oracle.pgql.lang.spatial.STResultAccess

        getPoint2D, getPoint2D

    • Method Detail

      • getVertex

        <ID extends java.lang.Comparable<ID>> PgxVertex<ID> getVertex​(int elementIdx)
                                                       throws oracle.pgql.lang.PgqlException
        Gets the value of the designated element by element index as a PgxVertex
        Parameters:
        elementIdx - element index
        Returns:
        PgxVertex
        Throws:
        oracle.pgql.lang.PgqlException

      • getVertex

        <ID extends java.lang.Comparable<ID>> PgxVertex<ID> getVertex​(java.lang.String elementName)
                                                       throws oracle.pgql.lang.PgqlException
        Gets the value of the designated element by element name as a PgxVertex
        Parameters:
        elementName - element name
        Returns:
        PgxVertex
        Throws:
        oracle.pgql.lang.PgqlException

      • getEdge

        PgxEdge getEdge​(int elementIdx)
         throws oracle.pgql.lang.PgqlException
        Gets the value of the designated element by element index as a PgxEdge
        Parameters:
        elementIdx - element index
        Returns:
        PgxEdge
        Throws:
        oracle.pgql.lang.PgqlException

      • getEdge

        PgxEdge getEdge​(java.lang.String elementName)
         throws oracle.pgql.lang.PgqlException
        Gets the value of the designated element by element name as a PgxEdge
        Parameters:
        elementName - element name
        Returns:
        PgxEdge
        Throws:
        oracle.pgql.lang.PgqlException

      • getId

        java.lang.String getId()
        Gets the ID of this result set.
        Specified by:
        getId in interface oracle.pgx.common.IdentifiableResultSet
        Returns:
        the ID

      • getGraph

        PgxGraph getGraph()
        Gets the graph of this result set.
        Returns:
        the graph.

      • getPgqlResultElements

        java.util.List<? extends PgqlResultElement> getPgqlResultElements()
        Gets the list of PGQL result elements information
        Returns:
        result element information

      • getNumResults

        long getNumResults()
        Gets the number of results
        Returns:
        number of results

      • print

        default PgqlResultSet print​(long numResults,
                            int from)
        Prints numResults results from fromth result to System.out.
        Parameters:
        numResults - number of result
        from - first result to be printed (start counting from 0)
        Returns:
        PgqlResultSet

      • print

        PgqlResultSet print​(java.io.PrintStream printStream,
                    long numResults,
                    int from)
        Same as print(long, int) except that this method prints content to printStream.
        Parameters:
        printStream - stream to which results are printed
        numResults - number of results
        from - first result to be printed (start counting from 0)
        Returns:
        PgqlResultSet

      • toFrameAsync

        default PgxFuture<PgxFrame> toFrameAsync()
        Copies the content of this result set into a new PgxFrame.
        Returns:
        a new PgxFrame containing the content of the result set

      • toFrame

        default PgxFrame toFrame()
                  throws java.lang.InterruptedException,
                         java.util.concurrent.ExecutionException
        Copies the content of this result set into a new PgxFrame.
        Returns:
        a new PgxFrame containing the content of the result set
        Throws:
        java.lang.InterruptedException
        java.util.concurrent.ExecutionException

      • close

        void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface oracle.pgql.lang.ResultSet<PgxResult>