com.tinkerpop.frames.modules.javahandler

Class JavaHandlerModule

java.lang.Object

com.tinkerpop.frames.modules.javahandler.JavaHandlerModule

All Implemented Interfaces:

Module

public class JavaHandlerModule
extends Object
implements Module

Adds support for calling Java methods to handle a frames call. A call to a frames method annotated with JavaHandler will cause the supplied factory to instantiate an instance of the handler class and call the appropriate method on it.

The default implementation is an inner class of the frame interface named 'Impl'. For example:

 interface Person {
 
   @JavaHandler
   public String doSomething(); 
   
   abstract class Impl implements Person, JavaHandlerContext {
     public String doSomething() {
       return "Use Frames!";
     }
   }
   
 }
 
 

The implementation class can be overridden by using the JavaHandlerClass annotation.

Author:

Bryn Cooke

Constructor Summary

Constructors

Constructor and Description
JavaHandlerModule()

Method Summary

Methods

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Graph	configure(com.tinkerpop.blueprints.Graph baseGraph, FramedGraphConfiguration config)
JavaHandlerModule	withFactory(JavaHandlerFactory factory) Provide an alternative factory for creating objects that handle frames calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaHandlerModule

public JavaHandlerModule()

Method Detail

withFactory

public JavaHandlerModule withFactory(JavaHandlerFactory factory)

Provide an alternative factory for creating objects that handle frames calls.

Parameters:

factory - The factory to use.

Returns:

The module.

configure

public com.tinkerpop.blueprints.Graph configure(com.tinkerpop.blueprints.Graph baseGraph,
                                       FramedGraphConfiguration config)

Specified by:

configure in interface Module

Parameters:

baseGraph - The graph being framed.

config - The configuration for the new FramedGraph.

Returns:

The graph being framed.