oracle.ifs.protocols.commands

Class IfsCatCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCatCommand

All Implemented Interfaces:

Command

public class IfsCatCommand
extends IfsCommand

An IfsCatCommand renders a LibraryObject for text display. First an attempt is made to render the LO as a Reader. If the LO is not capable of being rendered as a reader it is then rendered as a Stream. It is expected that an invoking environment will correctly handle the results. If a reader is generated then characters are taken care of. If a stream is generated then the best one can do when displaying is to assume that the stream is in the ISO8859 character set. How the object is rendered is determined by the options passed into the command.

Command specification for IfsCatCommand

Inputs:

• lo : LibraryObject (required)
• rendererType : String (optional)
• rendererName : String (optional)
• rendererOptions : Hashtable (optional)

Outputs :

• reader : Reader
• stream : Stream

Description:

• Takes a LibraryObject and renders it. How it is rendered is determined by the renderer type, renderer namem and renderer options. Either a Reader or a Stream will be returned

Version:

0.9

Author:

Kevin Gillett

See Also:

IfsCommand

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCatCommand() Constructor.

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CatContext context) Execute a CatContext
protected void	execute(CommandContext context) Execute a CommandContext
protected void	executeRenderAsReader(CatContext cc)
protected void	executeRenderAsStream(CatContext cc)
protected IfsRenderAsReaderCommand	getReaderCommand()
protected IfsRenderAsStreamCommand	getStreamCommand()
void	populateNestedCommands(CommandInvoker commandInvoker) Populate all the needed nested commands.

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

postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsCatCommand

public IfsCatCommand()

Constructor.

Method Detail

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invocation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

a instance of the CommandContext.

Throws:

IfsException

See Also:

CommandContext

(Published)

populateNestedCommands

public void populateNestedCommands(CommandInvoker commandInvoker)
                            throws IfsException

Description copied from class: IfsCommand

Populate all the needed nested commands.

CommandInvoker is not guaranteed to exist for the lifetime of the command. Therefore, the command should not keep a reference to the command invoker and it should acquire all the references to the needed commands in this call-back method.

Specified by:

populateNestedCommands in interface Command

Overrides:

populateNestedCommands in class IfsCommand

Parameters:

commandInvoker - The CommandInvoker object that can be used to acquire references to the needed sub-commands.

Throws:

IfsException - If there is any exception thrown.

See Also:

CommandInvoker

execute

protected void execute(CommandContext context)
                throws IfsException

Execute a CommandContext

Overrides:

execute in class IfsCommand

Parameters:

context - the command context.

Throws:

IfsException - if execution fails

execute

protected void execute(CatContext context)
                throws IfsException

Execute a CatContext

Parameters:

context - the command context.

Throws:

IfsException - if execution fails

getReaderCommand

protected IfsRenderAsReaderCommand getReaderCommand()
                                             throws IfsException

Throws:

IfsException

getStreamCommand

protected IfsRenderAsStreamCommand getStreamCommand()
                                             throws IfsException

Throws:

IfsException

executeRenderAsReader

protected void executeRenderAsReader(CatContext cc)
                              throws IfsException

Throws:

IfsException

executeRenderAsStream

protected void executeRenderAsStream(CatContext cc)
                              throws IfsException

Throws:

IfsException