Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.util
Class IBMIQSYSEventFileCommandDetector

java.lang.Object
  extended by com.ibm.etools.iseries.util.IBMIQSYSEventFileCommandDetector

public class IBMIQSYSEventFileCommandDetector
extends Object

This class is used to determine if a command will generate an event file, and if so to determine what the event file name will be. It is like a policy for these heuristics.

A singleton instance of this class is provided. Clients can subclass to provide their own policies for determining whether and how events file are supported and what the name will be.


Field Summary
static String Copyright
           
 
Constructor Summary
IBMIQSYSEventFileCommandDetector()
          Constructor.
 
Method Summary
static IBMIQSYSEventFileCommandDetector getDefaultEventFileDetector()
          Return the singleton instance of this class.
 String getEventFileMemberName(String commandString)
          This method retrieves the event file member name, which is intended to be the same name as the target compile object.
 boolean supportsEventFiles(String commandString)
          This method tells us whether the given command string supports generation of event files.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

IBMIQSYSEventFileCommandDetector

public IBMIQSYSEventFileCommandDetector()
Constructor.

Method Detail

getDefaultEventFileDetector

public static IBMIQSYSEventFileCommandDetector getDefaultEventFileDetector()
Return the singleton instance of this class.

Parameters:
the - singleton instance of this class.

supportsEventFiles

public boolean supportsEventFiles(String commandString)
This method tells us whether the given command string supports generation of event files.

By default, it tries to deduce this by looking at the given command string, using the following heuristics:

Override this method if your command will generate an event file, but does not have these triggers.

Parameters:
commandString - the command string that will be submitted to the server for running. It will be interrogated.
Returns:
true if events file will be generated, false otherwise.

getEventFileMemberName

public String getEventFileMemberName(String commandString)
This method retrieves the event file member name, which is intended to be the same name as the target compile object.

By default, it first calls supportsEventFiles to ensure this is an event file generating command, and if so, then it tries to pick the event file member name out of the given command string, using the following heuristics:

Override this method if your command will generate an event file, but does not have these SRCMBR, MODULE or PGM parameters.

Parameters:
commandString - command string that will be submitted to the server for running. It will be interrogated.
Returns:
the events file member name if one is expected to be created, otherwise null

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.