oracle.ifs.protocols.commands

Class IfsAttributeStringDisplayCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsAttributeStringDisplayCommand

All Implemented Interfaces:

Command

public class IfsAttributeStringDisplayCommand
extends IfsCommand

An IfsAttributeStringDisplayCommand supports string displaying of a LibraryObject's attributes through different format options.

Command specification for IfsAttributeStringDisplayCommand

Inputs:

• session : LibrarySession (required)
• lo : LibraryObject (required)
• attrs : Attributes[] (optional)
• buffer : StringBuffer (optional)
• namesOnly : boolean

Outputs :

• buffer : StringBuffer

Description:

• Takes a LibraryObject, LibrarySession, and optionally an array of Attributes and outputs them into an optionally preexisting StringBuffer. If the array of attributes is not null then only the attributes are displayed in a Cup like manner. If the attributes are null then the display is either names only or long form. Names only displays like ls and long form displays like ls -l

Version:

0.9

Author:

Kevin Gillett

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsAttributeStringDisplayCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected StringBuffer	displayLongList(StringBuffer buffer, LibraryObject lo, LibrarySession session, boolean obfuscate)
protected StringBuffer	displayName(StringBuffer buffer, LibraryObject lo, LibrarySession session)
protected void	execute(AttributeStringDisplayContext context) Executes a AttributeStringDisplayContext.
protected void	execute(CommandContext context) Execute a CommandContext.
protected String	getMeaningfulString(AttributeValue attr, LibrarySession session, boolean obfuscate) Gets a meaningful string based on the type of AttributeValue.
protected String	getMeaningfulString(boolean[] objs) Gets a meaningful string for a boolean[].
protected String	getMeaningfulString(Date[] objs, boolean obfuscate) Gets a meaningful string for a Date[].
protected String	getMeaningfulString(double[] objs) Gets a meaningful string for a double[].
protected String	getMeaningfulString(int[] objs) Gets a meaningful string for a int[].
protected String	getMeaningfulString(LibraryObject[] objs, boolean obfuscate) Gets a meaningful string for a LibraryObject[].
protected String	getMeaningfulString(LibraryObject obj, boolean obfuscate) Gets a meaningful string for a LibraryObject.
protected String	getMeaningfulString(long[] objs) Gets a meaningful string for a long[].
protected String	getMeaningfulString(Map map)
protected String	getMeaningfulString(String[] objs) Gets a meaningful string for a String[].
protected StringBuffer	outputObjectVertical(StringBuffer buffer, LibraryObject obj, AttributeValue[] attrs, LibrarySession session, boolean obfuscate)

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

populateNestedCommands, postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsAttributeStringDisplayCommand

public IfsAttributeStringDisplayCommand()

Defualt Constructor

(Published)

Method Detail

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

(Published)

execute

protected void execute(AttributeStringDisplayContext context)
                throws IfsException

Executes a AttributeStringDisplayContext.

Throws:

IfsException

(Published)

displayLongList

protected StringBuffer displayLongList(StringBuffer buffer,
                                       LibraryObject lo,
                                       LibrarySession session,
                                       boolean obfuscate)
                                throws IfsException

Throws:

IfsException

displayName

protected StringBuffer displayName(StringBuffer buffer,
                                   LibraryObject lo,
                                   LibrarySession session)
                            throws IfsException

Throws:

IfsException

outputObjectVertical

protected StringBuffer outputObjectVertical(StringBuffer buffer,
                                            LibraryObject obj,
                                            AttributeValue[] attrs,
                                            LibrarySession session,
                                            boolean obfuscate)
                                     throws IfsException

Throws:

IfsException

getMeaningfulString

protected String getMeaningfulString(LibraryObject obj,
                                     boolean obfuscate)
                              throws IfsException

Gets a meaningful string for a LibraryObject.

Throws:

IfsException

(Published)

getMeaningfulString

protected String getMeaningfulString(LibraryObject[] objs,
                                     boolean obfuscate)
                              throws IfsException

Gets a meaningful string for a LibraryObject[].

Throws:

IfsException

(Published)

getMeaningfulString

protected String getMeaningfulString(Date[] objs,
                                     boolean obfuscate)

Gets a meaningful string for a Date[].

(Published)

getMeaningfulString

protected String getMeaningfulString(String[] objs)

Gets a meaningful string for a String[].

(Published)

getMeaningfulString

protected String getMeaningfulString(int[] objs)

Gets a meaningful string for a int[].

(Published)

getMeaningfulString

protected String getMeaningfulString(double[] objs)

Gets a meaningful string for a double[].

(Published)

getMeaningfulString

protected String getMeaningfulString(long[] objs)

Gets a meaningful string for a long[].

(Published)

getMeaningfulString

protected String getMeaningfulString(boolean[] objs)

Gets a meaningful string for a boolean[].

(Published)

getMeaningfulString

protected String getMeaningfulString(Map map)
                              throws IfsException

Throws:

IfsException

getMeaningfulString

protected String getMeaningfulString(AttributeValue attr,
                                     LibrarySession session,
                                     boolean obfuscate)
                              throws IfsException

Gets a meaningful string based on the type of AttributeValue.

Throws:

IfsException

(Published)

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)