edu.ucla.sspace.graph.io

Interface GraphReader

All Known Implementing Classes:

EdgeListReader, GraphMLReader, GraphReaderAdapter

public interface GraphReader

A general interface for reading Graph instances for a variety of formats.

Method Summary

Methods

Modifier and Type	Method and Description
DirectedGraph<DirectedEdge>	readDirected(File f) Reads in the directed graph from the provided file
DirectedGraph<DirectedEdge>	readDirected(File f, Indexer<String> vertexLabels) Reads in the directed graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices.
DirectedMultigraph<String>	readDirectedMultigraph(File f) Reads in the directed multigraph from the provided file.
DirectedMultigraph<String>	readDirectedMultigraph(File f, Indexer<String> vertexLabels) Reads in the graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices.
Graph<Edge>	readUndirected(File f) Reads in the graph from the provided file
Graph<Edge>	readUndirected(File f, Indexer<String> vertexLabels) Reads in the graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices.
Graph<Edge>	readUndirectedFromWeighted(File f, Indexer<String> vertexLabels, double minWeight) Reads in an undirected network from a file containing weighted edges, only keeping those undirected edges whose weight was above the specified threshold
UndirectedMultigraph<String>	readUndirectedMultigraph(File f) Reads in the multigraph from the provided file
UndirectedMultigraph<String>	readUndirectedMultigraph(File f, Indexer<String> vertexLabels) Reads in the multigraph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices.
WeightedGraph<WeightedEdge>	readWeighted(File f) Reads in the weighted graph from the provided file.
WeightedGraph<WeightedEdge>	readWeighted(File f, Indexer<String> vertexLabels) Reads in the weighted graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices.
WeightedGraph<WeightedEdge>	readWeighted(File f, Indexer<String> vertexLabels, double minWeight) Reads in the graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices, and keeping only those weights above the specified value.

Method Detail

readUndirected

Graph<Edge> readUndirected(File f)
                           throws IOException

Reads in the graph from the provided file

Throws:

IOException - if any error occurs while reading the file

readUndirected

Graph<Edge> readUndirected(File f,
                         Indexer<String> vertexLabels)
                           throws IOException

Reads in the graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices. The state of the indexer may be updated as a result of this call. Providing an initially-empty Indexer allows the caller to identify which labels were present in the file initially.

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

Throws:

IOException - if any error occurs while reading the file

readWeighted

WeightedGraph<WeightedEdge> readWeighted(File f)
                                         throws IOException

Reads in the weighted graph from the provided file.

Throws:

IOException - if any error occurs while reading the file

readWeighted

WeightedGraph<WeightedEdge> readWeighted(File f,
                                       Indexer<String> vertexLabels)
                                         throws IOException

Reads in the weighted graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices. The state of the indexer may be updated as a result of this call. Providing an initially-empty Indexer allows the caller to identify which labels were present in the file initially.

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

Throws:

IOException - if any error occurs while reading the file

readWeighted

WeightedGraph<WeightedEdge> readWeighted(File f,
                                       Indexer<String> vertexLabels,
                                       double minWeight)
                                         throws IOException

Reads in the graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices, and keeping only those weights above the specified value. The state of the indexer may be updated as a result of this call. Providing an initially-empty Indexer allows the caller to identify which labels were present in the file initially.

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

minWeight - the minimum weight for any edge in f to have if it is to be added to the returned weighted graph.

Throws:

IOException - if any error occurs while reading the file

readUndirectedFromWeighted

Graph<Edge> readUndirectedFromWeighted(File f,
                                     Indexer<String> vertexLabels,
                                     double minWeight)
                                       throws IOException

Reads in an undirected network from a file containing weighted edges, only keeping those undirected edges whose weight was above the specified threshold

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

minWeight - the minimum weight for any edge in f to have if it is to be added to the returned graph.

Throws:

IOException - if any error occurs while reading the file

readDirected

DirectedGraph<DirectedEdge> readDirected(File f)
                                         throws IOException

Reads in the directed graph from the provided file

Throws:

IOException - if any error occurs while reading the file

readDirected

DirectedGraph<DirectedEdge> readDirected(File f,
                                       Indexer<String> vertexLabels)
                                         throws IOException

Reads in the directed graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices. The state of the indexer may be updated as a result of this call. Providing an initially-empty Indexer allows the caller to identify which labels were present in the file initially.

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

Throws:

IOException - if any error occurs while reading the file

readDirectedMultigraph

DirectedMultigraph<String> readDirectedMultigraph(File f)
                                                  throws IOException

Reads in the directed multigraph from the provided file.

Throws:

IOException - if any error occurs while reading the file

readDirectedMultigraph

DirectedMultigraph<String> readDirectedMultigraph(File f,
                                                Indexer<String> vertexLabels)
                                                  throws IOException

Reads in the graph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices. The state of the indexer may be updated as a result of this call. Providing an initially-empty Indexer allows the caller to identify which labels were present in the file initially.

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

Throws:

IOException - if any error occurs while reading the file

readUndirectedMultigraph

UndirectedMultigraph<String> readUndirectedMultigraph(File f)
                                                      throws IOException

Reads in the multigraph from the provided file

Throws:

IOException - if any error occurs while reading the file

readUndirectedMultigraph

UndirectedMultigraph<String> readUndirectedMultigraph(File f,
                                                    Indexer<String> vertexLabels)
                                                      throws IOException

Reads in the multigraph from the provided file, using the specified Indexer to decide how vertex labels in the file are mapped to numeric vertices. The state of the indexer may be updated as a result of this call. Providing an initially-empty Indexer allows the caller to identify which labels were present in the file initially.

Parameters:

vertexLabels - the mapping to use when converting form label to vertex ordinal

Throws:

IOException - if any error occurs while reading the file