public static interface

ACMDistributor.Consolidator

com.microstrategy.webapi.ACMDistributor.Consolidator

Class Overview

Consolidator is an interface that the user of the ACMDistributer utility must implement

Summary

Nested Classes
enum ACMDistributor.Consolidator.SESSION_MODE  
enum ACMDistributor.Consolidator.STRING_DATA_FORMAT  
Public Methods
abstract void addToConsolidation(String iStringData)
addToConsolidation will add the passed in string data format (xml or Json) to the string data already in the baseline
abstract void extractPage()
extractPage is used after the results are complete and merged.
abstract String getConsolidatedStringData()
getConsolidatedStringData will return the string data format (xml or Json) that has been consolidated in the startConsolidation and addToConsolidation steps@return
abstract ACMDistributor.Consolidator.STRING_DATA_FORMAT getResultStringDataFormat()
abstract ACMDistributor.Consolidator.SESSION_MODE getSessionMode()
abstract String remoteCall(IDSSXMLSessionId iSessionId, Collection<String> iPids)
remoteCall constructs the XML and sends it to IServer.
abstract void setConsolidationSource(Map<IDSSXMLClusterNode, List<String>> iNodes, IDSSXMLSessionId.IMasterSessionId iMasterSessionId)
set the list of cluster nodes to get the results from
abstract void setTime(long iMilliseconds)
setTime is used to set the total running time of the distributed operation.
abstract void startConsolidation(String iStringData)
startConsolidation will set up the baseline string data format (xml or Json) that will be the final answer

Public Methods

public abstract void addToConsolidation (String iStringData)

addToConsolidation will add the passed in string data format (xml or Json) to the string data already in the baseline

Throws
MSTRWebAPIException

public abstract void extractPage ()

extractPage is used after the results are complete and merged. The resulting set may be very large. This method pulls out, from that resulting set, just the page that was asked for.

public abstract String getConsolidatedStringData ()

getConsolidatedStringData will return the string data format (xml or Json) that has been consolidated in the startConsolidation and addToConsolidation steps@return

Throws
MSTRWebAPIException

public abstract ACMDistributor.Consolidator.STRING_DATA_FORMAT getResultStringDataFormat ()

public abstract ACMDistributor.Consolidator.SESSION_MODE getSessionMode ()

public abstract String remoteCall (IDSSXMLSessionId iSessionId, Collection<String> iPids)

remoteCall constructs the XML and sends it to IServer. The result is returned. The result MUST be in a "string data format" such as xml or Json

Throws
MSTRWebAPIException

public abstract void setConsolidationSource (Map<IDSSXMLClusterNode, List<String>> iNodes, IDSSXMLSessionId.IMasterSessionId iMasterSessionId)

set the list of cluster nodes to get the results from

Throws
MSTRWebAPIException

public abstract void setTime (long iMilliseconds)

setTime is used to set the total running time of the distributed operation. Each operation is run simultaneously. Thus, timing each operation alone and then adding the results could produce a time that is actually longer than the real-time that has elapsed as an end user would feel. So, the algorithm is to start a timer before distribution, stop the timer once all results are complete and merged. Use this method set that time interval.

public abstract void startConsolidation (String iStringData)

startConsolidation will set up the baseline string data format (xml or Json) that will be the final answer

Throws
MSTRWebAPIException