Package com.microstrategy.web.app.tasks

Class AbstractParseMetricTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.AbstractParseMetricTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

GetMetricDefinitionTask, SaveMetricDefinitionTask, ValidateMetricTask

public abstract class AbstractParseMetricTask
extends AbstractAppTask

This is the parent class for tasks that generate a token stream for a metric. It provides some methods for generating the metric and token stream blocks.

Since:

MicroStrategy Web 9.2.2

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	BLK_DATA_TYPE
protected static java.lang.String	BLK_FOLDER
protected static java.lang.String	BLK_METRIC
protected static java.lang.String	BLK_METRIC_PROPERTIES
protected static java.lang.String	BLK_METRIC_SUBTOTAL
protected static java.lang.String	BLK_METRIC_SUBTOTALS
protected static java.lang.String	BLK_TOKEN
protected static java.lang.String	BLK_TOKEN_STREAM
protected static java.lang.String	BLK_WEBOBJECT_PROPERTY
protected static java.lang.String	BLK_WEBOBJECTINFO
protected static java.lang.String	BLP_DATA_TYPE_PRECISION
protected static java.lang.String	BLP_DATA_TYPE_SCALE
protected static java.lang.String	BLP_DATA_TYPE_TYPE
protected static java.lang.String	BLP_FOLDER_ITEMS
protected static java.lang.String	BLP_METRIC_DATA_TYPE
protected static java.lang.String	BLP_METRIC_FOMRAT
protected static java.lang.String	BLP_METRIC_GRID_FORMAT
protected static java.lang.String	BLP_METRIC_HEADER_FORMAT
protected static java.lang.String	BLP_METRIC_PROPERTIES
protected static java.lang.String	BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE
protected static java.lang.String	BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE_STYLE
protected static java.lang.String	BLP_METRIC_PROPERTIES_ALL_CHILDREN_JOIN
protected static java.lang.String	BLP_METRIC_PROPERTIES_CAN_BE_SMART
protected static java.lang.String	BLP_METRIC_PROPERTIES_FROM_BASE_FLAG
protected static java.lang.String	BLP_METRIC_PROPERTIES_METRIC_FORMAT_TYPE
protected static java.lang.String	BLP_METRIC_PROPERTIES_METRIC_TYPE
protected static java.lang.String	BLP_METRIC_PROPERTIES_SMART_TOTAL
protected static java.lang.String	BLP_METRIC_SUBTOTAL_DEFINITION_METRIC
protected static java.lang.String	BLP_METRIC_SUBTOTALS
protected static java.lang.String	BLP_METRIC_SUBTOTALS_AGGREGATION
protected static java.lang.String	BLP_METRIC_SUBTOTALS_AVAILABLE
protected static java.lang.String	BLP_METRIC_SUBTOTALS_TOTAL
protected static java.lang.String	BLP_METRIC_TOKEN_STREAM
protected static java.lang.String	BLP_TOKEN_EXTRA_VALUE
protected static java.lang.String	BLP_TOKEN_EXTRA_VALUE_TYPE
protected static java.lang.String	BLP_TOKEN_LEVEL
protected static java.lang.String	BLP_TOKEN_OBJECT
protected static java.lang.String	BLP_TOKEN_SECTION_TYPE
protected static java.lang.String	BLP_TOKEN_STATE
protected static java.lang.String	BLP_TOKEN_STREAM_ITEMS
protected static java.lang.String	BLP_TOKEN_STREAM_METRIC_EDIT_TYPE
protected static java.lang.String	BLP_TOKEN_STREAM_REJECT_ERROR_CODE
protected static java.lang.String	BLP_TOKEN_STREAM_REJECT_ERROR_DESCRIPTION
protected static java.lang.String	BLP_TOKEN_STREAM_SEARCH_RESULTS_FOLDER
protected static java.lang.String	BLP_TOKEN_TYPE
protected static java.lang.String	BLP_TOKEN_VALUE
protected static java.lang.String	BLP_WEBOBJECT_PROPERTY_DATATYPE
protected static java.lang.String	BLP_WEBOBJECT_PROPERTY_DEFAULT_VALUE
protected static java.lang.String	BLP_WEBOBJECT_PROPERTY_ID
protected static java.lang.String	BLP_WEBOBJECT_PROPERTY_NAME
protected static java.lang.String	BLP_WEBOBJECT_PROPERTY_USE_DEFAULT
protected static java.lang.String	BLP_WEBOBJECT_PROPERTY_VALUE
protected static java.lang.String	BLP_WEBOBJECTINFO_DESC
protected static java.lang.String	BLP_WEBOBJECTINFO_DSSID
protected static java.lang.String	BLP_WEBOBJECTINFO_NAME
protected static java.lang.String	BLP_WEBOBJECTINFO_PROPERTY_SETS
protected static java.lang.String	BLP_WEBOBJECTINFO_SUBTYPE
protected static java.lang.String	BLP_WEBOBJECTINFO_TYPE
protected TaskParameterMetadata	isNewParam
protected TaskParameterMetadata	localSymbolFolderXMLParam
protected TaskParameterMetadata	metricIdParam
protected TaskParameterMetadata	metricXMLParam
protected TaskParameterMetadata	outputFlagsParam
protected static java.lang.String	PARAM_DESC_IS_NEW
protected static java.lang.String	PARAM_DESC_LOCAL_SYMBOL_FOLDER_XML
protected static java.lang.String	PARAM_DESC_METRIC_ID
protected static java.lang.String	PARAM_DESC_OUTPUT_FLAGS
protected static java.lang.String	PARAM_DESC_TOKEN_STREAM_XML
protected static java.lang.String	PARAM_NAME_IS_NEW
protected static java.lang.String	PARAM_NAME_LOCAL_SYMBOL_FOLDER_XML
protected static java.lang.String	PARAM_NAME_METRIC_ID
protected static java.lang.String	PARAM_NAME_OUTPUT_FLAGS
protected static java.lang.String	PARAM_NAME_TOKEN_STREAM_XML
protected TaskParameterMetadata	tokenStreamXMLParam

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

Constructor	Description
AbstractParseMetricTask(java.lang.String desc)

Method Summary

Modifier and Type	Method	Description
protected void	addIsNewParam(boolean required, boolean defValue)	Add a is new parameter to the task definition.
protected void	addLocalSymbolFolderXMLParam(boolean required, java.lang.String defValue)	Add a local symbol folder XML parameter to the task definition.
protected void	addMetricIdParam(boolean required, java.lang.String defValue)	Add a metric ID parameter to the task definition.
protected void	addMetricXMLParam(boolean required, java.lang.String defValue)
protected void	addTokenStreamXMLParam(boolean required, java.lang.String defValue)	Add a token stream XML parameter to the task definition.
static Block	buildSingleFormat(WebFormat format)
protected Block	createMetricBlock(WebParsedMetric parsedMetric, int outputFlags)
protected void	setBasicProperties(Block objInfoBlock, WebObjectInfo woi)
protected void	setBasicProperties(Block objInfoBlock, java.lang.String did, int type, int subType)

Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask

getDescriptor, newRequestContext

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, processRequest, 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

PARAM_NAME_OUTPUT_FLAGS

protected static final java.lang.String PARAM_NAME_OUTPUT_FLAGS

See Also:

Constant Field Values

PARAM_DESC_OUTPUT_FLAGS

protected static final java.lang.String PARAM_DESC_OUTPUT_FLAGS

See Also:

Constant Field Values

PARAM_NAME_METRIC_ID

protected static final java.lang.String PARAM_NAME_METRIC_ID

See Also:

Constant Field Values

PARAM_DESC_METRIC_ID

protected static final java.lang.String PARAM_DESC_METRIC_ID

See Also:

Constant Field Values

PARAM_NAME_IS_NEW

protected static final java.lang.String PARAM_NAME_IS_NEW

See Also:

Constant Field Values

PARAM_DESC_IS_NEW

protected static final java.lang.String PARAM_DESC_IS_NEW

See Also:

Constant Field Values

PARAM_NAME_TOKEN_STREAM_XML

protected static final java.lang.String PARAM_NAME_TOKEN_STREAM_XML

See Also:

Constant Field Values

PARAM_DESC_TOKEN_STREAM_XML

protected static final java.lang.String PARAM_DESC_TOKEN_STREAM_XML

See Also:

Constant Field Values

PARAM_NAME_LOCAL_SYMBOL_FOLDER_XML

protected static final java.lang.String PARAM_NAME_LOCAL_SYMBOL_FOLDER_XML

See Also:

Constant Field Values

PARAM_DESC_LOCAL_SYMBOL_FOLDER_XML

protected static final java.lang.String PARAM_DESC_LOCAL_SYMBOL_FOLDER_XML

See Also:

Constant Field Values

outputFlagsParam

protected TaskParameterMetadata outputFlagsParam

metricIdParam

protected TaskParameterMetadata metricIdParam

isNewParam

protected TaskParameterMetadata isNewParam

metricXMLParam

protected TaskParameterMetadata metricXMLParam

tokenStreamXMLParam

protected TaskParameterMetadata tokenStreamXMLParam

localSymbolFolderXMLParam

protected TaskParameterMetadata localSymbolFolderXMLParam

BLK_METRIC

protected static final java.lang.String BLK_METRIC

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES

protected static final java.lang.String BLP_METRIC_PROPERTIES

See Also:

Constant Field Values

BLP_METRIC_DATA_TYPE

protected static final java.lang.String BLP_METRIC_DATA_TYPE

See Also:

Constant Field Values

BLP_METRIC_FOMRAT

protected static final java.lang.String BLP_METRIC_FOMRAT

See Also:

Constant Field Values

BLP_METRIC_HEADER_FORMAT

protected static final java.lang.String BLP_METRIC_HEADER_FORMAT

See Also:

Constant Field Values

BLP_METRIC_GRID_FORMAT

protected static final java.lang.String BLP_METRIC_GRID_FORMAT

See Also:

Constant Field Values

BLP_METRIC_TOKEN_STREAM

protected static final java.lang.String BLP_METRIC_TOKEN_STREAM

See Also:

Constant Field Values

BLP_METRIC_SUBTOTALS

protected static final java.lang.String BLP_METRIC_SUBTOTALS

See Also:

Constant Field Values

BLK_METRIC_PROPERTIES

protected static final java.lang.String BLK_METRIC_PROPERTIES

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_ALL_CHILDREN_JOIN

protected static final java.lang.String BLP_METRIC_PROPERTIES_ALL_CHILDREN_JOIN

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_METRIC_TYPE

protected static final java.lang.String BLP_METRIC_PROPERTIES_METRIC_TYPE

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_SMART_TOTAL

protected static final java.lang.String BLP_METRIC_PROPERTIES_SMART_TOTAL

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE

protected static final java.lang.String BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE_STYLE

protected static final java.lang.String BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE_STYLE

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_FROM_BASE_FLAG

protected static final java.lang.String BLP_METRIC_PROPERTIES_FROM_BASE_FLAG

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_CAN_BE_SMART

protected static final java.lang.String BLP_METRIC_PROPERTIES_CAN_BE_SMART

See Also:

Constant Field Values

BLP_METRIC_PROPERTIES_METRIC_FORMAT_TYPE

protected static final java.lang.String BLP_METRIC_PROPERTIES_METRIC_FORMAT_TYPE

See Also:

Constant Field Values

BLK_DATA_TYPE

protected static final java.lang.String BLK_DATA_TYPE

See Also:

Constant Field Values

BLP_DATA_TYPE_TYPE

protected static final java.lang.String BLP_DATA_TYPE_TYPE

See Also:

Constant Field Values

BLP_DATA_TYPE_PRECISION

protected static final java.lang.String BLP_DATA_TYPE_PRECISION

See Also:

Constant Field Values

BLP_DATA_TYPE_SCALE

protected static final java.lang.String BLP_DATA_TYPE_SCALE

See Also:

Constant Field Values

BLK_TOKEN_STREAM

protected static final java.lang.String BLK_TOKEN_STREAM

See Also:

Constant Field Values

BLP_TOKEN_STREAM_SEARCH_RESULTS_FOLDER

protected static final java.lang.String BLP_TOKEN_STREAM_SEARCH_RESULTS_FOLDER

See Also:

Constant Field Values

BLP_TOKEN_STREAM_ITEMS

protected static final java.lang.String BLP_TOKEN_STREAM_ITEMS

See Also:

Constant Field Values

BLP_TOKEN_STREAM_REJECT_ERROR_CODE

protected static final java.lang.String BLP_TOKEN_STREAM_REJECT_ERROR_CODE

See Also:

Constant Field Values

BLP_TOKEN_STREAM_REJECT_ERROR_DESCRIPTION

protected static final java.lang.String BLP_TOKEN_STREAM_REJECT_ERROR_DESCRIPTION

See Also:

Constant Field Values

BLP_TOKEN_STREAM_METRIC_EDIT_TYPE

protected static final java.lang.String BLP_TOKEN_STREAM_METRIC_EDIT_TYPE

See Also:

Constant Field Values

BLK_TOKEN

protected static final java.lang.String BLK_TOKEN

See Also:

Constant Field Values

BLP_TOKEN_VALUE

protected static final java.lang.String BLP_TOKEN_VALUE

See Also:

Constant Field Values

BLP_TOKEN_TYPE

protected static final java.lang.String BLP_TOKEN_TYPE

See Also:

Constant Field Values

BLP_TOKEN_OBJECT

protected static final java.lang.String BLP_TOKEN_OBJECT

See Also:

Constant Field Values

BLP_TOKEN_LEVEL

protected static final java.lang.String BLP_TOKEN_LEVEL

See Also:

Constant Field Values

BLP_TOKEN_STATE

protected static final java.lang.String BLP_TOKEN_STATE

See Also:

Constant Field Values

BLP_TOKEN_SECTION_TYPE

protected static final java.lang.String BLP_TOKEN_SECTION_TYPE

See Also:

Constant Field Values

BLP_TOKEN_EXTRA_VALUE_TYPE

protected static final java.lang.String BLP_TOKEN_EXTRA_VALUE_TYPE

See Also:

Constant Field Values

BLP_TOKEN_EXTRA_VALUE

protected static final java.lang.String BLP_TOKEN_EXTRA_VALUE

See Also:

Constant Field Values

BLK_METRIC_SUBTOTALS

protected static final java.lang.String BLK_METRIC_SUBTOTALS

See Also:

Constant Field Values

BLP_METRIC_SUBTOTALS_TOTAL

protected static final java.lang.String BLP_METRIC_SUBTOTALS_TOTAL

See Also:

Constant Field Values

BLP_METRIC_SUBTOTALS_AGGREGATION

protected static final java.lang.String BLP_METRIC_SUBTOTALS_AGGREGATION

See Also:

Constant Field Values

BLP_METRIC_SUBTOTALS_AVAILABLE

protected static final java.lang.String BLP_METRIC_SUBTOTALS_AVAILABLE

See Also:

Constant Field Values

BLK_METRIC_SUBTOTAL

protected static final java.lang.String BLK_METRIC_SUBTOTAL

See Also:

Constant Field Values

BLP_METRIC_SUBTOTAL_DEFINITION_METRIC

protected static final java.lang.String BLP_METRIC_SUBTOTAL_DEFINITION_METRIC

See Also:

Constant Field Values

BLK_WEBOBJECTINFO

protected static final java.lang.String BLK_WEBOBJECTINFO

See Also:

Constant Field Values

BLP_WEBOBJECTINFO_DESC

protected static final java.lang.String BLP_WEBOBJECTINFO_DESC

See Also:

Constant Field Values

BLP_WEBOBJECTINFO_DSSID

protected static final java.lang.String BLP_WEBOBJECTINFO_DSSID

See Also:

Constant Field Values

BLP_WEBOBJECTINFO_NAME

protected static final java.lang.String BLP_WEBOBJECTINFO_NAME

See Also:

Constant Field Values

BLP_WEBOBJECTINFO_TYPE

protected static final java.lang.String BLP_WEBOBJECTINFO_TYPE

See Also:

Constant Field Values

BLP_WEBOBJECTINFO_SUBTYPE

protected static final java.lang.String BLP_WEBOBJECTINFO_SUBTYPE

See Also:

Constant Field Values

BLP_WEBOBJECTINFO_PROPERTY_SETS

protected static final java.lang.String BLP_WEBOBJECTINFO_PROPERTY_SETS

See Also:

Constant Field Values

BLK_WEBOBJECT_PROPERTY

protected static final java.lang.String BLK_WEBOBJECT_PROPERTY

See Also:

Constant Field Values

BLP_WEBOBJECT_PROPERTY_NAME

protected static final java.lang.String BLP_WEBOBJECT_PROPERTY_NAME

See Also:

Constant Field Values

BLP_WEBOBJECT_PROPERTY_ID

protected static final java.lang.String BLP_WEBOBJECT_PROPERTY_ID

See Also:

Constant Field Values

BLP_WEBOBJECT_PROPERTY_DATATYPE

protected static final java.lang.String BLP_WEBOBJECT_PROPERTY_DATATYPE

See Also:

Constant Field Values

BLP_WEBOBJECT_PROPERTY_DEFAULT_VALUE

protected static final java.lang.String BLP_WEBOBJECT_PROPERTY_DEFAULT_VALUE

See Also:

Constant Field Values

BLP_WEBOBJECT_PROPERTY_USE_DEFAULT

protected static final java.lang.String BLP_WEBOBJECT_PROPERTY_USE_DEFAULT

See Also:

Constant Field Values

BLP_WEBOBJECT_PROPERTY_VALUE

protected static final java.lang.String BLP_WEBOBJECT_PROPERTY_VALUE

See Also:

Constant Field Values

BLK_FOLDER

protected static final java.lang.String BLK_FOLDER

See Also:

Constant Field Values

BLP_FOLDER_ITEMS

protected static final java.lang.String BLP_FOLDER_ITEMS

See Also:

Constant Field Values

Constructor Detail

AbstractParseMetricTask

public AbstractParseMetricTask(java.lang.String desc)

Method Detail

addMetricIdParam

protected void addMetricIdParam(boolean required,
                                java.lang.String defValue)

Add a metric ID parameter to the task definition.

Parameters:

required - Indicates whether this parameter is required or not.

defValue - Identifies the default value to use.

addIsNewParam

protected void addIsNewParam(boolean required,
                             boolean defValue)

Add a is new parameter to the task definition.

Parameters:

required - Indicates whether this parameter is required or not.

defValue - Identifies the default value to use.

addMetricXMLParam

protected void addMetricXMLParam(boolean required,
                                 java.lang.String defValue)

addTokenStreamXMLParam

protected void addTokenStreamXMLParam(boolean required,
                                      java.lang.String defValue)

Add a token stream XML parameter to the task definition.

Parameters:

required - Indicates whether this parameter is required or not.

defValue - Identifies the default value to use.

addLocalSymbolFolderXMLParam

protected void addLocalSymbolFolderXMLParam(boolean required,
                                            java.lang.String defValue)

Add a local symbol folder XML parameter to the task definition.

Parameters:

required - Indicates whether this parameter is required or not.

defValue - Identifies the default value to use.

createMetricBlock

protected Block createMetricBlock(WebParsedMetric parsedMetric,
                                  int outputFlags)
                           throws TaskException

Throws:

TaskException

setBasicProperties

protected void setBasicProperties(Block objInfoBlock,
                                  WebObjectInfo woi)

setBasicProperties

protected void setBasicProperties(Block objInfoBlock,
                                  java.lang.String did,
                                  int type,
                                  int subType)

buildSingleFormat

public static Block buildSingleFormat(WebFormat format)