org.neo4j.unsafe.batchinsert.BatchInserter Maven / Gradle / Ivy
/**
* Copyright (c) 2002-2013 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see
* Only one thread at a time may work against the batch inserter, multiple
* threads performing concurrent access have to employ synchronization.
*
* Transactions are not supported so if the JVM/machine crashes or you fail to
* invoke {@link #shutdown()} before JVM exits the Neo4j store can be considered
* being in non consistent state and the insertion has to be re-done from
* scratch.
*/
public interface BatchInserter
{
/**
* Creates a node assigning next available id to id and also adds any
* properties supplied.
*
* @param properties a map containing properties or null if no
* properties should be added.
*
* @return The id of the created node.
*/
public long createNode( Map properties );
/**
* Checks if a node with the given id exists.
*
* @param nodeId the id of the node.
* @return true if the node exists.
*/
public boolean nodeExists( long nodeId );
/**
* Sets the properties of a node. This method will remove any properties
* already existing and replace it with properties in the supplied map.
*
* For best performance try supply all the nodes properties upon creation
* of the node. This method will delete any existing properties so using it
* together with {@link #getNodeProperties(long)} will have bad performance.
*
* @param node the id of the node.
* @param properties map containing the properties or null to
* clear all properties.
*/
public void setNodeProperties( long node, Map properties );
/**
* Returns true iff the node with id {@code node} has a property with name
* {@code propertyName}.
*
* @param node The node id of the node to check.
* @param propertyName The property name to check for
* @return True if the node has the named property - false otherwise.
*/
public boolean nodeHasProperty( long node, String propertyName );
/**
* Returns true iff the relationship with id {@code relationship} has a
* property with name {@code propertyName}.
*
* @param relationship The relationship id of the relationship to check.
* @param propertyName The property name to check for
* @return True if the relationship has the named property - false
* otherwise.
*/
public boolean relationshipHasProperty( long relationship,
String propertyName );
/**
* Sets the property with name {@code propertyName} of node with id
* {@code node} to the value {@code propertyValue}. If the property exists
* it is updated, otherwise created.
*
* @param node The node id of the node whose property is to be set
* @param propertyName The name of the property to set
* @param propertyValue The value of the property to set
*/
public void setNodeProperty( long node, String propertyName,
Object propertyValue );
/**
* Sets the property with name {@code propertyName} of relationship with id
* {@code relationship} to the value {@code propertyValue}. If the property
* exists it is updated, otherwise created.
*
* @param relationship The node id of the relationship whose property is to
* be set
* @param propertyName The name of the property to set
* @param propertyValue The value of the property to set
*/
public void setRelationshipProperty( long relationship,
String propertyName, Object propertyValue );
/**
* Returns a map containing all the properties of this node.
*
* @param nodeId the id of the node.
*
* @return map containing this node's properties.
*/
public Map getNodeProperties( long nodeId );
/**
* Returns an iterable over all the relationship ids connected to node with
* supplied id.
*
* @param nodeId the id of the node.
* @return iterable over the relationship ids connected to the node.
*/
public Iterable getRelationshipIds( long nodeId );
/**
* Returns an iterable of {@link BatchRelationship relationships} connected
* to the node with supplied id.
*
* @param nodeId the id of the node.
* @return iterable over the relationships connected to the node.
*/
public Iterable getRelationships( long nodeId );
/**
* Creates a node with supplied id and properties. If a node with the given
* id exist a runtime exception will be thrown.
*
* @param id the id of the node to create.
* @param properties map containing properties or null if no
* properties should be added.
*/
public void createNode( long id, Map properties );
/**
* Creates a relationship between two nodes of a specific type.
*
* @param node1 the start node.
* @param node2 the end node.
* @param type relationship type.
* @param properties map containing properties or null if no
* properties should be added.
* @return the id of the created relationship.
*/
public long createRelationship( long node1, long node2, RelationshipType
type, Map properties );
/**
* Gets a relationship by id.
*
* @param relId the relationship id.
* @return a simple relationship wrapper for the relationship.
*/
public BatchRelationship getRelationshipById( long relId );
/**
* Sets the properties of a relationship. This method will remove any
* properties already existing and replace it with properties in the
* supplied map.
*
* For best performance try supply all the relationship properties upon
* creation of the relationship. This method will delete any existing
* properties so using it together with
* {@link #getRelationshipProperties(long)} will have bad performance.
*
* @param rel the id of the relationship.
* @param properties map containing the properties or null to
* clear all properties.
*/
public void setRelationshipProperties( long rel,
Map properties );
/**
* Returns a map containing all the properties of the relationships.
*
* @param relId the id of the relationship.
* @return map containing the relationship's properties.
*/
public Map getRelationshipProperties( long relId );
/**
* Removes the property named {@code property} from the node with id
* {@code id}, if present.
*
* @param node The id of the node from which to remove the property
* @param property The name of the property
*/
public void removeNodeProperty( long node, String property );
/**
* Removes the property named {@code property} from the relationship with id
* {@code id}, if present.
*
* @param relationship The id of the relationship from which to remove the
* property
* @param property The name of the property
*/
public void removeRelationshipProperty( long relationship, String property );
/**
* Shuts down this batch inserter syncing all changes that are still only
* in memory to disk. Failing to invoke this method may leave the Neo4j
* store in a inconsistent state.
*
* After this method has been invoked any other method call to this batch
* inserter is illegal.
*/
public void shutdown();
/**
* Returns the path to this Neo4j store.
*
* @return the path to this Neo4j store.
*/
public String getStoreDir();
/**
* Returns the reference node id or -1 if it doesn't exist.
*
* @return the reference node
* @deprecated The reference node concept is obsolete - indexes are the
* canonical way of getting hold of entry points in the graph.
*/
@Deprecated
public long getReferenceNode();
}