eu.europeana.corelib.neo4j.server.impl

Class Neo4jServerImpl

java.lang.Object

eu.europeana.corelib.neo4j.server.impl.Neo4jServerImpl

All Implemented Interfaces:

Neo4jServer

public class Neo4jServerImpl
extends Object
implements Neo4jServer

Author:

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

See Also:

Neo4jServer

Constructor Summary

Constructors

Constructor and Description
Neo4jServerImpl() Node.Index = relative index of node in its hierarchical sequence Node.Id = Neo4j numerical Id Node.rdfAbout = hexadecimal rdf:about collection/item identifier Note: initial "/" prefixed here again, it was taken out of the rdfAbout to avoid path separator problems
Neo4jServerImpl(String serverPath, String index, String customPath) Neo4j contructor

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 rdfAbout) 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 rdfAbout) Check if the specified id belongs to a hierarchy
boolean	isHierarchyTimeLimited(String rdfAbout, int hierarchyTimeout) Check if the specified id belongs to a hierarchy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Neo4jServerImpl

public Neo4jServerImpl(String serverPath,
                       String index,
                       String customPath)

Neo4j contructor

Parameters:

serverPath - The path of the Neo4j server

index - The name of the index to search on

customPath - The path of the custom Europeana Neo4j plugins

Neo4jServerImpl

public Neo4jServerImpl()

Node.Index = relative index of node in its hierarchical sequence Node.Id = Neo4j numerical Id Node.rdfAbout = hexadecimal rdf:about collection/item identifier Note: initial "/" prefixed here again, it was taken out of the rdfAbout to avoid path separator problems

Method Detail

getServerPath

public String getServerPath()

Specified by:

getServerPath in interface Neo4jServer

Returns:

the server path set during initialization

getNode

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

Description copied from interface: Neo4jServer

get node by its rdfAbout

Specified by:

getNode in interface Neo4jServer

Parameters:

rdfAbout - the rdfAbout (id) to search on

Returns:

a Neo4j node

Throws:

Neo4JException

getNodeIndex

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

Description copied from interface: Neo4jServer

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

Specified by:

getNodeIndex in interface Neo4jServer

Parameters:

node - A specific neo4j node

Returns:

The index number of the node

getNodeIndex

public long getNodeIndex(String nodeId)

Description copied from interface: Neo4jServer

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

Specified by:

getNodeIndex in interface Neo4jServer

Parameters:

nodeId - the numerical id of the node

Returns:

The index number of the node

getNodeIndexByRdfAbout

public long getNodeIndexByRdfAbout(String rdfAbout)
                            throws Neo4JException

Description copied from interface: Neo4jServer

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

Specified by:

getNodeIndexByRdfAbout in interface Neo4jServer

Parameters:

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

Returns:

The index number of the node

Throws:

Neo4JException

isHierarchy

public boolean isHierarchy(String rdfAbout)
                    throws Neo4JException

Description copied from interface: Neo4jServer

Check if the specified id belongs to a hierarchy

Specified by:

isHierarchy in interface Neo4jServer

Parameters:

rdfAbout - The Europeana id

Returns:

true if it belongs to a hierarchy

Throws:

Neo4JException

isHierarchyTimeLimited

public boolean isHierarchyTimeLimited(String rdfAbout,
                                      int hierarchyTimeout)
                               throws Neo4JException,
                                      InterruptedException,
                                      ExecutionException,
                                      TimeoutException

Description copied from interface: Neo4jServer

Check if the specified id belongs to a hierarchy

Specified by:

isHierarchyTimeLimited in interface Neo4jServer

Parameters:

rdfAbout - The Europeana id

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

getChildren

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

Description copied from interface: Neo4jServer

Convenience override

Specified by:

getChildren in interface Neo4jServer

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

getChildren

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

Description copied from interface: Neo4jServer

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

Specified by:

getChildren in interface Neo4jServer

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

getParent

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

Description copied from interface: Neo4jServer

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

Specified by:

getParent in interface Neo4jServer

Parameters:

node - The node for which to retrieve the parent

Returns:

The parent node

getFollowingSiblings

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

Description copied from interface: Neo4jServer

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

Specified by:

getFollowingSiblings in interface Neo4jServer

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

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

Description copied from interface: Neo4jServer

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

Specified by:

getFollowingSiblings in interface Neo4jServer

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

getFollowingSiblings

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

Description copied from interface: Neo4jServer

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

Specified by:

getFollowingSiblings in interface Neo4jServer

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

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

Description copied from interface: Neo4jServer

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

Specified by:

getPrecedingSiblings in interface Neo4jServer

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

getPrecedingSiblings

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

Description copied from interface: Neo4jServer

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

Specified by:

getPrecedingSiblings in interface Neo4jServer

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

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

Description copied from interface: Neo4jServer

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

Specified by:

getPrecedingSiblings in interface Neo4jServer

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

getChildrenCount

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

Description copied from interface: Neo4jServer

Retrieve the number of children for a specific node

Specified by:

getChildrenCount in interface Neo4jServer

Parameters:

node - The node to search on

Returns:

The number of children for the specific node

getInitialStruct

public Hierarchy getInitialStruct(String rdfAbout)
                           throws Neo4JException

Description copied from interface: Neo4jServer

Get the initial hierachy for a specific Europeana id

Specified by:

getInitialStruct in interface Neo4jServer

Parameters:

rdfAbout - The id to search on

Returns:

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

Throws:

Neo4JException

getCustomPath

public String getCustomPath()

Description copied from interface: Neo4jServer

The URI path for the REST cal to initial structure

Specified by:

getCustomPath in interface Neo4jServer

Returns: