Package com.microstrategy.web.objects
Interface WebRowValue
-
- All Superinterfaces:
WebCssFormatContainer,WebTransactableDataObject
public interface WebRowValue extends WebCssFormatContainer, WebTransactableDataObject
This interface provides accessor methods to obtain the various properties associated with a metric value.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetCcl()Returns the cell color.WebHeadergetColumnHeader()Returns the corresponding column-axis WebHeader at the finest granularity associated with the this WebRowValue.WebHeadergetColumnHeader(int enumWebHeaderType)Returns the corresponding column-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.WebRowgetContainer()WebDrillMapgetDrillMap()Returns the drill map assigned to the template.intgetOrdinal()java.lang.StringgetRawValue()Returns the raw data value of this row value.WebHeadergetRowHeader()Returns the corresponding row-axis WebHeader at the finest granularity associated with the this WebRowValue.WebHeadergetRowHeader(int enumWebHeaderType)Returns the corresponding row-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.intgetSemantics()The meaning of this form value.WebTitlegetSubtotalTitle()intgetTransactionAction()return thresholdActionEnumDSSXMLTransactionActionintgetType()java.lang.StringgetValue()booleanisEditDisable()Returns the unit can be edit or not.booleanisFirst()booleanisLast()voidsetTransactionAction(int action)set thresholdActionEnumDSSXMLTransactionAction-
Methods inherited from interface com.microstrategy.web.objects.WebCssFormatContainer
getCssClass, getCssFormat, getFormatPropertySets
-
Methods inherited from interface com.microstrategy.web.objects.WebTransactableDataObject
isModifiedByTransaction
-
-
-
-
Method Detail
-
getType
int getType()
- Returns:
- the
EnumWebRowValueTypeof the row value.
-
getValue
java.lang.String getValue()
- Returns:
- the row value.
-
getRawValue
java.lang.String getRawValue()
Returns the raw data value of this row value.- Returns:
- String The raw data value, which is the unformatted value of this row value.
Return
nullwhen there is no raw value specified for this row value. Note that the report needs to have theEnumDSSXMLResultFlags#DssXmlResultNoNumberFormatingflag set before the results are obtained in order this method to return the actual raw value. - Since:
- MicroStrategy Web 7.5.4
-
isFirst
boolean isFirst()
- Returns:
- if this row value is the first element in the encapsulating WebRow collection.
-
isLast
boolean isLast()
- Returns:
- if this row value is the last element in the encapsulating WebRow collection.
-
getColumnHeader
WebHeader getColumnHeader()
Returns the corresponding column-axis WebHeader at the finest granularity associated with the this WebRowValue. This only makes sense for metric row values. Null is returned for subtotals, or if no associated header is found.- Returns:
- the corresponding column-axis WebHeader
-
getRowHeader
WebHeader getRowHeader()
Returns the corresponding row-axis WebHeader at the finest granularity associated with the this WebRowValue. This only makes sense for metric row values. Null is returned for subtotals, or if no associated header is found.- Returns:
- the corresponding row-axis WebHeader
- Since:
- MicroStrategy Web 7.5.0
-
getColumnHeader
WebHeader getColumnHeader(int enumWebHeaderType)
Returns the corresponding column-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.- Parameters:
enumWebHeaderType-- Returns:
- the corresponding column-axis WebHeader of specified type.
- Since:
- MicroStrategy Web 7.5.0
-
getRowHeader
WebHeader getRowHeader(int enumWebHeaderType)
Returns the corresponding row-axis WebHeader of specified type at the finest granularity associated with the this WebRowValue.- Parameters:
enumWebHeaderType-- Returns:
- the corresponding row-axis WebHeader of specified type.
- Since:
- MicroStrategy Web 7.5.0
-
getDrillMap
WebDrillMap getDrillMap()
Returns the drill map assigned to the template.- Returns:
- the corresponding drill map for the template
- Since:
- MicroStrategy Web 7.5.0
-
getSemantics
int getSemantics()
The meaning of this form value. This implies, but is not the same as, the data type. Values of this attribute are derived from the COM interface EnumDSSBaseFormType:1 = date/time 2 = number 3 = text 4 = image 5 = anchor (a URL to go to if the user clicks the cell) 6 = email 7 = HTML tag 8 = date 9 = time
- Returns:
- the semantic type.
-
getOrdinal
int getOrdinal()
- Returns:
- the ordinal polsition (starts from 1).
-
getCcl
java.lang.String getCcl()
Returns the cell color. Only used by legacy applications.- Returns:
- the cell color.
-
getSubtotalTitle
WebTitle getSubtotalTitle()
This method will return theWebTitlecorresponding to the 'Subtotal'WebHeader, if this is subtotal value, otherwise null will be returned. If both the row and column axis define a subtotal header, the row title will be returned.- Returns:
WebTitleof 'Subtotal'WebHeader.- Since:
- MicroStrategy Web 9.0.0
-
isEditDisable
boolean isEditDisable()
Returns the unit can be edit or not.- Returns:
- the unit can be edit or not.
-
setTransactionAction
void setTransactionAction(int action)
set thresholdActionEnumDSSXMLTransactionAction- Parameters:
action-EnumDSSXMLTransactionAction
-
getTransactionAction
int getTransactionAction()
return thresholdActionEnumDSSXMLTransactionAction- Returns:
- thresholdAction
EnumDSSXMLTransactionAction
-
-