oracle.pgx.api

Interface PgqlResultSet

All Superinterfaces:

java.lang.AutoCloseable, java.lang.Iterable<PgxResult>, oracle.pgql.lang.ResultAccess, oracle.pgql.lang.ResultSet, oracle.pgql.lang.spatial.STResultAccess

public interface PgqlResultSet
extends oracle.pgql.lang.ResultSet, oracle.pgql.lang.spatial.STResultAccess, java.lang.Iterable<PgxResult>

Result set of a pattern matching query. Note: retrieving results from the server is not thread-safe

Method Summary

Modifier and Type	Method and 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
void	print() Prints all results to System.out.
default void	print(long numResults) Prints numResults results to System.out.
default void	print(long numResults, int from) Prints numResults results from fromth result to System.out.
void	print(java.io.PrintStream printStream, long numResults, int from) Same as print(long, int) except that this method prints content to printStream.

Methods inherited from interface oracle.pgql.lang.ResultSet

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

Methods inherited from interface oracle.pgql.lang.ResultAccess

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

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

getPoint2D, getPoint2D

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface oracle.pgql.lang.ResultSet

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

getGraph

PgxGraph getGraph()

Gets the graph of this result set.

Returns:

the graph.

getId

java.lang.String getId()

Gets the ID of this result set.

Returns:

the ID

getNumResults

long getNumResults()

Gets the number of results

Returns:

number of results

getPgqlResultElements

java.util.List<? extends PgqlResultElement> getPgqlResultElements()

Gets the list of PGQL result elements information

Returns:

result element information

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

print

void print()

Prints all results to System.out.

print

default void print(long numResults)

Prints numResults results to System.out. If numResults is larger than getNumResults(), only getNumResults() results are printed.

Parameters:

numResults - number of result

print

default void 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)

print

void 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)