Package oracle.pgx.api.filter

Class EdgeFilter

java.lang.Object

oracle.pgx.api.filter.GraphFilter

oracle.pgx.api.filter.GraphFilterWithExpression

oracle.pgx.api.filter.EdgeFilter

public class EdgeFilter
extends GraphFilterWithExpression

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
EdgeFilter	asEdgeFilter()	Gets this filter object as edge filter, if possible.
static EdgeFilter	fromCollection(oracle.pgx.common.IdentifiableEdgeCollection edgeCollection)	Instantiates a new edge collection edge filter.
static EdgeFilter	fromExpression(java.lang.String filterExpression)	Instantiates a new edge filter using an expression.
static EdgeFilter	fromPgqlResultSet(oracle.pgx.common.IdentifiableResultSet resultSet, java.lang.String columnName)	Instantiates a new result set edge 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, asVertexFilter, 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 EdgeFilter ALL

Edge filter set equal to true for all edges.

NONE

public static final EdgeFilter NONE

Edge filter set equal to false for all edges.

Method Detail

fromExpression

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

Instantiates a new edge filter using an expression.

Parameters:

filterExpression - the edge-filter expression

Returns:

the new filter

Since:

20.0

fromPgqlResultSet

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

Instantiates a new result set edge 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 EdgeFilter fromCollection(oracle.pgx.common.IdentifiableEdgeCollection edgeCollection)

Instantiates a new edge collection edge filter.

Parameters:

edgeCollection - 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

asEdgeFilter

public EdgeFilter asEdgeFilter()

Description copied from class: GraphFilter

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

Overrides:

asEdgeFilter in class GraphFilter

Returns:

the edge filter