org.neo4j.visualization.asciidoc

Class AsciidocHelper

java.lang.Object

org.neo4j.visualization.asciidoc.AsciidocHelper

public class AsciidocHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
AsciidocHelper()

Method Summary

Modifier and Type	Method and Description
static String	createAsciiDocSnippet(String language, String formattedQuery)
static String	createCypherSnippet(String query)
static String	createCypherSnippetFromPreformattedQuery(String formattedQuery, boolean executable)
static String	createGraphViz(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier)
static String	createGraphViz(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier, GraphStyle graphStyle) Create graphviz output using a GraphStyle.
static String	createGraphViz(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier, GraphStyle graphStyle, String graphvizOptions)
static String	createGraphViz(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier, String graphvizOptions)
static String	createGraphVizDeletingReferenceNode(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier)
static String	createGraphVizDeletingReferenceNode(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier, String graphvizOptions)
static String	createGraphVizWithNodeId(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier)
static String	createGraphVizWithNodeId(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier, String graphvizOptions)
static String	createGraphVizWithNodeIdDeletingReferenceNode(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier)
static String	createGraphVizWithNodeIdDeletingReferenceNode(String title, org.neo4j.graphdb.GraphDatabaseService graph, String identifier, String graphvizOptions)
static String	createOutputSnippet(String output)
static String	createQueryFailureSnippet(String output)
static String	createQueryResultSnippet(String output)
static String	createSqlSnippet(String query)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsciidocHelper

public AsciidocHelper()

Method Detail

createGraphViz

public static String createGraphViz(String title,
                                    org.neo4j.graphdb.GraphDatabaseService graph,
                                    String identifier)

createGraphViz

public static String createGraphViz(String title,
                                    org.neo4j.graphdb.GraphDatabaseService graph,
                                    String identifier,
                                    String graphvizOptions)

createGraphVizWithNodeId

public static String createGraphVizWithNodeId(String title,
                                              org.neo4j.graphdb.GraphDatabaseService graph,
                                              String identifier)

createGraphVizWithNodeId

public static String createGraphVizWithNodeId(String title,
                                              org.neo4j.graphdb.GraphDatabaseService graph,
                                              String identifier,
                                              String graphvizOptions)

createGraphVizDeletingReferenceNode

public static String createGraphVizDeletingReferenceNode(String title,
                                                         org.neo4j.graphdb.GraphDatabaseService graph,
                                                         String identifier)

createGraphVizDeletingReferenceNode

public static String createGraphVizDeletingReferenceNode(String title,
                                                         org.neo4j.graphdb.GraphDatabaseService graph,
                                                         String identifier,
                                                         String graphvizOptions)

createGraphVizWithNodeIdDeletingReferenceNode

public static String createGraphVizWithNodeIdDeletingReferenceNode(String title,
                                                                   org.neo4j.graphdb.GraphDatabaseService graph,
                                                                   String identifier)

createGraphVizWithNodeIdDeletingReferenceNode

public static String createGraphVizWithNodeIdDeletingReferenceNode(String title,
                                                                   org.neo4j.graphdb.GraphDatabaseService graph,
                                                                   String identifier,
                                                                   String graphvizOptions)

createGraphViz

public static String createGraphViz(String title,
                                    org.neo4j.graphdb.GraphDatabaseService graph,
                                    String identifier,
                                    GraphStyle graphStyle)

Create graphviz output using a GraphStyle. GraphStyle is implemented by AsciiDocSimpleStyle and AsciiDocStyle. AsciiDocSimpleStyle provides different customization options for coloring.

Parameters:

title - the title of the visualization

graph - the database to use

identifier - the identifier to include in the filename

graphStyle - the style configuration to use

Returns:

a string to be included in an AsciiDoc document

createGraphViz

public static String createGraphViz(String title,
                                    org.neo4j.graphdb.GraphDatabaseService graph,
                                    String identifier,
                                    GraphStyle graphStyle,
                                    String graphvizOptions)

createOutputSnippet

public static String createOutputSnippet(String output)

createQueryResultSnippet

public static String createQueryResultSnippet(String output)

createQueryFailureSnippet

public static String createQueryFailureSnippet(String output)

createCypherSnippet

public static String createCypherSnippet(String query)

createSqlSnippet

public static String createSqlSnippet(String query)

createCypherSnippetFromPreformattedQuery

public static String createCypherSnippetFromPreformattedQuery(String formattedQuery,
                                                              boolean executable)

createAsciiDocSnippet

public static String createAsciiDocSnippet(String language,
                                           String formattedQuery)