com.ibm.etools.iseries.subsystems.qsys.prompter
Class ClStatement

java.lang.Object
  com.ibm.etools.iseries.subsystems.qsys.prompter.ClStatement

public class ClStatement
extends Object

Field Summary

static String

Copyright

Constructor Summary

ClStatement(String statement)

ClStatement(String statement, boolean labelWithColon, boolean ignoreErrors)

Method Summary

String	getCommand()
String	getComment()
String	getCommentWithWrappers()
String	getDefaultLibrary() Retrieves the default library for the CL statement
String	getLabel()
String	getLibrary() Retrieves the library specified for the command.
String	getParms() retrieves the parameters specified in the CL statement
String	getQualifiedCommand() Retrieves the qualified command name
String	getToken(String keyword, int position) Retrieve the value of parameter with the given keyword.
boolean	isBatchProcessingIndicator()
boolean	isCommentHaveSpace() Indicates whether the comment is in standard format and has a space beside the wrappers.
boolean	isPromptCharSpecified() Indicates whether or not the prompt character was specified
boolean	needsPrompting() Indicates whether or not the statement should be prompted, based on selective prompts.

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

ClStatement

public ClStatement(String statement)
            throws ClParseException

Throws:

ClParseException

ClStatement

public ClStatement(String statement,
                   boolean labelWithColon,
                   boolean ignoreErrors)
            throws ClParseException

Throws:

ClParseException

Method Detail

getToken

public String getToken(String keyword,
                       int position)

Retrieve the value of parameter with the given keyword. If the parameter in the requested position is not keyed, then return that value Limitation: It doesn't handle nested brackets i.e. Parm1((COMPLEXa) (COMPLEXb) (COMPLEXc)) ((COMPLEX1) (COMPLEX2) (COMPLEX3)) where the first one is a keyed parameter and the second one is a positional parameter.

Parameters:

keyword -

position -

Returns:

getCommand

public String getCommand()

Returns:

Returns the command.

getComment

public String getComment()

Returns:

Returns the comment.

getCommentWithWrappers

public String getCommentWithWrappers()

Returns:

Returns the comment with comment wrappers / * * /

isCommentHaveSpace

public boolean isCommentHaveSpace()

Indicates whether the comment is in standard format and has a space beside the wrappers.

Returns:

true if the comment has a space, false otherwise.

isBatchProcessingIndicator

public boolean isBatchProcessingIndicator()

Returns:

Returns true if command has a batch proccessing indicator

getLabel

public String getLabel()

Returns:

Returns the label.

getLibrary

public String getLibrary()

Retrieves the library specified for the command.

Returns:

the library or "" if no library was specified.

getParms

public String getParms()

retrieves the parameters specified in the CL statement

Returns:

the parameters specified.

getQualifiedCommand

public String getQualifiedCommand()

Retrieves the qualified command name

Returns:

lib/cmd if a library was specified, cmd otherwise

getDefaultLibrary

public String getDefaultLibrary()

Retrieves the default library for the CL statement

Returns:

the library if it was specified, *LIBL otherwise

isPromptCharSpecified

public boolean isPromptCharSpecified()

Indicates whether or not the prompt character was specified

Returns:

true if ? preceeded the command, false otherwise

needsPrompting

public boolean needsPrompting()

Indicates whether or not the statement should be prompted, based on selective prompts.

Returns:

true if the statement contains selective prompts, false otherwise.