edu.isi.pegasus.planner.visualize

Interface Callback

All Known Implementing Classes:

NetloggerCallback, NodeUsageCallback, SpaceUsageCallback, TailStatd

public interface Callback

This callback interface has methods to handle the data sections for stdout, stderr and stdin.

Version:

$Revision: 2587 $

Author:

Karan Vahi vahi@isi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION The version of the API.

Method Summary

Methods

Modifier and Type	Method and Description
void	cbInputFile(String filename, StatInfo info) Callback function for when stat information for an input file is encountered
void	cbInvocationEnd() Callback signalling that an invocation record has been parsed.
void	cbInvocationStart(String job, String resource) Callback for the starting of an invocation record.
void	cbMachine(Machine machine) Callback to pass the machine information on which the job is executed.
void	cbMetadata(Map metadata) Callback for the metadata retrieved from the kickstart record.
void	cbOutputFile(String filename, StatInfo info) Callback function for when stat information for an output file is encountered
void	cbStdERR(List jobs, String data) Callback function for the data section of stderr.
void	cbStdIN(List jobs, String data) Callback function for the data section of stdin.
void	cbStdOut(List jobs, String data) Callback function for the data section of stdout.
void	done() Callback signalling that we are done with the parsing of the files.
Object	getConstructedObject() Returns the object constructed.
void	initialize(String directory, boolean useStatInfo) Initializes the callback.

Field Detail

VERSION

static final String VERSION

The version of the API.

See Also:

Constant Field Values

Method Detail

initialize

void initialize(String directory,
              boolean useStatInfo)

Initializes the callback.

Parameters:

directory - the directory where all the files reside.

useStatInfo - boolean indicating whether to use stat info or not.

cbInvocationStart

void cbInvocationStart(String job,
                     String resource)

Callback for the starting of an invocation record.

Parameters:

job - the job/file being parsed.

resource - the site id where the job was executed.

cbStdIN

void cbStdIN(List jobs,
           String data)

Callback function for the data section of stdin. Since the jobs ( setup, prejob, main, postjob, cleanup) do not have separate stdout etc, all are passed.

Parameters:

jobs - all the jobs specified in the kickstart record.

data - the data contents as String.

cbStdOut

void cbStdOut(List jobs,
            String data)

Callback function for the data section of stdout. Since the jobs ( setup, prejob, main, postjob, cleanup) do not have separate stdout etc, all are passed.

Parameters:

jobs - all the jobs specified in the kickstart record.

data - the data contents as String.

cbStdERR

void cbStdERR(List jobs,
            String data)

Callback function for the data section of stderr. Since the jobs ( setup, prejob, main, postjob, cleanup) do not have separate stdout etc, all are passed.

Parameters:

jobs - all the jobs specified in the kickstart record.

data - the data contents as String.

cbInputFile

void cbInputFile(String filename,
               StatInfo info)

Callback function for when stat information for an input file is encountered

Parameters:

filename - the name of the file.

info - the StatInfo about the file.

cbOutputFile

void cbOutputFile(String filename,
                StatInfo info)

Callback function for when stat information for an output file is encountered

Parameters:

filename - the name of the file.

info - the StatInfo about the file.

cbInvocationEnd

void cbInvocationEnd()

Callback signalling that an invocation record has been parsed.

done

void done()

Callback signalling that we are done with the parsing of the files.

getConstructedObject

Object getConstructedObject()

Returns the object constructed.

Returns:

the Object constructed.

cbMetadata

void cbMetadata(Map metadata)

Callback for the metadata retrieved from the kickstart record.

Parameters:

metadata -

cbMachine

void cbMachine(Machine machine)

Callback to pass the machine information on which the job is executed.

Parameters:

machine -