Package com.microstrategy.web.tasks

Class AbstractDrillTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.AbstractDrillTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

AbstractGridDrillTask, ReportGraphDrillTask

public abstract class AbstractDrillTask
extends AbstractBaseTask

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	drillPathKey
protected TaskParameterMetadata	keepThresholds
protected static java.lang.String	PARAM_NAME_DRILL_PATH_KEY
protected static java.lang.String	PARAM_NAME_KEEP_THRESHOLDS
protected static java.lang.String	PARAM_NAME_RETAIN_PARENT
protected static java.lang.String	PARAM_NAME_SLICE_ID
protected TaskParameterMetadata	retainParent
protected TaskParameterMetadata	sliceID
protected static java.lang.String	UNIT_SEPARATOR

Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask

compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractDrillTask()
protected	AbstractDrillTask(java.lang.String description)

Method Summary

Modifier and Type	Method	Description
protected static void	addBooleanToDrillProperties(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String key, java.lang.String value)
protected java.lang.String	getDrillPathKey(RequestKeys rk)
protected java.util.Map<java.lang.String,java.lang.Object>	getDrillProperties(RequestKeys rk)
protected java.lang.String	getMessageID(RequestKeys rk)
void	processRequest(TaskRequestContext context, MarkupOutput markupOutput)	The default implementation of this version of processRequest is empty.

Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask

addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

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

Field Detail

UNIT_SEPARATOR

protected static final java.lang.String UNIT_SEPARATOR

See Also:

Constant Field Values

PARAM_NAME_DRILL_PATH_KEY

protected static final java.lang.String PARAM_NAME_DRILL_PATH_KEY

See Also:

Constant Field Values

PARAM_NAME_KEEP_THRESHOLDS

protected static final java.lang.String PARAM_NAME_KEEP_THRESHOLDS

See Also:

Constant Field Values

PARAM_NAME_RETAIN_PARENT

protected static final java.lang.String PARAM_NAME_RETAIN_PARENT

See Also:

Constant Field Values

PARAM_NAME_SLICE_ID

protected static final java.lang.String PARAM_NAME_SLICE_ID

See Also:

Constant Field Values

drillPathKey

protected TaskParameterMetadata drillPathKey

keepThresholds

protected TaskParameterMetadata keepThresholds

retainParent

protected TaskParameterMetadata retainParent

sliceID

protected TaskParameterMetadata sliceID

Constructor Detail

AbstractDrillTask

public AbstractDrillTask()

AbstractDrillTask

protected AbstractDrillTask(java.lang.String description)

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           MarkupOutput markupOutput)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this version of processRequest is empty. Task implementators may override either version of processRequest.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

markupOutput - The MarkupOutput that records the contents of the Task response.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, MarkupOutput)

getDrillPathKey

protected java.lang.String getDrillPathKey(RequestKeys rk)

getDrillProperties

protected java.util.Map<java.lang.String,java.lang.Object> getDrillProperties(RequestKeys rk)

getMessageID

protected java.lang.String getMessageID(RequestKeys rk)

addBooleanToDrillProperties

protected static void addBooleanToDrillProperties(java.util.Map<java.lang.String,java.lang.Object> map,
                                                  java.lang.String key,
                                                  java.lang.String value)