eu.europeana.corelib.neo4j.server

Interface Neo4jServer

All Known Implementing Classes:

Neo4jServerImpl

public interface Neo4jServer

Neo4j server connection interface

Author:

Yorgos.Mamakis@ europeana.eu

Method Summary

Methods

Modifier and Type	Method and Description
List<org.neo4j.graphdb.Node>	getChildren(org.neo4j.graphdb.Node id, int offset, int limit) Retrieve the children nodes of a parent node (parent-child relation dcterms:hasPart).
long	getChildrenCount(org.neo4j.graphdb.Node id) Retrieve the number of children for a specific node
String	getCustomPath() The URI path for the REST cal to initial structure
List<org.neo4j.graphdb.Node>	getFollowingSiblings(org.neo4j.graphdb.Node id, int limit) Retrieve ordered list of children using a specific node as a child following outbound edm:isNextInSequence relations
Hierarchy	getInitialStruct(String id) Get the initial hierachy for a specific Europeana id
org.neo4j.graphdb.Node	getNode(String id) Get node by its id
long	getNodeIndex(org.neo4j.graphdb.Node node) Get the order of the node within its hierarchy (local index)
org.neo4j.graphdb.Node	getParent(org.neo4j.graphdb.Node id) Retrieve the parent node of a node (parent relation dcterms:isPartOf)
List<org.neo4j.graphdb.Node>	getPreceedingSiblings(org.neo4j.graphdb.Node id, int limit) Retrieve ordered list of children using a specific node as a child following inbound edm:isNextInSequence relations
boolean	isHierarchy(String id) Check if the specified id belongs to a hierarchy

Method Detail

getNode

org.neo4j.graphdb.Node getNode(String id)

Get node by its id

Parameters:

id - The id to search for

Returns:

A Neo4j node

getChildren

List<org.neo4j.graphdb.Node> getChildren(org.neo4j.graphdb.Node id,
                                       int offset,
                                       int limit)

Retrieve the children nodes of a parent node (parent-child relation dcterms:hasPart). Returns null if null is present

Parameters:

id - The node for which to retrieve the children

offset - from which child to start receiving from

limit - how many children to receive

Returns:

A list of children nodes with size <= to the specified limit

getParent

org.neo4j.graphdb.Node getParent(org.neo4j.graphdb.Node id)

Retrieve the parent node of a node (parent relation dcterms:isPartOf)

Parameters:

id - The node for which to retrieve the parent

Returns:

The parent node

getFollowingSiblings

List<org.neo4j.graphdb.Node> getFollowingSiblings(org.neo4j.graphdb.Node id,
                                                int limit)

Retrieve ordered list of children using a specific node as a child following outbound edm:isNextInSequence relations

Parameters:

id - The node to start from

limit - the number of nodes to retrieve

Returns:

A list of children nodes with size <= to the specified limit

getPreceedingSiblings

List<org.neo4j.graphdb.Node> getPreceedingSiblings(org.neo4j.graphdb.Node id,
                                                 int limit)

Retrieve ordered list of children using a specific node as a child following inbound edm:isNextInSequence relations

Parameters:

id - The node to start from

limit - the number of nodes to retrieve

Returns:

A list of children nodes with size <= to the specified limit

getChildrenCount

long getChildrenCount(org.neo4j.graphdb.Node id)

Retrieve the number of children for a specific node

Parameters:

id - The node to search on

Returns:

The number of children for the specific node

getNodeIndex

long getNodeIndex(org.neo4j.graphdb.Node node)

Get the order of the node within its hierarchy (local index)

Parameters:

node - A specific neo4j node

Returns:

The index number of the node

getInitialStruct

Hierarchy getInitialStruct(String id)

Get the initial hierachy for a specific Europeana id

Parameters:

id - The id to search on

Returns:

A full Hierarchy consisting of parents- parents of parents- and nodes

getCustomPath

String getCustomPath()

The URI path for the REST cal to initial structure

Returns:

isHierarchy

boolean isHierarchy(String id)

Check if the specified id belongs to a hierarchy

Parameters:

id - The Europeana id

Returns:

true if it belongs to a hierarchy