edu.illinois.ncsa.isda.softwareserver.polyglot

Class Polyglot

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.polyglot.Polyglot

Direct Known Subclasses:

PolyglotClient, PolyglotSteward, PolyglotStewardAMQ, PolyglotStewardThreaded

public abstract class Polyglot
extends Object

An interface for file format conversion services that contain at its heart an I/O-Graph built around a set of Software Server clients.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
Polyglot()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close()
abstract String	convert(String input_filename, String output_path, String output_type)
String	convert(String application, String input, String output_path, String output_format) Convert a files format.
String	convertAndEmail(int jobid, String input, String output_path, String output_format, String email) Convert a files format and email the result.
String	convertAndEmail(int jobid, String application, String input, String output_path, String output_format, String email) Convert a files format and email the result.
String	convertAndEmail(String input, String output_path, String output_format, String email) Convert a files format and email the result.
String	convertAndEmail(String application, String input, String output_path, String output_format, String email) Convert a files format and email the result.
void	convertLater(String input_filename, String output_path, String output_type) Convert a files format (asynchronously).
abstract IOGraph<String,String>	getDistributedInputOutputGraph()
abstract IOGraph<String,String>	getInputOutputGraph()
abstract TreeSet<String>	getInputs()
abstract TreeSet<String>	getInputs(String output)
abstract TreeSet<String>	getOutputs()
abstract TreeSet<String>	getOutputs(String input)
TreeSet<String>	getOutputs(String input, int n) Get the outputs available for the given input type, pruning any that requre more than n hops.
abstract TreeSet<String>	getOutputs(TreeSet<String> inputs)
abstract Vector<String>	getServers()
abstract TreeSet<String>	getSoftware()
int	incrementAndGetJobID() Should be overridden.
void	waitOnPending() Wait for all pending asynchronous calls to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

Polyglot

public Polyglot()

Method Detail

getSoftware

public abstract TreeSet<String> getSoftware()

getOutputs

public abstract TreeSet<String> getOutputs()

getOutputs

public abstract TreeSet<String> getOutputs(String input)

getOutputs

public abstract TreeSet<String> getOutputs(TreeSet<String> inputs)

getInputs

public abstract TreeSet<String> getInputs()

getInputs

public abstract TreeSet<String> getInputs(String output)

getInputOutputGraph

public abstract IOGraph<String,String> getInputOutputGraph()

convert

public abstract String convert(String input_filename,
             String output_path,
             String output_type)

getServers

public abstract Vector<String> getServers()

getDistributedInputOutputGraph

public abstract IOGraph<String,String> getDistributedInputOutputGraph()

getOutputs

public TreeSet<String> getOutputs(String input,
                         int n)

Get the outputs available for the given input type, pruning any that requre more than n hops. Should be overridden, by default returns all possible outputs.

Parameters:

input - the input type

n - the maximum number of hops

Returns:

the list of outputs

incrementAndGetJobID

public int incrementAndGetJobID()

Should be overridden. Atomically increase current value of job_counter by one and return new jobid If function does not be overridden by subclass, then RuntimeException will be thrown.

Returns:

a new jobid

convert

public String convert(String application,
             String input,
             String output_path,
             String output_format)

Convert a files format. Should be overriden, by default searches for a conversion path.

Parameters:

application - the specific application to use

input - the absolute name of the input file

output_path - the output path

output_format - the output format

Returns:

the output file name (if changed, null otherwise)

convertAndEmail

public String convertAndEmail(String input,
                     String output_path,
                     String output_format,
                     String email)

Convert a files format and email the result. Should be overriden, by default searches for a conversion path.

Parameters:

input - the absolute name of the input file

output_path - the output path

output_format - the output format

email - address to send result to

Returns:

the output file name (if changed, null otherwise)

convertAndEmail

public String convertAndEmail(int jobid,
                     String input,
                     String output_path,
                     String output_format,
                     String email)

Convert a files format and email the result. Should be overriden, by default searches for a conversion path.

Parameters:

job - id of this conversion

input - the absolute name of the input file

output_path - the output path

output_format - the output format

email - address to send result to

Returns:

the output file name (if changed, null otherwise)

convertAndEmail

public String convertAndEmail(String application,
                     String input,
                     String output_path,
                     String output_format,
                     String email)

Convert a files format and email the result. Should be overriden, by default searches for a conversion path.

Parameters:

application - the specific application to use

input - the absolute name of the input file

output_path - the output path

output_format - the output format

email - address to send result to

Returns:

the output file name (if changed, null otherwise)

convertAndEmail

public String convertAndEmail(int jobid,
                     String application,
                     String input,
                     String output_path,
                     String output_format,
                     String email)

Convert a files format and email the result. Should be overriden, by default searches for a conversion path.

Parameters:

job - id of this conversion

application - the specific application to use

input - the absolute name of the input file

output_path - the output path

output_format - the output format

email - address to send result to

Returns:

the output file name (if changed, null otherwise)

convertLater

public void convertLater(String input_filename,
                String output_path,
                String output_type)

Convert a files format (asynchronously).

Parameters:

input_filename - the absolute name of the input file

output_path - the output path

output_type - the name of the output type

waitOnPending

public void waitOnPending()

Wait for all pending asynchronous calls to complete.

close

public abstract void close()