oracle.pgx.api.filter

Class GraphFilter

java.lang.Object

oracle.pgx.api.filter.GraphFilter

Direct Known Subclasses:

BinaryGraphFilterOperation, GraphFilterWithExpression, PathFindingFilter

public abstract class GraphFilter
extends java.lang.Object

An abstract class representing any GraphFilters

Method Summary

Modifier and Type	Method and Description
BinaryGraphFilterOperation	asBinaryGraphFilterOperation() Gets this filter object as binary graph filter operation, if possible.
EdgeFilter	asEdgeFilter() Gets this filter object as edge filter, if possible.
GraphFilterWithExpression	asGraphFilterWithExpression() Gets this filter object as graph filter with expression, if possible.
VertexFilter	asVertexFilter() Gets this filter object as vertex filter, if possible.
boolean	equals(java.lang.Object o)
FilterType	getType() Gets the type of the filter.
boolean	hasExpression() Checks if this GraphFilter object has an expression associated with it.
int	hashCode()
FilterIntersection	intersect(GraphFilter other) Intersects this filter with another graph-filter object.
boolean	isBinaryOperation() Checks if this GraphFilter object represents is binary operation.
boolean	isCollectionFilter() Checks if the filter is using a collection
boolean	isPathFindingFilter() Checks if the filter is a path finding filter
boolean	isResultSetFilter() Checks if the filter is acting on a result set
FilterUnion	union(GraphFilter other) Unions this filter with another graph-filter object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

asBinaryGraphFilterOperation

public BinaryGraphFilterOperation asBinaryGraphFilterOperation()

Gets this filter object as binary graph filter operation, if possible. Save to call if hasExpression() evaluates to true.

Returns:

the binary graph filter operation

asEdgeFilter

public EdgeFilter asEdgeFilter()

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

Returns:

the edge filter

asGraphFilterWithExpression

public GraphFilterWithExpression asGraphFilterWithExpression()

Gets this filter object as graph filter with expression, if possible. Save to call if isBinaryOperation() evaluates to true.

Returns:

the graph filter with expression

asVertexFilter

public VertexFilter asVertexFilter()

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

Returns:

the vertex filter

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getType

public final FilterType getType()

Gets the type of the filter.

Returns:

the type of the filter

hasExpression

public boolean hasExpression()

Checks if this GraphFilter object has an expression associated with it.

Returns:

true, if this GraphFilter object has an expression associated with it

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

intersect

public final FilterIntersection intersect(GraphFilter other)

Intersects this filter with another graph-filter object.

Parameters:

other - the other graph-filter

Returns:

a class representing the filter intersection

isBinaryOperation

public boolean isBinaryOperation()

Checks if this GraphFilter object represents is binary operation.

Returns:

true, if this GraphFilter object represents is binary operation

isCollectionFilter

public boolean isCollectionFilter()

Checks if the filter is using a collection

Returns:

true if the filter uses a collection

isPathFindingFilter

public boolean isPathFindingFilter()

Checks if the filter is a path finding filter

Returns:

true if the filter is a path finding filter

isResultSetFilter

public boolean isResultSetFilter()

Checks if the filter is acting on a result set

Returns:

true if the filter acts on a result set

union

public final FilterUnion union(GraphFilter other)

Unions this filter with another graph-filter object.

Parameters:

other - the other graph-filter

Returns:

a class representing the filter union