Apache AGE utils

This repository contains utility classes to be used with Apache AGE and MyBatis.

AgtypeWrapper

The AgtypeWrapper is the main object inside this library and it is used to map input parameters for MyBatis Mappers.

Example usage:

FindItemParams params = new FindItemParams();
params.setCode(code);
GraphItem<ItemProperties> item = itemsMapper.findItemByParams(AgtypeWrapper.from(params));

GraphItem<ItemProperties> item = itemsMapper.findItemByCode(AgtypeWrapper.from("code"));

GraphItem

The GraphItem is a utility class to wrap the result type of graph query with the node id and the generic properties. You can define your custom properties mapping object and pass it as the generic type inside the GraphItem definition.

GraphItem<ItemProperties> item = itemsMapper.findItemByCode(AgtypeWrapper.from("code"));
long id = item.getId();
ItemProperties props = item.getProperties();

Example Cypher query parameter mapping:

SELECT * FROM cypher('${schema}', $$
    MATCH (i:Item ${params})
    RETURN id(i), properties(i)
$$) AS (id agtype, properties agtype);

GraphVertex and GraphEdge

The GraphVertex and GraphEdge classes are utility classes that represent the structure of a Vertex or an Edge in Apache AGE. The usage is similar to the GraphItem but you can map directly the entire vertex or edge without the need to separately capture id() and properties().

GraphVertex<ItemProperties> item = itemsMapper.findItemByCode(AgtypeWrapper.from("code"));
long id = item.getId();
String label = item.getLabel();
ItemProperties props = item.getProperties();

Example Cypher query parameter mapping:

SELECT * FROM cypher('${schema}', $$
    MATCH (i:Item ${params})
    RETURN i
$$) AS (item agtype);

Graph TypeHandlers

public class MyVertex extends GraphVertex<MyProperties> {
}

public class MyCatalog extends GraphEdge<MyProperties> {
}

@MappedTypes({MyEdge.class, MyVertex.class})
public class MyGraphTypeHandler<T extends GraphItem<?>> extends GraphTypeHandler<T> {
    public MyGraphTypeHandler(Class<T> type) {
        super(type);
    }
}

Building the library

To build the current library, in addition to the dependencies listed inside the build.gradle script you need to do the following:

• clone the Apache AGE repository
• build the java driver from the drivers/jdbc directory inside the repository
• copy the output jar file into the libs folder of this repository