eu.europeana.corelib.neo4j.server

Interface Neo4jServer

All Known Implementing Classes:

Neo4jServerImpl

public interface Neo4jServer

Neo4j server connection interface

Author:

Yorgos.Mamakis@ europeana.eu, Maike.Dulk@ europeana.eu

Method Summary

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

Method Detail

getServerPath

String getServerPath()

Returns:

the server path set during initialization

getNode

org.neo4j.graphdb.Node getNode(String rdfAbout)
                        throws Neo4JException

get node by its rdfAbout

Parameters:

rdfAbout - the rdfAbout (id) to search on

Returns:

a Neo4j node

Throws:

Neo4JException

getChildren

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

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

Parameters:

node - 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 and from the specified offset

getChildren

List<CustomNode> getChildren(String rdfAbout,
                             int offset,
                             int limit)

Convenience override

Parameters:

rdfAbout - The node with this rdf:about to start from

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 and from the specified offset

getParent

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

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

Parameters:

node - The node for which to retrieve the parent

Returns:

The parent node

getFollowingSiblings

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

todo check if deprecated Retrieve ordered list of siblings using a specific node as a start following outbound edm:isNextInSequence or isFakeOrder relations

Parameters:

node - The node to start from

limit - the number of nodes to retrieve

Returns:

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

getFollowingSiblings

List<CustomNode> getFollowingSiblings(String rdfAbout,
                                      int limit)

Retrieve ordered list of siblings using a specific node as a start following outbound edm:isNextInSequence or isFakeOrder relations

Parameters:

rdfAbout - The node with this rdf:about to start from

limit - the number of siblings to retrieve

Returns:

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

getFollowingSiblings

List<CustomNode> getFollowingSiblings(String rdfAbout,
                                      int offset,
                                      int limit)

Retrieve ordered list of siblings using a specific node as a start following outbound edm:isNextInSequence or isFakeOrder relations

Parameters:

rdfAbout - The node with this rdf:about to start from

offset - the number of nodes skip

limit - the number of siblings to retrieve

Returns:

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

getPrecedingSiblings

List<CustomNode> getPrecedingSiblings(org.neo4j.graphdb.Node node,
                                      int limit)

todo check if deprecated Convenience override Retrieve ordered list of siblings using a specific node as a start following inbound edm:isNextInSequence or isFakeOrder relations

Parameters:

node - The node to start from

limit - the number of nodes to retrieve

Returns:

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

getPrecedingSiblings

List<CustomNode> getPrecedingSiblings(String rdfAbout,
                                      int offset,
                                      int limit)

Retrieve ordered list of siblings using a specific node as a start following inbound edm:isNextInSequence or isFakeOrder relations

Parameters:

rdfAbout - The node with this rdf:about to start from

offset - the number of nodes skip

limit - the number of nodes to retrieve

Returns:

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

getPrecedingSiblings

List<CustomNode> getPrecedingSiblings(String rdfAbout,
                                      int limit)

Retrieve ordered list of siblings using a specific node as a start following inbound edm:isNextInSequence or isFakeOrder relations

Parameters:

rdfAbout - The node with this rdf:about to start from

limit - the number of nodes to retrieve

Returns:

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

getChildrenCount

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

Retrieve the number of children for a specific node

Parameters:

node - 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

getNodeIndex

long getNodeIndex(String nodeId)

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

Parameters:

nodeId - the numerical id of the node

Returns:

The index number of the node

getNodeIndexByRdfAbout

long getNodeIndexByRdfAbout(String rdfAbout)
                     throws Neo4JException

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

Parameters:

rdfAbout - the rdf:about string of a specific neo4j node

Returns:

The index number of the node

Throws:

Neo4JException

getInitialStruct

Hierarchy getInitialStruct(String id)
                    throws Neo4JException

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

Throws:

Neo4JException

getCustomPath

String getCustomPath()

The URI path for the REST cal to initial structure

Returns:

isHierarchy

boolean isHierarchy(String id)
             throws Neo4JException

Check if the specified id belongs to a hierarchy

Parameters:

id - The Europeana id

Returns:

true if it belongs to a hierarchy

Throws:

Neo4JException

isHierarchyTimeLimited

boolean isHierarchyTimeLimited(String id,
                               int timeOutMillis)
                        throws Neo4JException,
                               InterruptedException,
                               ExecutionException,
                               TimeoutException

Check if the specified id belongs to a hierarchy

Parameters:

id - The Europeana id

timeOutMillis - seconds to wait until forcing a time-out (working around Neo4j issues)

Returns:

true if it belongs to a hierarchy

Throws:

Neo4JException

InterruptedException

ExecutionException

TimeoutException