com.syncleus.ferma.typeresolvers

Interface TypeResolver

All Known Implementing Classes:

PolymorphicTypeResolver, UntypedTypeResolver

public interface TypeResolver

Type resolvers resolve the frame type from the element being requested and may optionally store metadata about the frame type on the element.

Method Summary

Modifier and Type	Method and Description
void	deinit(com.tinkerpop.blueprints.Element element) Called to remove the type resolution properties from an element
EdgeTraversal<?,?,?>	hasNotType(EdgeTraversal<?,?,?> traverser, Class<?> type) Filters out the objects on the traversal that are not satisfying a requested type.
VertexTraversal<?,?,?>	hasNotType(VertexTraversal<?,?,?> traverser, Class<?> type) Filters out the objects on the traversal that are not satisfying a requested type.
EdgeTraversal<?,?,?>	hasType(EdgeTraversal<?,?,?> traverser, Class<?> type) Filters the objects on the traversal that satisfy a requested type.
VertexTraversal<?,?,?>	hasType(VertexTraversal<?,?,?> traverser, Class<?> type) Filters the objects on the traversal that satisfy a requested type.
void	init(com.tinkerpop.blueprints.Element element, Class<?> kind) Called to initialize an element with type resolution properties.
Class<?>	resolve(com.tinkerpop.blueprints.Element element) Resolve the type of frame that a an element should be.
<T> Class<? extends T>	resolve(com.tinkerpop.blueprints.Element element, Class<T> kind) Resolve the type of frame that a an element should be.

Method Detail

resolve

<T> Class<? extends T> resolve(com.tinkerpop.blueprints.Element element,
                               Class<T> kind)

Resolve the type of frame that a an element should be.

Type Parameters:

T - The type used to frame the element.

Parameters:

element - The element that is being framed.

kind - The kind of frame that is being requested by the client code.

Returns:

The kind of frame

resolve

Class<?> resolve(com.tinkerpop.blueprints.Element element)

Resolve the type of frame that a an element should be.

Parameters:

element - The element that is being framed.

Returns:

The kind of frame, null if no type resolution properties exist.

init

void init(com.tinkerpop.blueprints.Element element,
          Class<?> kind)

Called to initialize an element with type resolution properties.

Parameters:

element - The element that was created.

kind - The kind of frame that was resolved.

deinit

void deinit(com.tinkerpop.blueprints.Element element)

Called to remove the type resolution properties from an element

Parameters:

element - The element to remove the property from.

hasType

VertexTraversal<?,?,?> hasType(VertexTraversal<?,?,?> traverser,
                               Class<?> type)

Filters the objects on the traversal that satisfy a requested type.

Parameters:

traverser - A traversal pointing to the current set of vertex to be filtered

type - The type to filter by.

Returns:

The traversal stream filtered by the desired type.

hasType

EdgeTraversal<?,?,?> hasType(EdgeTraversal<?,?,?> traverser,
                             Class<?> type)

Filters the objects on the traversal that satisfy a requested type.

Parameters:

traverser - A traversal pointing to the current set of edges to be filtered

type - The type to filter by.

Returns:

The traversal stream filtered by the desired type.

hasNotType

VertexTraversal<?,?,?> hasNotType(VertexTraversal<?,?,?> traverser,
                                  Class<?> type)

Filters out the objects on the traversal that are not satisfying a requested type.

Parameters:

traverser - A traversal pointing to the current set of vertex to be filtered

type - The type to filter by.

Returns:

The traversal stream filtered by the desired type.

hasNotType

EdgeTraversal<?,?,?> hasNotType(EdgeTraversal<?,?,?> traverser,
                                Class<?> type)

Filters out the objects on the traversal that are not satisfying a requested type.

Parameters:

traverser - A traversal pointing to the current set of edges to be filtered

type - The type to filter by.

Returns:

The traversal stream filtered by the desired type.