com.thinkaurelius.titan.core.olap

## Interface OLAPJob<S>

-     public interface OLAPJob<S>

  A vertex centric program which executes on each vertex in the graph.

  The program can only inspect the vertex's adjacency list through the pre-computed properties declared in the `OLAPJobBuilder` through `OLAPQueryBuilder` accessible via `OLAPJobBuilder.addQuery()`. In other words, the adjacency list and neighboring vertex's state information is aggregated as declared in `OLAPJobBuilder` and then made available as a vertex property retrievable via `TitanElement.getProperty(String)` where the key is equal to the name of the declared query (see `OLAPQueryBuilder.setName(String)`. The vertex can also access it's own state which is also a property under the defined key in `OLAPJobBuilder.setStateKey(String)`.

  Hence, this program can retrieve the vertex's own state and the aggregate state of its neighbors (as previously declared) and then compute the new state for the vertex which is the return argument of the `process(com.thinkaurelius.titan.core.TitanVertex)` method. In other words, the process method retrieves vertex properties to compute a new state for the vertex. Calling any query methods on the vertex itself will yield empty results and modifying the vertex will throw exceptions.
  Author:
    Matthias Broecheler (me@matthiasb.com)

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `S` | `process(TitanVertex vertex)`

- - ### Method Detail

    - #### process

          S process(TitanVertex vertex)

Copyright © 2012–2014. All rights reserved.