edu.illinois.ncsa.isda.softwareserver.polyglot.weighted

Class IOGraph2

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.polyglot.weighted.IOGraph2

public class IOGraph2
extends Object

Graph that contains all possible conversions. Conversions are from an input to an output using a specific application. The conversion can have a weight associated which is the correctness of the conversion (ranging from 0 - no information loss, to 9999 - data lost).

Author:

Rob Kooper

Constructor Summary

Constructors

Constructor and Description
IOGraph2() Create an empty IOGraph.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConversion(Conversion2 c) This will add the conversion to the IOGraph.
void	addConversion(int id, String input, String output, String application) This will add the conversion from input to output using the application for the conversion.
void	addConversion(int id, String input, String output, String application, double weight) This will add the conversion from input to output using the application for the conversion with the weight.
void	addConversion(String input, String output, String application) This will add the conversion from input to output using the application for the conversion.
void	addConversion(String input, String output, String application, double weight) This will add the conversion from input to output using the application for the conversion with the weight.
void	addConversions(SoftwareServerClient server) Add all conversions found on the software server.
void	addConversions(String host) Add all conversions found on the software server found at the host.
void	addConversions(String host, int port) Add all conversions found on the software server found at the host.
void	addParameter(int id, String name, String values, String defaultValue)
void	complexity() Print statistics about the IOGraph.
Set<String>	getApplications() List of all applications known to the IOGraph.
Conversion2	getConversion(int id)
List<Conversion2>	getConversions() List of all conversions known to the IOGraph.
List<Conversion2>	getDomain(String vertex) Return the list of all possible conversions reaching the vertex.
List<Conversion2>	getRange(String vertex) Return the list of all possible conversions starting at the vertex.
Map<String,Conversion2>	getShortestPath(String input, boolean useWeights) Return a map that shows for each node what conversion to use to get to the previous node, resulting in then end finding the path all the way back to the source node.
List<Conversion2>	getShortestPath(String input, String output, boolean useWeights) Returns the shortest path from the input to the output.
Set<String>	getValidApplications() Returns the list of all applications used when finding the shortest path.
Set<String>	getVertices() List of all vertices in the graph.
static void	main(String... args)
void	reset() Reset the IOGraph.
void	resetWeights() Sets all the weights of all conversions to unknown.
void	setValidApplications(Set<String> validApplications) Sets the list of applications that should be considered when finding a conversion path.
void	setWeight(String input, String output, String application, double weight) Sets the weight of all conversions matching the triple [input, output, application].
static void	timings(int edges, int formats, int software)

Methods inherited from class java.lang.Object

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

Constructor Detail

IOGraph2

public IOGraph2()

Create an empty IOGraph.

Method Detail

reset

public void reset()

Reset the IOGraph. This will remove all conversion from the list.

addConversions

public void addConversions(String host)
                    throws PolyglotException

Add all conversions found on the software server found at the host. This will use the default port (50000) to connect. The weights assigned to the conversion are set to be undefined.

Parameters:

host - the host running the software server.

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversions

public void addConversions(String host,
                  int port)
                    throws PolyglotException

Add all conversions found on the software server found at the host. The weights assigned to the conversion are set to be undefined.

Parameters:

host - the host running the software server.

port - the port to connect to on the software server

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversions

public void addConversions(SoftwareServerClient server)
                    throws PolyglotException

Add all conversions found on the software server. The weights assigned to the conversion are set to be undefined.

Parameters:

server - the server that has the software server running

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversion

public void addConversion(String input,
                 String output,
                 String application)
                   throws PolyglotException

This will add the conversion from input to output using the application for the conversion. The weights assigned to the conversion are set to be undefined.

Parameters:

input - input format

output - output format

application - application used for the conversion

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversion

public void addConversion(String input,
                 String output,
                 String application,
                 double weight)
                   throws PolyglotException

This will add the conversion from input to output using the application for the conversion with the weight.

Parameters:

input - input format

output - output format

application - application used for the conversion

weight - the weight assigned to the conversion, ranging from 0 (perfect conversion) to unknown weight (10000, all information lost).

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversion

public void addConversion(int id,
                 String input,
                 String output,
                 String application)
                   throws PolyglotException

This will add the conversion from input to output using the application for the conversion. The weights assigned to the conversion are set to be undefined.

Parameters:

id - unique id used to reference the conversion

input - input format

output - output format

application - application used for the conversion

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversion

public void addConversion(int id,
                 String input,
                 String output,
                 String application,
                 double weight)
                   throws PolyglotException

This will add the conversion from input to output using the application for the conversion with the weight.

Parameters:

id - unique id used to reference the conversion

input - input format

output - output format

application - application used for the conversion

weight - the weight assigned to the conversion, ranging from 0 (perfect conversion) to unknown weight (10000, all information lost).

Throws:

PolyglotException - throws PolyglotException if there was a problem adding the conversions to the existing graph.

addConversion

public void addConversion(Conversion2 c)

This will add the conversion to the IOGraph.

Parameters:

c - the conversion to add to the IOGraph

addParameter

public void addParameter(int id,
                String name,
                String values,
                String defaultValue)

resetWeights

public void resetWeights()
                  throws PolyglotException

Sets all the weights of all conversions to unknown.

Throws:

PolyglotException - throws PolyglotException if there was an error setting the weights.

setWeight

public void setWeight(String input,
             String output,
             String application,
             double weight)
               throws PolyglotException

Sets the weight of all conversions matching the triple [input, output, application].

Parameters:

input - input format

output - output format

application - application used for the conversion

weight - the weight assigned to the conversion, ranging from 0 (perfect conversion) to unknown weight (10000, all information lost).

Throws:

PolyglotException - throws PolyglotException if there was an error setting the weights.

setValidApplications

public void setValidApplications(Set<String> validApplications)

Sets the list of applications that should be considered when finding a conversion path. Setting this to null, or an empty set will result in all applications used.

Parameters:

validApplications - list of valid applications to include when searching for the shortest path.

getValidApplications

public Set<String> getValidApplications()

Returns the list of all applications used when finding the shortest path.

Returns:

list of applications used when finding shortest path.

getApplications

public Set<String> getApplications()

List of all applications known to the IOGraph. This includes those applications not used when searching for the shortest path.

Returns:

list of all known applications

getVertices

public Set<String> getVertices()

List of all vertices in the graph. This is combined set of input and output formats.

Returns:

list of all vertices in the IOGraph.

getConversion

public Conversion2 getConversion(int id)

getConversions

public List<Conversion2> getConversions()

List of all conversions known to the IOGraph. These conversions are the edges in the IOGraph.

Returns:

list of all possible conversion in the IOGraph.

getRange

public List<Conversion2> getRange(String vertex)

Return the list of all possible conversions starting at the vertex.

Parameters:

vertex - the starting point in the graph.

Returns:

list of all conversions starting at the vertex.

getDomain

public List<Conversion2> getDomain(String vertex)

Return the list of all possible conversions reaching the vertex.

Parameters:

vertex - the ending point in the graph.

Returns:

list of all conversions reaching the vertex.

getShortestPath

public List<Conversion2> getShortestPath(String input,
                                String output,
                                boolean useWeights)
                                  throws PolyglotException

Returns the shortest path from the input to the output. This will return a list of conversions from the input vertex to the output vertex. This will use the Dijkstra algorithm to find the shortest path.

Parameters:

input - starting vertex in the IOGraph.

output - the finishing vertex in the IOGraph.

useWeights - should the shortest path be based on the weights in the conversion (true), or the smallest number of conversions (false).

Returns:

list of conversions to convert from input format to output format.

Throws:

PolyglotException - throws PolyglotException if no path could be found to go from input to output.

getShortestPath

public Map<String,Conversion2> getShortestPath(String input,
                                      boolean useWeights)

Return a map that shows for each node what conversion to use to get to the previous node, resulting in then end finding the path all the way back to the source node. This function uses Dijstra's algorithm to find the shortest path. This is a greedy algorithm and will not be able to handle negative weights (which are not allowed by the conversions). This has a running time of O( |E| + |V| log |V| )

Parameters:

input - the node to start the search from

Returns:

map from the a output to the previous node to reach the input.

complexity

public void complexity()

Print statistics about the IOGraph.

timings

public static void timings(int edges,
           int formats,
           int software)
                    throws PolyglotException

Throws:

PolyglotException

main

public static void main(String... args)
                 throws Exception

Throws:

Exception