oracle.ifs.protocols.cup.commands

Class CupFindArgumentTranslator

java.lang.Object

oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

oracle.ifs.protocols.cup.commands.CupFindArgumentTranslator

All Implemented Interfaces:

ArgumentTranslator

public class CupFindArgumentTranslator
extends CommandlineArgumentTranslator

CupFindArgumentTranslator handles the positionals that cup uses during the FIND Command.

Version:

1.0

Author:

Vijayanth Devadhar

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	FLAG_LIST_ATTRALL String representing the all attribute listing flag.
protected String	FLAG_LIST_ATTRNAME String representing the attribute name based lisiting flag.
protected String	FLAG_LIST_LONG String representing the long format lisiting flag.

Fields inherited from class oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

CMDKEY

Constructor Summary

Constructors

Constructor and Description
CupFindArgumentTranslator()

Method Summary

Modifier and Type	Method and Description
protected int[]	getPotentialArgs() Gets the argument type a particular flag is expecting.
protected String[]	getPotentialFlags() Gets the potentails flags that the object might be expecting.
protected void	handleFlag(String flagKey, String flagValue, CommandContext state, Hashtable tstate) Handles a flags and arguments in the command line.
protected void	handlePositional(int pos, String positional, CommandContext state, Hashtable tState) Handles the positional arguments that cup uses during the FIND command.
protected void	initialize(CommandContext state, Object invoker, Hashtable tstate) Initialize the argument translator.
protected void	postParse(CommandContext state, Object invoker, Hashtable tstate) Sets up the InvokeSelectorAndListOutputContext with parameters required

Methods inherited from class oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

parse, translate

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_LIST_LONG

protected final String FLAG_LIST_LONG

String representing the long format lisiting flag.

See Also:

Constant Field Values

(Published)

FLAG_LIST_ATTRNAME

protected final String FLAG_LIST_ATTRNAME

String representing the attribute name based lisiting flag.

See Also:

Constant Field Values

(Published)

FLAG_LIST_ATTRALL

protected final String FLAG_LIST_ATTRALL

String representing the all attribute listing flag.

See Also:

Constant Field Values

(Published)

Constructor Detail

CupFindArgumentTranslator

public CupFindArgumentTranslator()

Method Detail

initialize

protected void initialize(CommandContext state,
                          Object invoker,
                          Hashtable tstate)
                   throws IfsException

Initialize the argument translator. Setting up argument hashtable with default values for arguments is done here. Add to tstate hashtable any specific parameters taht are handled by the base class.

Overrides:

initialize in class CommandlineArgumentTranslator

Parameters:

state - instance of CommandContext

invoker - invoker of this command; usually CupServerChannel

tstate - hashtable used to store flags

Throws:

IfsException - if the operation fails

(Published)

postParse

protected void postParse(CommandContext state,
                         Object invoker,
                         Hashtable tstate)
                  throws IfsException

Sets up the InvokeSelectorAndListOutputContext with parameters required

Overrides:

postParse in class CommandlineArgumentTranslator

Parameters:

state - instance of CommandContext

invoker - invoker of this command; usually CupServerChannel

tstate - hashtable used to store flags

Throws:

IfsException - if the operation fails

(Published)

getPotentialFlags

protected String[] getPotentialFlags()

Gets the potentails flags that the object might be expecting.

Overrides:

getPotentialFlags in class CommandlineArgumentTranslator

Returns:

String[] arry of String objects representing flags

(Published)

getPotentialArgs

protected int[] getPotentialArgs()

Gets the argument type a particular flag is expecting.

Overrides:

getPotentialArgs in class CommandlineArgumentTranslator

Returns:

int[] arry of String objects representing flags

(Published)

handleFlag

protected void handleFlag(String flagKey,
                          String flagValue,
                          CommandContext state,
                          Hashtable tstate)
                   throws IfsException

Handles a flags and arguments in the command line.

Overrides:

handleFlag in class CommandlineArgumentTranslator

Parameters:

flagKey - key used to identify the flag in the command line

flagValue - value of the flag

state - instance of CommandContext object

tstate - hashtable which stores parameters

Throws:

IfsException - if the operation fails

(Published)

handlePositional

protected void handlePositional(int pos,
                                String positional,
                                CommandContext state,
                                Hashtable tState)
                         throws IfsException

Handles the positional arguments that cup uses during the FIND command.

Overrides:

handlePositional in class CommandlineArgumentTranslator

Parameters:

pos - position of the argument

positional - string corresponding to the position

state - instance of CommandContext

Throws:

IfsException - if the operation fails.

(Published)