*** This class is subject to change ***

com.sas.dataexplorer.commands
Class AppliedFiltersCommand

java.lang.Object
  |
  +--com.sas.entities.BaseEntity
        |
        +--com.sas.commands.BaseCommand
              |
              +--com.sas.dataexplorer.commands.AppliedFiltersCommand

All Implemented Interfaces:

BaseEntityInterface, BaseEntityValueInterface, Command, CommandStatusInterface, CommandSupportedInterface, ContentsChangedInterface, DynamicAttributeCommandInterface, EntityKeyInterface, PublicClonable, SimpleCommand, StringDataInterface

public class AppliedFiltersCommand

extends BaseCommand

implements ContentsChangedInterface, CommandSupportedInterface, CommandStatusInterface

The AppliedFiltersCommand determines whether or not the AppliedFilters component is displayed in the content area of the VisualDataExplorer. This class implements the basic functionality for the applied filters command.

Field Summary

static String	RB_KEY
protected HttpServletResponse	response The HttpServletResponse object used to export the data

Fields inherited from interface com.sas.actionprovider.CommandStatusInterface

DISABLED, ENABLED, IS_CURRENT_STATE_DISABLED, MODEL_MEMBER_DISABLED, MODEL_STATE_DISABLED, MODEL_TYPE_DISABLED

Fields inherited from interface com.sas.commands.DynamicAttributeCommandInterface

COMMAND_NAME_PREFIX

Constructor Summary

AppliedFiltersCommand()
Default constructor

AppliedFiltersCommand(String name)
Constructor that accepts a command name

AppliedFiltersCommand(String name, String actionClass)
Constructor that accepts a command name and an action class type

Method Summary

void	execute(Object o) This method implements the execute method on the CommandInterface, which is not implemented by the abstract BaseCommand class
int	getCommandStatus(ActionSupportFilter filter) Returns an int value indicating whether the command is enabled for the given area as specified by the current area information encapsulate in the ActionSupportFilter.
HashMap	getEventInfo() Gets the event info for this command.
Object	getEventSource() Gets the event source for this command.
Object	getVisualDataExplorer() Returns the visual data explorer viewer.
boolean	isContentsChanged() Tells whether the contents of this command have changed.
boolean	isSupported(ActionSupportFilter actionFilter) Returns a boolean indicating whether the command is supported for the area specified on the ActionSupportFilter argument.
void	setEventSource(Object eventSource) Sets the event source for this command.
void	setVisualDataExplorer(Object visualDataExplorer) Sets the visual data explorer viewer.

Methods inherited from class com.sas.commands.BaseCommand

getLocale, getName, getNextCommandName, getText, isExecutable, isUndoable, setLocale, setName, setText, undo

Methods inherited from class com.sas.entities.BaseEntity

clone, containsAttributeNamed, equals, equals, getAttribute, getAttribute, getAttributeCount, getAttributes, getEntityKey, getPropertyDescriptors, getStringAttribute, listAttributeNames, removeAllAttributes, removeAttribute, reset, sameEntity, setAttribute, setAttributes, setEntityKey, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sas.entities.BaseEntityValueInterface

getAttribute, setAttribute

Methods inherited from interface com.sas.util.Command

clone

Field Detail

RB_KEY

public static final String RB_KEY

response

protected HttpServletResponse response

The HttpServletResponse object used to export the data

Constructor Detail

AppliedFiltersCommand

public AppliedFiltersCommand()

Default constructor

AppliedFiltersCommand

public AppliedFiltersCommand(String name)

Constructor that accepts a command name

AppliedFiltersCommand

public AppliedFiltersCommand(String name,
                             String actionClass)

Constructor that accepts a command name and an action class type

Method Detail

execute

public void execute(Object o)

This method implements the execute method on the CommandInterface, which is not implemented by the abstract BaseCommand class

Overrides:

execute in class BaseCommand

Following copied from class: com.sas.commands.BaseCommand

Parameters:

o - The output stream to which the results of this command should be written.

isContentsChanged

public boolean isContentsChanged()

Tells whether the contents of this command have changed.

Specified by:

isContentsChanged in interface ContentsChangedInterface

Returns:

a boolean indicating whether the contents of this command have changed

getEventInfo

public HashMap getEventInfo()

Gets the event info for this command. No information is available for this command.

Specified by:

getEventInfo in interface ContentsChangedInterface

Returns:

a HashMap containing the info for the event

getEventSource

public Object getEventSource()

Gets the event source for this command.

Specified by:

getEventSource in interface ContentsChangedInterface

Returns:

the source of the event

setEventSource

public void setEventSource(Object eventSource)

Sets the event source for this command.

Parameters:

eventSource - the source of the event

isSupported

public boolean isSupported(ActionSupportFilter actionFilter)

Returns a boolean indicating whether the command is supported for the area specified on the ActionSupportFilter argument.

Specified by:

isSupported in interface CommandSupportedInterface

Parameters:

actionFilter - The object that describes the current area.

Returns:

a boolean indicating whether the command is supported.

getCommandStatus

public int getCommandStatus(ActionSupportFilter filter)

Returns an int value indicating whether the command is enabled for the given area as specified by the current area information encapsulate in the ActionSupportFilter.

Specified by:

getCommandStatus in interface CommandStatusInterface

Parameters:

filter - The ActionSupportFilter that encapsulates all the necessary information to describe the current area.

Returns:

an int value indicating whether the command is enabled and, if not, why. This command is always enabled.

getVisualDataExplorer

public Object getVisualDataExplorer()

Returns the visual data explorer viewer.

Returns:

Returns the viewer.

setVisualDataExplorer

public void setVisualDataExplorer(Object visualDataExplorer)

Sets the visual data explorer viewer.

Parameters:

visualDataExplorer - The viewer to set.

*** This class is subject to change ***