com.tinkerpop.rexster.gremlin.converter.ResultConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rexster-core Show documentation

Core components for extending Rexster.

There is a newer version: 2.6.0

package com.tinkerpop.rexster.gremlin.converter;

/**
 * A ResultConverter converts output from Gremlin to some other format.
 * 
 * An example is the ConsoleResultConverter which takes Gremlin output and converts it to a list of Strings for
 * display in the Console.
 *
 * @param  the type to convert Gremlin output to.
 *
 * @author Stephen Mallette (http://stephen.genoprime.com)
 */
public interface ResultConverter {
    /**
     * Converts the result to a sensible format given the implementation.
     * 
     * Gremlin can send back many different kinds of output as a result.  That output is the value passed to
     * this method to be processed and converted to some other type.  A result may be an Iterator, Vertex,
     * Edge, numeric, string, etc.  Implementation is not trivial.
     */
    T convert(final Object result) throws Exception;
}