org.gradoop.common.util

Class AsciiGraphLoader<G extends GraphHead,V extends Vertex,E extends Edge>

java.lang.Object

org.gradoop.common.util.AsciiGraphLoader<G,V,E>

Type Parameters:

G - graph head type

V - vertex type

E - edge type

public class AsciiGraphLoader<G extends GraphHead,V extends Vertex,E extends Edge>
extends Object

Creates collections of graphs, vertices and edges from a given GDL script.

See Also:

GDL on GitHub

Method Summary

Modifier and Type	Method and Description
void	appendFromString(String asciiGraph) Appends the given ASCII GDL to the graph handled by that loader.
static <G extends GraphHead,V extends Vertex,E extends Edge> AsciiGraphLoader<G,V,E>	fromFile(String fileName, ElementFactoryProvider<G,V,E> elementFactoryProvider) Creates an AsciiGraphLoader from the given ASCII GDL file.
static <G extends GraphHead,V extends Vertex,E extends Edge> AsciiGraphLoader<G,V,E>	fromStream(InputStream inputStream, ElementFactoryProvider<G,V,E> elementFactoryProvider) Creates an AsciiGraphLoader from the given ASCII GDL file.
static <G extends GraphHead,V extends Vertex,E extends Edge> AsciiGraphLoader<G,V,E>	fromString(String asciiGraph, ElementFactoryProvider<G,V,E> elementFactoryProvider) Creates an AsciiGraphLoader from the given ASCII GDL string.
E	getEdgeByVariable(String variable) Returns edge by its given variable.
Map<String,E>	getEdgeCache() Returns all edges that are bound to a variable in the GDL script.
Collection<E>	getEdges() Returns all edges contained in the ASCII graph.
Collection<E>	getEdgesByGraphIds(GradoopIdSet graphIds) Returns all edges that belong to the given graphs.
Collection<E>	getEdgesByGraphVariables(String... variables) Returns all edges that belong to the given graph variables.
Collection<E>	getEdgesByVariables(String... variables) Returns edges by their given variables.
G	getGraphHeadByVariable(String variable) Returns GraphHead by given variable.
Map<String,G>	getGraphHeadCache() Returns all graph heads that are bound to a variable in the GDL script.
Collection<G>	getGraphHeads() Returns all GraphHeads contained in the ASCII graph.
Collection<G>	getGraphHeadsByVariables(String... variables) Returns GraphHeads by their given variables.
V	getVertexByVariable(String variable) Returns vertex by its given variable.
Map<String,V>	getVertexCache() Returns all vertices that are bound to a variable in the GDL script.
Collection<V>	getVertices() Returns all vertices contained in the ASCII graph.
Collection<V>	getVerticesByGraphIds(GradoopIdSet graphIds) Returns all vertices that belong to the given graphs.
Collection<V>	getVerticesByGraphVariables(String... graphVariables) Returns all vertices that belong to the given graph variables.
Collection<V>	getVerticesByVariables(String... variables) Returns vertices by their given variables.

Methods inherited from class java.lang.Object

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

Method Detail

fromString

public static <G extends GraphHead,V extends Vertex,E extends Edge> AsciiGraphLoader<G,V,E> fromString(String asciiGraph,
                                                                                                       ElementFactoryProvider<G,V,E> elementFactoryProvider)

Creates an AsciiGraphLoader from the given ASCII GDL string.

Type Parameters:

G - graph head type

V - vertex type

E - edge type

Parameters:

asciiGraph - GDL string

elementFactoryProvider - Factory provider for graph elements.

Returns:

AsciiGraphLoader

fromFile

public static <G extends GraphHead,V extends Vertex,E extends Edge> AsciiGraphLoader<G,V,E> fromFile(String fileName,
                                                                                                     ElementFactoryProvider<G,V,E> elementFactoryProvider)
                                                                                              throws IOException

Creates an AsciiGraphLoader from the given ASCII GDL file.

Type Parameters:

G - graph head type

V - vertex type

E - edge type

Parameters:

fileName - File that contains a GDL script

elementFactoryProvider - Factory provider for graph elements.

Returns:

AsciiGraphLoader

Throws:

IOException - on failure

fromStream

public static <G extends GraphHead,V extends Vertex,E extends Edge> AsciiGraphLoader<G,V,E> fromStream(InputStream inputStream,
                                                                                                       ElementFactoryProvider<G,V,E> elementFactoryProvider)
                                                                                                throws IOException

Creates an AsciiGraphLoader from the given ASCII GDL file.

Type Parameters:

G - graph head type

V - vertex type

E - edge type

Parameters:

inputStream - File that contains a GDL script

elementFactoryProvider - Factory provider for graph elements.

Returns:

AsciiGraphLoader

Throws:

IOException - on failure

appendFromString

public void appendFromString(String asciiGraph)

Appends the given ASCII GDL to the graph handled by that loader. Variables that were previously used, can be reused in the given script and refer to the same entities.

Parameters:

asciiGraph - GDL string

getGraphHeads

public Collection<G> getGraphHeads()

Returns all GraphHeads contained in the ASCII graph.

Returns:

graphHeads

getGraphHeadByVariable

public G getGraphHeadByVariable(String variable)

Returns GraphHead by given variable.

Parameters:

variable - variable used in GDL script

Returns:

graphHead or null if graph is not cached

getGraphHeadsByVariables

public Collection<G> getGraphHeadsByVariables(String... variables)

Returns GraphHeads by their given variables.

Parameters:

variables - variables used in GDL script

Returns:

graphHeads that are assigned to the given variables

getVertices

public Collection<V> getVertices()

Returns all vertices contained in the ASCII graph.

Returns:

vertices

getVertexByVariable

public V getVertexByVariable(String variable)

Returns vertex by its given variable.

Parameters:

variable - variable used in GDL script

Returns:

vertex or null if not present

getVerticesByVariables

public Collection<V> getVerticesByVariables(String... variables)

Returns vertices by their given variables.

Parameters:

variables - variables used in GDL script

Returns:

vertices

getVerticesByGraphIds

public Collection<V> getVerticesByGraphIds(GradoopIdSet graphIds)

Returns all vertices that belong to the given graphs.

Parameters:

graphIds - graph identifiers

Returns:

vertices that are contained in the graphs

getVerticesByGraphVariables

public Collection<V> getVerticesByGraphVariables(String... graphVariables)

Returns all vertices that belong to the given graph variables.

Parameters:

graphVariables - graph variables used in the GDL script

Returns:

vertices that are contained in the graphs

getEdges

public Collection<E> getEdges()

Returns all edges contained in the ASCII graph.

Returns:

edges

getEdgeByVariable

public E getEdgeByVariable(String variable)

Returns edge by its given variable.

Parameters:

variable - variable used in GDL script

Returns:

edge or null if not present

getEdgesByVariables

public Collection<E> getEdgesByVariables(String... variables)

Returns edges by their given variables.

Parameters:

variables - variables used in GDL script

Returns:

edges

getEdgesByGraphIds

public Collection<E> getEdgesByGraphIds(GradoopIdSet graphIds)

Returns all edges that belong to the given graphs.

Parameters:

graphIds - Graph identifiers

Returns:

edges

getEdgesByGraphVariables

public Collection<E> getEdgesByGraphVariables(String... variables)

Returns all edges that belong to the given graph variables.

Parameters:

variables - graph variables used in the GDL script

Returns:

edges

getGraphHeadCache

public Map<String,G> getGraphHeadCache()

Returns all graph heads that are bound to a variable in the GDL script.

Returns:

variable to graphHead mapping

getVertexCache

public Map<String,V> getVertexCache()

Returns all vertices that are bound to a variable in the GDL script.

Returns:

variable to vertex mapping

getEdgeCache

public Map<String,E> getEdgeCache()

Returns all edges that are bound to a variable in the GDL script.

Returns:

variable to edge mapping