eu.ehri.project.commands

Class GraphSON

java.lang.Object

eu.ehri.project.commands.BaseCommand

eu.ehri.project.commands.GraphSON

All Implemented Interfaces:

Command

public class GraphSON
extends BaseCommand

Dump the complete graph as graphSON file, or import such a dump

Example usage:

     
 # stop the server
 $NEO4J_HOME/bin/neo4j stop
 # save a dump
 ./scripts/cmd graphson -d out graph.json
 # or
 ./scripts/cmd graphson -d out - > graph.json
 # edit it
 # remove the graph
 rm -rf $NEO4J_HOME/data/graph.db
 # load edited graph
 ./scripts/cmd graphson -d in graph.json
 # start server
 $NEO4J_HOME/bin/neo4j start
     
 

Field Summary

Fields inherited from class eu.ehri.project.commands.BaseCommand

options

Constructor Summary

Constructors

Constructor and Description
GraphSON()

Method Summary

Modifier and Type	Method and Description
int	execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph, org.apache.commons.cli.CommandLine cmdLine) Execute this command with the given database and parsed command line arguments.
String	getHelp() Get information about the functionality of the command.
String	getHelpFooter() Get footer text for the help.
String	getUsage() Get a short hint about the usage of the command.
protected void	setCustomOptions(org.apache.commons.cli.Options options)

Methods inherited from class eu.ehri.project.commands.BaseCommand

api, exec, getDetailedHelp

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphSON

public GraphSON()

Method Detail

getHelp

public String getHelp()

Description copied from interface: Command

Get information about the functionality of the command.

Specified by:

getHelp in interface Command

Specified by:

getHelp in class BaseCommand

Returns:

a help text

getHelpFooter

public String getHelpFooter()

Description copied from interface: Command

Get footer text for the help.

Returns:

a text string

getUsage

public String getUsage()

Description copied from interface: Command

Get a short hint about the usage of the command.

Specified by:

getUsage in interface Command

Specified by:

getUsage in class BaseCommand

Returns:

a usage text

setCustomOptions

protected void setCustomOptions(org.apache.commons.cli.Options options)

Overrides:

setCustomOptions in class BaseCommand

execWithOptions

public int execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph,
                           org.apache.commons.cli.CommandLine cmdLine)
                    throws Exception

Description copied from class: BaseCommand

Execute this command with the given database and parsed command line arguments.

Specified by:

execWithOptions in interface Command

Specified by:

execWithOptions in class BaseCommand

Parameters:

graph - the graph database

cmdLine - the parsed command line object

Returns:

a command return code

Throws:

Exception