com.ibm.etools.iseries.subsystems.qsys.commands
Class QSYSEventFileCommandDetector

java.lang.Object
  com.ibm.etools.iseries.subsystems.qsys.commands.QSYSEventFileCommandDetector

public class QSYSEventFileCommandDetector
extends Object

This class is used by the command subsystem, when running a command, to determine if the 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.

By default, the command subsystem using a singleton instance of this class. However, for business partners that run their own compile commands, which generate event files, this policy can be subclassed and refined, and explicitly passed to the runCommand method in the subsystem.

Field Summary

static String

Copyright

Constructor Summary

QSYSEventFileCommandDetector()
Constructor for ISeriesCompileHelper.

Method Summary

static QSYSEventFileCommandDetector	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

QSYSEventFileCommandDetector

public QSYSEventFileCommandDetector()

Constructor for ISeriesCompileHelper.

Method Detail

getDefaultEventFileDetector

public static QSYSEventFileCommandDetector getDefaultEventFileDetector()

Return 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:

• Does command string have *SRCDBG parm? Yes, return true
• Does command string have *LSTDBG parm? Yes, return true
• Does command string have *EVENTF parm? Yes, return true
• Else return false

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.

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, if 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:

• Does command string have SRCMBR parm? Yes, use that value
• Does command string have STRSTMF parm? Yes, then maybe it is a compile-from-IFS command, so continue, else return null.
• Does command string have MODULE or PGM parm? Yes, use the non-library part of that value
• Otherwise, return null. There will be no event file retrieval support for this command.

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