Package oracle.pgx.api.filter

Class VertexFilter

java.lang.Object

oracle.pgx.api.filter.GraphFilter

oracle.pgx.api.filter.GraphFilterWithExpression

oracle.pgx.api.filter.VertexFilter

public class VertexFilter
extends GraphFilterWithExpression

A class that wraps a filter expression supposed to be evaluated on each vertex of the graph

Field Summary

Fields

Modifier and Type	Field	Description
static VertexFilter	ALL	Vertex filter set equal to true for all edges.
static VertexFilter	NONE	Vertex filter set equal to false for all edges.

Method Summary

Modifier and Type	Method	Description
VertexFilter	asVertexFilter()	Gets this filter object as vertex filter, if possible.
static VertexFilter	fromCollection(oracle.pgx.common.IdentifiableVertexCollection vertexCollection)	Instantiates a new vertex collection vertex filter.
static VertexFilter	fromExpression(java.lang.String filterExpression)	Instantiates a new vertex filter using an expression.
static VertexFilter	fromPgqlResultSet(oracle.pgx.common.IdentifiableResultSet resultSet, java.lang.String columnName)	Instantiates a new result set vertex filter.
java.lang.String	toString()

Methods inherited from class oracle.pgx.api.filter.GraphFilterWithExpression

asGraphFilterWithExpression, equals, fromTypeAndExpression, getFilterExpression, hasExpression, hashCode

Methods inherited from class oracle.pgx.api.filter.GraphFilter

asBinaryGraphFilterOperation, asEdgeFilter, getType, intersect, isBinaryOperation, isCollectionFilter, isPathFindingFilter, isResultSetFilter, union

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final VertexFilter ALL

Vertex filter set equal to true for all edges.

NONE

public static final VertexFilter NONE

Vertex filter set equal to false for all edges.

Method Detail

fromExpression

public static VertexFilter fromExpression(java.lang.String filterExpression)

Instantiates a new vertex filter using an expression.

Parameters:

filterExpression - the vertex-filter expression

Returns:

the new filter

Since:

20.0

fromPgqlResultSet

public static VertexFilter fromPgqlResultSet(oracle.pgx.common.IdentifiableResultSet resultSet,
                                             java.lang.String columnName)

Instantiates a new result set vertex filter.

Parameters:

resultSet - the result set on which the filter acts

columnName - the column name to be fetched from the result set

Returns:

the new filter

Since:

20.0

fromCollection

public static VertexFilter fromCollection(oracle.pgx.common.IdentifiableVertexCollection vertexCollection)

Instantiates a new vertex collection vertex filter.

Parameters:

vertexCollection - the collection on which the filter acts

Returns:

the new filter

Since:

20.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

asVertexFilter

public VertexFilter asVertexFilter()

Description copied from class: GraphFilter

Gets this filter object as vertex filter, if possible. Save to call if GraphFilter.getType() == FilterType.VERTEX

Overrides:

asVertexFilter in class GraphFilter

Returns:

the vertex filter