oracle.ifs.protocols.cup.commands

Class CupArgumentTranslator

java.lang.Object

oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

oracle.ifs.protocols.cup.commands.CupArgumentTranslator

All Implemented Interfaces:

ArgumentTranslator

Direct Known Subclasses:

CupAddRefArgumentTranslator, CupCatArgumentTranslator, CupGetAttrArgumentTranslator, CupLsArgumentTranslator, CupRmArgumentTranslator, CupSetAttrArgumentTranslator, CupShowAllPathsArgumentTranslator

public class CupArgumentTranslator
extends CommandlineArgumentTranslator

CupArgumentTranslator handles the positionals and flags that are generally used by cup. Any command specific positionals and flags are to be handled by specific translators.

Version:

1.0

Author:

Vijayanth Devadhar

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	FLAG_CLASS String representing the class flag.
protected String	FLAG_ID String representing the id flag.
protected String	FLAG_PATH String representing the path flag.
protected String	FLAG_SYSTEMACL String representing the systemacl flag.
protected String	FLAG_USER String representing the user flag.
protected String	FLAG_VALUEDEFAULT String representing the valuedefault flag.
protected static String	PARAMETER_FLAGKEY Name of the flagkey parameter in the hashtable.
protected static String	PARAMETER_FLAGVALUE Name of the flagvalue parameter in the hashtable.
protected static String	PARAMETER_POSITIONAL Name of the positional parameter in the hashtable.

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

CMDKEY

Constructor Summary

Constructors

Constructor and Description
CupArgumentTranslator()

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 positionals that are common to several cup commands.
protected void	initialize(CommandContext state, Object invoker, Hashtable tstate) Initialize the argument translator.
protected LibraryObject[]	resolveObject(LibrarySession session, FolderPathResolver fpr, Hashtable tstate, boolean multipleObjectsAllowed) This returns an array of LibraryObjects based on the flags and positionals.

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

parse, postParse, translate

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_FLAGKEY

protected static final String PARAMETER_FLAGKEY

Name of the flagkey parameter in the hashtable.

See Also:

Constant Field Values

(Published)

PARAMETER_POSITIONAL

protected static final String PARAMETER_POSITIONAL

Name of the positional parameter in the hashtable.

See Also:

Constant Field Values

(Published)

PARAMETER_FLAGVALUE

protected static final String PARAMETER_FLAGVALUE

Name of the flagvalue parameter in the hashtable.

See Also:

Constant Field Values

(Published)

FLAG_CLASS

protected final String FLAG_CLASS

String representing the class flag.

See Also:

Constant Field Values

(Published)

FLAG_ID

protected final String FLAG_ID

String representing the id flag.

See Also:

Constant Field Values

(Published)

FLAG_PATH

protected final String FLAG_PATH

String representing the path flag.

See Also:

Constant Field Values

(Published)

FLAG_SYSTEMACL

protected final String FLAG_SYSTEMACL

String representing the systemacl flag.

See Also:

Constant Field Values

(Published)

FLAG_USER

protected final String FLAG_USER

String representing the user flag.

See Also:

Constant Field Values

(Published)

FLAG_VALUEDEFAULT

protected final String FLAG_VALUEDEFAULT

String representing the valuedefault flag.

See Also:

Constant Field Values

(Published)

Constructor Detail

CupArgumentTranslator

public CupArgumentTranslator()

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.

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)

resolveObject

protected LibraryObject[] resolveObject(LibrarySession session,
                                        FolderPathResolver fpr,
                                        Hashtable tstate,
                                        boolean multipleObjectsAllowed)
                                 throws IfsException

This returns an array of LibraryObjects based on the flags and positionals. This method is generally called by postParse() methods of the derived classes.

Parameters:

session - the session

fpr - resolver for folder paths

tstate - hashtable used to store flags

multipleObjectsAllowed - if true, flags can resolve into multiple objects

Throws:

IfsException - if the operation fails

(Published)

handlePositional

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

Handles the positionals that are common to several cup commands.

Overrides:

handlePositional in class CommandlineArgumentTranslator

Parameters:

pos - position

positional - the positional

state - runtime command context

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:

String[] 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)