org.neo4j.shell.kernel.apps

Class TransactionProvidingApp

java.lang.Object

org.neo4j.shell.impl.AbstractApp

org.neo4j.shell.kernel.apps.TransactionProvidingApp

All Implemented Interfaces:

App

Direct Known Subclasses:

Cd, Gsh, IndexProviderShellApp, Jsh, Ls, Mknode, Mkrel, Mv, NonTransactionProvidingApp, Pwd, Rm, Rmnode, Rmrel, Schema, Set, Start, Trav

public abstract class TransactionProvidingApp
extends org.neo4j.shell.impl.AbstractApp

An implementation of App which has common methods and functionality to use with neo4j.

Constructor Summary

Constructors

Constructor and Description
TransactionProvidingApp()

Method Summary

Modifier and Type	Method and Description
List<String>	completionCandidates(String partOfLine, Session session) Tries to complete the partOfLine with likely candidates, think of this as a hook for writing TAB-completion.
Continuation	execute(AppCommandParser parser, Session session, Output out) The actual code for the application.
static NodeOrRelationship	getCurrent(GraphDatabaseShellServer server, Session session)
static String	getDisplayName(GraphDatabaseShellServer server, Session session, org.neo4j.graphdb.Node node, boolean checkForMe)
static String	getDisplayName(GraphDatabaseShellServer server, Session session, NodeOrRelationship thing, boolean checkForMe)
static String	getDisplayName(GraphDatabaseShellServer server, Session session, org.neo4j.graphdb.Relationship relationship, boolean verbose, boolean checkForMe)
static String	getDisplayName(GraphDatabaseShellServer server, Session session, org.neo4j.shell.kernel.apps.TypedId typedId, boolean checkForMe)
static String	getDisplayNameForNonExistent()
GraphDatabaseShellServer	getServer() Returns the server this app runs in.
static boolean	isCurrent(Session session, NodeOrRelationship thing)
static List<org.neo4j.shell.kernel.apps.TypedId>	readCurrentWorkingDir(Session session) Reads the session variable specified in Variables.WORKING_DIR_KEY and returns it as a list of typed ids.
static String	withArrows(org.neo4j.graphdb.Relationship relationship, String displayName, org.neo4j.graphdb.Node leftNode)
static void	writeCurrentWorkingDir(List<org.neo4j.shell.kernel.apps.TypedId> paths, Session session)

Methods inherited from class org.neo4j.shell.impl.AbstractApp

getAvailableOptions, getDescription, getDescription, getName, getOptionDefinition, setServer, shutdown, takesOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionProvidingApp

public TransactionProvidingApp()

Method Detail

getCurrent

public static NodeOrRelationship getCurrent(GraphDatabaseShellServer server,
                                            Session session)
                                     throws ShellException

Parameters:

server - the GraphDatabaseShellServer to get the current node/relationship from.

session - the Session used by the client.

Returns:

the current node/relationship the client stands on at the moment.

Throws:

ShellException - if some error occured.

isCurrent

public static boolean isCurrent(Session session,
                                NodeOrRelationship thing)
                         throws ShellException

Throws:

ShellException

getServer

public GraphDatabaseShellServer getServer()

Description copied from interface: App

Returns the server this app runs in.

Specified by:

getServer in interface App

Overrides:

getServer in class org.neo4j.shell.impl.AbstractApp

Returns:

the server this app runs in.

execute

public Continuation execute(AppCommandParser parser,
                            Session session,
                            Output out)
                     throws Exception

Description copied from interface: App

The actual code for the application.

Parameters:

parser - holds the options (w/ or w/o values) as well as arguments.

session - the client session (sort of like the environment for the execution).

out - the output channel for the execution, just like System.out.

Returns:

the result of the execution. It is up to the client to interpret this string, one example is that all apps returns null and the "exit" app returns "e" so that the server interprets the "e" as a sign that it should exit.

Throws:

Exception - if the execution fails.

completionCandidates

public final List<String> completionCandidates(String partOfLine,
                                               Session session)
                                        throws ShellException

Description copied from interface: App

Tries to complete the partOfLine with likely candidates, think of this as a hook for writing TAB-completion. Returned candidates should contain the supplied part as well as possible completions. Implementing this is optional and it's OK to just return an empty list.

Specified by:

completionCandidates in interface App

Overrides:

completionCandidates in class org.neo4j.shell.impl.AbstractApp

Parameters:

partOfLine - the part of the line which the client wants to complete using TAB-completion.

session - the Session from the client caller.

Returns:

a list of candidates which includes the supplied partOfLine as well as possible completions. Returns an empty list if no completions found or if the implementing class chooses not to implement it properly.

Throws:

ShellException - if the execution fails

getDisplayNameForNonExistent

public static String getDisplayNameForNonExistent()

getDisplayName

public static String getDisplayName(GraphDatabaseShellServer server,
                                    Session session,
                                    NodeOrRelationship thing,
                                    boolean checkForMe)
                             throws ShellException

Parameters:

server - the GraphDatabaseShellServer to run at.

session - the Session used by the client.

thing - the thing to get the name-representation for.

checkForMe - check if node/rel is the current one in the session

Returns:

the display name for a Node.

Throws:

ShellException - if an error occurs.

getDisplayName

public static String getDisplayName(GraphDatabaseShellServer server,
                                    Session session,
                                    org.neo4j.shell.kernel.apps.TypedId typedId,
                                    boolean checkForMe)
                             throws ShellException

Parameters:

server - the GraphDatabaseShellServer to run at.

session - the Session used by the client.

typedId - the id for the item to display.

checkForMe - check if node/rel is the current one in the session

Returns:

a display string for the typedId.

Throws:

ShellException - if an error occurs.

getDisplayName

public static String getDisplayName(GraphDatabaseShellServer server,
                                    Session session,
                                    org.neo4j.graphdb.Node node,
                                    boolean checkForMe)
                             throws ShellException

Parameters:

server - the GraphDatabaseShellServer to run at.

session - the Session used by the client.

node - the Node to get a display string for.

checkForMe - check if node is the current one in the session

Returns:

a display string for node.

Throws:

ShellException - if an error occurs.

getDisplayName

public static String getDisplayName(GraphDatabaseShellServer server,
                                    Session session,
                                    org.neo4j.graphdb.Relationship relationship,
                                    boolean verbose,
                                    boolean checkForMe)
                             throws ShellException

Parameters:

server - the GraphDatabaseShellServer to run at.

session - the Session used by the client.

relationship - the Relationship to get a display name for.

verbose - whether or not to include the relationship id as well.

checkForMe - check if relationship is the current one in the session

Returns:

a display string for the relationship.

Throws:

ShellException - if an error occurs.

withArrows

public static String withArrows(org.neo4j.graphdb.Relationship relationship,
                                String displayName,
                                org.neo4j.graphdb.Node leftNode)

readCurrentWorkingDir

public static List<org.neo4j.shell.kernel.apps.TypedId> readCurrentWorkingDir(Session session)
                                                                       throws RemoteException

Reads the session variable specified in Variables.WORKING_DIR_KEY and returns it as a list of typed ids.

Parameters:

session - the session to read from.

Returns:

the working directory as a list.

Throws:

RemoteException - if an RMI error occurs.

writeCurrentWorkingDir

public static void writeCurrentWorkingDir(List<org.neo4j.shell.kernel.apps.TypedId> paths,
                                          Session session)
                                   throws RemoteException

Throws:

RemoteException