public interface

WebParsedMetric

com.microstrategy.web.objects.WebParsedMetric

Class Overview

This interface represents a metric resulted from parsing by backend. The main part is a token stream, and it may also contain a symbol folder used for resolving naming ambiguity.

Summary

Public Methods
abstract boolean canBeSmart()
Returns a boolean value indicating whether this metric can be set to smart.
abstract int getAggregateFromBase()
Returns an integer indicating what Aggregated From Base is for a derived metric.
abstract int getAllChildrenJoin()
Returns an integer value from EnumDSSXMLOuterJoinTypes indicating the outer join type of this metric.
abstract WebDataType getDataType()
Gets the data type for this metric.
abstract int getDecomposable()
Returns an integer value from EnumDSSXMLDecomposable indicating whether this metric is decomposable.
abstract String getDescription()
Get the description of this metric.
abstract int getFromBaseFlag()
Returns an integer indicating what DerivedMetricDynamicAggAndSubtotal value is set on a derived metric.
abstract WebFormat getGridFormat()
Returns the WebFormat object for the values/data of the metric object.
abstract WebFormat getHeaderFormat()
Returns the WebFormat object for the header of the metric object.
abstract String getID()
Get the DSS id of the metric.
abstract WebFolder getLocalSymbolFolder()
Get the local symbol folder for this token stream.
abstract String getMessageID()
Return the Report or RW message ID associated with this WebParsedMetric object.
abstract String getMetricEditType()
Return the metric edit type EnumDSSXMLMetricEditType generated by backend parser for the token stream.
abstract int getMetricType()
Returns an integer value from EnumDSSXMLMetricType indicating the metric type.
abstract String getName()
Get the name of this metric.
abstract WebPropertyGroup getPropertySets()
Gets the property sets associated with this metric.
abstract int getRejectErrorCode()
Returns the reject error code generated by backend parser for the token stream.
abstract String getRejectErrorDescription()
Returns the reject error description generated by backend parser for the token stream.
abstract WebFolder getSearchResultsFolder()
Get the search results folder for this token stream.
abstract int getSubType()
Get the subType of this metric.
abstract int getSubtotalFromBase()
Returns an integer indicating what Subtotal From Base is for a derived metric.
abstract List<WebMetricSubtotal> getSubtotals()
Gets the subtotals for this metric.
abstract WebTokenStream getTokenStream()
Get the token stream for this metric.
abstract int getType()
Get the type of this object.
abstract void load(int parserOutFlags)
Load the token stream for this metric from backend.
abstract void save(int parserOutFlags)
Save the metric.
abstract void saveAs(String folderID, boolean isOverwrite, int parserOutFlags)
Save the metric as a new metric.
abstract void setAggregateFromBase(int aggregateFromBase)
Set Aggregated From Base for a derived metric.
abstract void setAllChildrenJoin(int allChildrenJoinType)
Set the value of all children join type.
abstract void setDecomposable(int decomposable)
Set the value of the decomposable type, value from EnumDSSXMLDecomposable.
abstract void setDescription(String desc)
Set the description of this metric.
abstract void setFormId(String formId)
Set the form id of the parsed object
abstract void setFromBaseFlag(int fromBaseFlag)
Set DerivedMetricDynamicAggAndSubtotal value for a derived metric.
abstract void setIsIDForm(boolean isIDForm)
Set whether the form is an ID form.
abstract void setMessageID(String mid)
Set Report or RW message ID which will be passed to xmlCommand "pm" to support Derived Metric object.
abstract void setMetricEditType(String met)
Set the metric edit type EnumDSSXMLMetricEditType
abstract void setMetricType(int metricType)
Set the metric type, value from EnumDSSXMLMetricType.
abstract void setName(String name)
Set the name of this metric.
abstract void setNew(boolean isNew)
Set whether it is a new metric or saved one.
abstract void setSubtotalFromBase(int subtotalFromBase)
Set Subtotal From Base (i.e.
abstract void setType(int type)
Set the type of this object.
abstract void validate(int parserOutFlags)
Validate the metric.

Public Methods

public abstract boolean canBeSmart ()

Returns a boolean value indicating whether this metric can be set to smart.

Returns
  • a boolean value indicating whether this metric can be set to smart.

public abstract int getAggregateFromBase ()

Returns an integer indicating what Aggregated From Base is for a derived metric.

Returns
  • int

public abstract int getAllChildrenJoin ()

Returns an integer value from EnumDSSXMLOuterJoinTypes indicating the outer join type of this metric.

Returns
  • an integer value indicating the outer join type

public abstract WebDataType getDataType ()

Gets the data type for this metric.

Returns
  • data type

public abstract int getDecomposable ()

Returns an integer value from EnumDSSXMLDecomposable indicating whether this metric is decomposable.

Returns
  • an integer value indicating whether this metric is decomposable

public abstract String getDescription ()

Get the description of this metric.

Returns
  • description

public abstract int getFromBaseFlag ()

Returns an integer indicating what DerivedMetricDynamicAggAndSubtotal value is set on a derived metric.

Returns
  • a boolean value indicating what the AFB Subtotal Style is.

public abstract WebFormat getGridFormat ()

Returns the WebFormat object for the values/data of the metric object.

public abstract WebFormat getHeaderFormat ()

Returns the WebFormat object for the header of the metric object.

public abstract String getID ()

Get the DSS id of the metric.

Returns
  • DSS id

public abstract WebFolder getLocalSymbolFolder ()

Get the local symbol folder for this token stream.

Returns
  • local symbol folder

public abstract String getMessageID ()

Return the Report or RW message ID associated with this WebParsedMetric object.

public abstract String getMetricEditType ()

Return the metric edit type EnumDSSXMLMetricEditType generated by backend parser for the token stream.

Returns
  • metric edit type

public abstract int getMetricType ()

Returns an integer value from EnumDSSXMLMetricType indicating the metric type.

Returns
  • an integer value indicating the metric type

public abstract String getName ()

Get the name of this metric.

Returns
  • name

public abstract WebPropertyGroup getPropertySets ()

Gets the property sets associated with this metric.

Returns
  • A WebPropertyGroup object, which contains the property sets associated with this metric.

public abstract int getRejectErrorCode ()

Returns the reject error code generated by backend parser for the token stream.

Returns
  • reject error code

public abstract String getRejectErrorDescription ()

Returns the reject error description generated by backend parser for the token stream.

Returns
  • reject error description

public abstract WebFolder getSearchResultsFolder ()

Get the search results folder for this token stream.

Returns
  • search results folder

public abstract int getSubType ()

Get the subType of this metric.

Returns
  • subType

public abstract int getSubtotalFromBase ()

Returns an integer indicating what Subtotal From Base is for a derived metric.

Returns
  • int

public abstract List<WebMetricSubtotal> getSubtotals ()

Gets the subtotals for this metric.

Returns

public abstract WebTokenStream getTokenStream ()

Get the token stream for this metric.

Returns
  • token stream

public abstract int getType ()

Get the type of this object.

Returns
  • type

public abstract void load (int parserOutFlags)

Load the token stream for this metric from backend.

Parameters
parserOutFlags values from EnumDSSXMLParserOutFlags
Throws
WebObjectsException

public abstract void save (int parserOutFlags)

Save the metric.

Parameters
parserOutFlags values from EnumDSSXMLParserOutFlags
Throws
WebObjectsException

public abstract void saveAs (String folderID, boolean isOverwrite, int parserOutFlags)

Save the metric as a new metric.

Parameters
folderID in which folder the metric should be saved
isOverwrite whether to overwrite the existing metric
parserOutFlags values from EnumDSSXMLParserOutFlags
Throws
WebObjectsException

public abstract void setAggregateFromBase (int aggregateFromBase)

Set Aggregated From Base for a derived metric.

public abstract void setAllChildrenJoin (int allChildrenJoinType)

Set the value of all children join type. Value from EnumDSSXMLOuterJoinTypesl

public abstract void setDecomposable (int decomposable)

Set the value of the decomposable type, value from EnumDSSXMLDecomposable.

public abstract void setDescription (String desc)

Set the description of this metric.

public abstract void setFormId (String formId)

Set the form id of the parsed object

public abstract void setFromBaseFlag (int fromBaseFlag)

Set DerivedMetricDynamicAggAndSubtotal value for a derived metric.

public abstract void setIsIDForm (boolean isIDForm)

Set whether the form is an ID form.

public abstract void setMessageID (String mid)

Set Report or RW message ID which will be passed to xmlCommand "pm" to support Derived Metric object.

public abstract void setMetricEditType (String met)

Set the metric edit type EnumDSSXMLMetricEditType

Parameters
met metric edit type

public abstract void setMetricType (int metricType)

Set the metric type, value from EnumDSSXMLMetricType.

public abstract void setName (String name)

Set the name of this metric.

public abstract void setNew (boolean isNew)

Set whether it is a new metric or saved one.

public abstract void setSubtotalFromBase (int subtotalFromBase)

Set Subtotal From Base (i.e. AggreateFromBaseStyle) for a derived metric.

public abstract void setType (int type)

Set the type of this object.

public abstract void validate (int parserOutFlags)

Validate the metric.

Parameters
parserOutFlags values from EnumDSSXMLParserOutFlags
Throws
WebObjectsException