COM.TIBCO.hawk.config.rbengine.rbmap

Class RBMapXML

java.lang.Object

COM.TIBCO.hawk.config.rbengine.RBEConfigObjectXML

COM.TIBCO.hawk.config.rbengine.rbmap.RBMapXML

All Implemented Interfaces:

java.io.Serializable

public class RBMapXML
extends RBEConfigObjectXML

The RBMapXML provides methods for accessing XML representation of a RBMap. A RBMapXML object is used when sending RBMap to or receiving from a TIBCO Hawk Agent within an application written using Console API.

For example, the following code fragment shows how to get a RBMap from a repository microagent:

        MicroAgent maidRepo = getRepositoryMicroagentID();
        MethodInvocation mi = new MethodInvocation("getRBMap", null);
        MicroAgentData mad =  agentManager.invoke( maidRepo, mi );

        Object o = mad.getData();
        if (o instanceof RBMapXML)
        {
           RBMapXML rbXMLs = (RBMapXML)mad.getData();

           // return the retrieved RBMap
           return new RBMap(rbXMLs.getXMLReader());
        }
        // if error occurred on the agent, the returned object will be a MicroAgentException
        else if (o instanceof MicroAgentException)
           throw (MicroAgentException)o;
 

and, to send a RBMap to an repository microagent:

        RBMap schedules = getRBMap();
        MicroAgent maidRepo = getRepositoryMicroagentID();
        DataElement[] dataElements = new DataElement[2];
        dataElements[0] = new DataElement("RBMapXML", new RBMapXML(RBMap));
        dataElements[1] = new DataElement("Notify" , new Boolean(false));
        MethodInvocation mi = new MethodInvocation("setRBMap", dataElements);
        MicroAgentData mad =  agentManager.invoke( maidRepo, mi );
 

For a complete list of methods in RepositoryMicroagent, refer to TIBCO Hawk Console API Method's Reference. For a complete sample for retrieving and sending a RBMap, see the RulabseMap API samples in TIBCO Hawk installation samples.

Constructor Summary

Constructors

Constructor and Description
RBMapXML(RBMap rbMap) Constructs a RBMapXML for a specified RBMap.

Method Summary

Methods inherited from class COM.TIBCO.hawk.config.rbengine.RBEConfigObjectXML

getXMLReader, getXMLString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RBMapXML

public RBMapXML(RBMap rbMap)

Constructs a RBMapXML for a specified RBMap.