public abstract class

AbstractParseMetricTask

extends AbstractAppTask
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.app.tasks.AbstractAppTask
       ↳ com.microstrategy.web.app.tasks.AbstractParseMetricTask
Known Direct Subclasses

Class Overview

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.

Summary

Constants
String BLK_DATA_TYPE
String BLK_FOLDER
String BLK_METRIC
String BLK_METRIC_PROPERTIES
String BLK_METRIC_SUBTOTAL
String BLK_METRIC_SUBTOTALS
String BLK_TOKEN
String BLK_TOKEN_STREAM
String BLK_WEBOBJECTINFO
String BLK_WEBOBJECT_PROPERTY
String BLP_DATA_TYPE_PRECISION
String BLP_DATA_TYPE_SCALE
String BLP_DATA_TYPE_TYPE
String BLP_FOLDER_ITEMS
String BLP_METRIC_DATA_TYPE
String BLP_METRIC_FOMRAT
String BLP_METRIC_GRID_FORMAT
String BLP_METRIC_HEADER_FORMAT
String BLP_METRIC_PROPERTIES
String BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE
String BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE_STYLE
String BLP_METRIC_PROPERTIES_ALL_CHILDREN_JOIN
String BLP_METRIC_PROPERTIES_CAN_BE_SMART
String BLP_METRIC_PROPERTIES_FROM_BASE_FLAG
String BLP_METRIC_PROPERTIES_METRIC_TYPE
String BLP_METRIC_PROPERTIES_SMART_TOTAL
String BLP_METRIC_SUBTOTALS
String BLP_METRIC_SUBTOTALS_AGGREGATION
String BLP_METRIC_SUBTOTALS_AVAILABLE
String BLP_METRIC_SUBTOTALS_TOTAL
String BLP_METRIC_SUBTOTAL_DEFINITION_METRIC
String BLP_METRIC_TOKEN_STREAM
String BLP_TOKEN_EXTRA_VALUE
String BLP_TOKEN_EXTRA_VALUE_TYPE
String BLP_TOKEN_LEVEL
String BLP_TOKEN_OBJECT
String BLP_TOKEN_SECTION_TYPE
String BLP_TOKEN_STATE
String BLP_TOKEN_STREAM_ITEMS
String BLP_TOKEN_STREAM_METRIC_EDIT_TYPE
String BLP_TOKEN_STREAM_REJECT_ERROR_CODE
String BLP_TOKEN_STREAM_REJECT_ERROR_DESCRIPTION
String BLP_TOKEN_STREAM_SEARCH_RESULTS_FOLDER
String BLP_TOKEN_TYPE
String BLP_TOKEN_VALUE
String BLP_WEBOBJECTINFO_DESC
String BLP_WEBOBJECTINFO_DSSID
String BLP_WEBOBJECTINFO_NAME
String BLP_WEBOBJECTINFO_PROPERTY_SETS
String BLP_WEBOBJECTINFO_SUBTYPE
String BLP_WEBOBJECTINFO_TYPE
String BLP_WEBOBJECT_PROPERTY_DATATYPE
String BLP_WEBOBJECT_PROPERTY_DEFAULT_VALUE
String BLP_WEBOBJECT_PROPERTY_ID
String BLP_WEBOBJECT_PROPERTY_NAME
String BLP_WEBOBJECT_PROPERTY_USE_DEFAULT
String BLP_WEBOBJECT_PROPERTY_VALUE
String PARAM_DESC_IS_NEW
String PARAM_DESC_LOCAL_SYMBOL_FOLDER_XML
String PARAM_DESC_METRIC_ID
String PARAM_DESC_OUTPUT_FLAGS
String PARAM_DESC_TOKEN_STREAM_XML
String PARAM_NAME_IS_NEW
String PARAM_NAME_LOCAL_SYMBOL_FOLDER_XML
String PARAM_NAME_METRIC_ID
String PARAM_NAME_OUTPUT_FLAGS
String PARAM_NAME_TOKEN_STREAM_XML
[Expand]
Inherited Constants
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected TaskParameterMetadata isNewParam
protected TaskParameterMetadata localSymbolFolderXMLParam
protected TaskParameterMetadata metricIdParam
protected TaskParameterMetadata metricXMLParam
protected TaskParameterMetadata outputFlagsParam
protected TaskParameterMetadata tokenStreamXMLParam
[Expand]
Inherited Fields
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
AbstractParseMetricTask(String desc)
Public Methods
static Block buildSingleFormat(WebFormat format)
Protected Methods
void addIsNewParam(boolean required, boolean defValue)
Add a is new parameter to the task definition.
void addLocalSymbolFolderXMLParam(boolean required, String defValue)
Add a local symbol folder XML parameter to the task definition.
void addMetricIdParam(boolean required, String defValue)
Add a metric ID parameter to the task definition.
void addMetricXMLParam(boolean required, String defValue)
void addTokenStreamXMLParam(boolean required, String defValue)
Add a token stream XML parameter to the task definition.
Block createMetricBlock(WebParsedMetric parsedMetric, int outputFlags)
void setBasicProperties(Block objInfoBlock, String did, int type, int subType)
void setBasicProperties(Block objInfoBlock, WebObjectInfo woi)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.tasks.AbstractAppTask
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Constants

protected static final String BLK_DATA_TYPE

Constant Value: "DataType"

protected static final String BLK_FOLDER

Constant Value: "Folder"

protected static final String BLK_METRIC

Constant Value: "Metric"

protected static final String BLK_METRIC_PROPERTIES

Constant Value: "MetricProperties"

protected static final String BLK_METRIC_SUBTOTAL

Constant Value: "MetricSubtotal"

protected static final String BLK_METRIC_SUBTOTALS

Constant Value: "MetricSubtotals"

protected static final String BLK_TOKEN

Constant Value: "Token"

protected static final String BLK_TOKEN_STREAM

Constant Value: "TokenStream"

protected static final String BLK_WEBOBJECTINFO

Constant Value: "WebObjectInfo"

protected static final String BLK_WEBOBJECT_PROPERTY

Constant Value: "WebObjectProperty"

protected static final String BLP_DATA_TYPE_PRECISION

Constant Value: "prec"

protected static final String BLP_DATA_TYPE_SCALE

Constant Value: "scl"

protected static final String BLP_DATA_TYPE_TYPE

Constant Value: "ddt"

protected static final String BLP_FOLDER_ITEMS

Constant Value: "items"

protected static final String BLP_METRIC_DATA_TYPE

Constant Value: "datp"

protected static final String BLP_METRIC_FOMRAT

Constant Value: "fmt"

protected static final String BLP_METRIC_GRID_FORMAT

Constant Value: "grid_format"

protected static final String BLP_METRIC_HEADER_FORMAT

Constant Value: "header_format"

protected static final String BLP_METRIC_PROPERTIES

Constant Value: "mps"

protected static final String BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE

Constant Value: "afb"

protected static final String BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE_STYLE

Constant Value: "sfb"

protected static final String BLP_METRIC_PROPERTIES_ALL_CHILDREN_JOIN

Constant Value: "acj"

protected static final String BLP_METRIC_PROPERTIES_CAN_BE_SMART

Constant Value: "cbs"

protected static final String BLP_METRIC_PROPERTIES_FROM_BASE_FLAG

Constant Value: "fbf"

protected static final String BLP_METRIC_PROPERTIES_METRIC_TYPE

Constant Value: "mt"

protected static final String BLP_METRIC_PROPERTIES_SMART_TOTAL

Constant Value: "stl"

protected static final String BLP_METRIC_SUBTOTALS

Constant Value: "sbs"

protected static final String BLP_METRIC_SUBTOTALS_AGGREGATION

Constant Value: "agg"

protected static final String BLP_METRIC_SUBTOTALS_AVAILABLE

Constant Value: "avs"

protected static final String BLP_METRIC_SUBTOTALS_TOTAL

Constant Value: "tot"

protected static final String BLP_METRIC_SUBTOTAL_DEFINITION_METRIC

Constant Value: "dm"

protected static final String BLP_METRIC_TOKEN_STREAM

Constant Value: "tks"

protected static final String BLP_TOKEN_EXTRA_VALUE

Constant Value: "exv"

protected static final String BLP_TOKEN_EXTRA_VALUE_TYPE

Constant Value: "extp"

protected static final String BLP_TOKEN_LEVEL

Constant Value: "lv"

protected static final String BLP_TOKEN_OBJECT

Constant Value: "oi"

protected static final String BLP_TOKEN_SECTION_TYPE

Constant Value: "sctt"

protected static final String BLP_TOKEN_STATE

Constant Value: "sta"

protected static final String BLP_TOKEN_STREAM_ITEMS

Constant Value: "items"

protected static final String BLP_TOKEN_STREAM_METRIC_EDIT_TYPE

Constant Value: "met"

protected static final String BLP_TOKEN_STREAM_REJECT_ERROR_CODE

Constant Value: "rjec"

protected static final String BLP_TOKEN_STREAM_REJECT_ERROR_DESCRIPTION

Constant Value: "rjed"

protected static final String BLP_TOKEN_STREAM_SEARCH_RESULTS_FOLDER

Constant Value: "srfd"

protected static final String BLP_TOKEN_TYPE

Constant Value: "tp"

protected static final String BLP_TOKEN_VALUE

Constant Value: "v"

protected static final String BLP_WEBOBJECTINFO_DESC

Constant Value: "desc"

protected static final String BLP_WEBOBJECTINFO_DSSID

Constant Value: "did"

protected static final String BLP_WEBOBJECTINFO_NAME

Constant Value: "n"

protected static final String BLP_WEBOBJECTINFO_PROPERTY_SETS

Constant Value: "prss"

protected static final String BLP_WEBOBJECTINFO_SUBTYPE

Constant Value: "st"

protected static final String BLP_WEBOBJECTINFO_TYPE

Constant Value: "t"

protected static final String BLP_WEBOBJECT_PROPERTY_DATATYPE

Constant Value: "dt"

protected static final String BLP_WEBOBJECT_PROPERTY_DEFAULT_VALUE

Constant Value: "pdv"

protected static final String BLP_WEBOBJECT_PROPERTY_ID

Constant Value: "pri"

protected static final String BLP_WEBOBJECT_PROPERTY_NAME

Constant Value: "n"

protected static final String BLP_WEBOBJECT_PROPERTY_USE_DEFAULT

Constant Value: "pru"

protected static final String BLP_WEBOBJECT_PROPERTY_VALUE

Constant Value: "v"

protected static final String PARAM_DESC_IS_NEW

Constant Value: "This parameter specifies whether this metric is a new one."

protected static final String PARAM_DESC_LOCAL_SYMBOL_FOLDER_XML

Constant Value: "This parameter specifies the local symbol folder XML for resolving naming ambiguity."

protected static final String PARAM_DESC_METRIC_ID

Constant Value: "This parameter specifies DSS ID of the metric."

protected static final String PARAM_DESC_OUTPUT_FLAGS

Constant Value: "This parameter specifies the output flags for which part of the metric should be retrieved from the metadata."

protected static final String PARAM_DESC_TOKEN_STREAM_XML

Constant Value: "This parameter specifies the token stream XML of the metric."

protected static final String PARAM_NAME_IS_NEW

Constant Value: "isNew"

protected static final String PARAM_NAME_LOCAL_SYMBOL_FOLDER_XML

Constant Value: "localSymbolFolderXML"

protected static final String PARAM_NAME_METRIC_ID

Constant Value: "metricId"

protected static final String PARAM_NAME_OUTPUT_FLAGS

Constant Value: "outputFlags"

protected static final String PARAM_NAME_TOKEN_STREAM_XML

Constant Value: "tokenStreamXML"

Fields

protected TaskParameterMetadata isNewParam

protected TaskParameterMetadata localSymbolFolderXMLParam

protected TaskParameterMetadata metricIdParam

protected TaskParameterMetadata metricXMLParam

protected TaskParameterMetadata outputFlagsParam

protected TaskParameterMetadata tokenStreamXMLParam

Public Constructors

public AbstractParseMetricTask (String desc)

Public Methods

public static Block buildSingleFormat (WebFormat format)

Protected Methods

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.

protected void addLocalSymbolFolderXMLParam (boolean required, 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.

protected void addMetricIdParam (boolean required, 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.

protected void addMetricXMLParam (boolean required, String defValue)

protected void addTokenStreamXMLParam (boolean required, 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.

protected Block createMetricBlock (WebParsedMetric parsedMetric, int outputFlags)

Throws
TaskException

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

protected void setBasicProperties (Block objInfoBlock, WebObjectInfo woi)