HemiHemi JavaScript FrameworkHemi JavaScript Framework/Hemi/Framework base classes, including: Hemi for creating framework objects and loading external libraries; Hemi.xml for AJAX and JSON requests (libXmlRequest derivative); Hemi.registry for object repository management; Hemi.message for delegating message subscriptions and publications.Hemi3.1.9The base set of classes for the Hemi Framework.HemiCreate Framework ObjectDemonstrate how to create a new Framework Object// Create a new object that is also registeredvar oNewObject = Hemi.newObject("myObject","1.0", true);var sId = oNewObject.getObjectId();// Retrieve the object from the registryvar oLookup = Hemi.registry.service.getObject(sId);Prepare an Existing Object for the FrameworkDemonstrate how to prepare an existing object for the framework and use a custom identifier.// Prepare an existing object and give it a custom idvar oObject = {};oObject.object_id = "MyCustomId";Hemi.prepareObject("myObject", "1.0", true, oObject);// Retrieve the object from the registryvar oLookup = Hemi.registry.service.getObject("MyCustomId");The base path of the Hemi Framework. By default, the base path is /Hemi/ when accessed via http/s, and the current directory when accessed via the filesystem.logErrorMessage to send to the logger.Sends a message in the #100.5 message block.logWarningMessage to send to the logger.Sends a message in the #100.4 message block.logDebugMessage to send to the logger.Sends a message in the #100.1 message block.logMessage to send to the logger.Sends a message in the #100.3 message block.isImportedNamespace name.Bit indicating whether the namespace has been imported.Returns the object identifier.dereferenceNamespace or Library name of the imported script file.Bit indicating the namespace and library maps were dereferenced.Dereferences the imported library and library map. This does not delete the object from its parent, or destroy the object from the framework. alert('def: ' + n + ":" + HemiEngine.isImported(n)); getLibraryNamespace or Library name of the imported script file.Returns an internal namespace object.Returns the specified namespace object.includeNamespace of the script file to import.Path where the script file resides. Default to Framework/Bit indicating whether the loaded script should not be executed.Returns an internal namespace object.Imports the specified namespace. try { namespaceCreates a hierarchical object namespace from the supplied name.Period-delimited hierarchy.Base object, defaults to Hemi.Context (which default to window).Object hash contents.Bit indicating the namespace defines service and serviceImpl members, and to instantiate the service.lookupVerifies the specified hierarchy exists.Period-delimited hierarchy.Returns true if the hierachy exists, or the matching object if bObjOut is set to true.hashlightA very light hash.Data to be hashed.A light hash of the input data.guidReturns a globally unique identifier, relative to the page view. This uses a weak hash.A unique id.newObjectThe type of the object.The version of the object.Bit indicating whether the object should be registered with the Object Registry.Bit indicating whether the object should include a deconstructor.Object members to include on this object.The new framework object.Creates and optionally registers a new FrameworkObject ready for use within the framework.prepareObjectThe type of the object.The version of the object.Bit indicating whether the object should be registered with the Object Registry.The object to be prepared for use in the Hemi framework.Bit indicating whether the object should include a deconstructor.Prepares and optionally registers a new FrameworkObject ready for use within the Hemi framework._implementsTarget object to merge features..Name of merge features.Overloaded variant arguments to pass to the implementing object constructor.Implements a specified feature._forNameName of the object to return.Object based on the specified name.Creates a specific internal object. Includes the definition for base_object, and supports external definitions via class imports.GetSpecifiedAttributeNode referenceName of the attribute to test.Value of the attribute.Returns the value of an attribute if it was specified and the length is greater than zero.IsAttributeSetNode referenceName of the attribute to test.Bit indicating whether to return the attribute value instead of a positive bit.A bit indicating whether the specified attribute was set.Tests whether an attribute has been set.registry.service3.1.9Static implementation of hemi.registry.serviceImplgetEvalStatementRegistered object.A javascript statement which, when evaluated, returns a reference to the object.Returns a string statement that can be evaluated to return a reference to the registered object.getApplyStatementRegistered object.Name of a method on the registered objectA javascript statement which, when evaluated, returns a reference to the function on the object.Returns a string statement that can be evaluated to return a reference to the specified method for the registered object.registry.serviceImpl3.1.9Repository service for storing and discovering framework objects.canRegisterObject to test whether or not it can be registered.Returns true if the specified object defines an object_id, object_version, and object_type String property, and ready_state int property.Verifies whether an object can be added to the registry.addObjectObject to add to the registryReturns true if the object was added to the registry.Adds the specified object to the registry, and automatically registers the object with the transaction service.removeObjectObject to remove from the registryBit indicating whether the onremoveobject message should be suppressed from being published.Returns true if the object was removed.Removes the specified object from the registry.getObjectsArrayArray of registered objects.Returns an array of registered objects.getObjectsMapArray of object identifiers directly mapped to the objects array.Returns the object identifier mapping.getObjectIndex or name of the object to retrieve.Object with the specified identifier or index.Returns the object matching the specified identifier or index.isRegisteredObject in the registryReturns true if the object is in the registry.Returns true if the specified object is in the registry.sendSigtermSends a termination signal to all registered objects for preparation to be destroyed. This method causes all objects to be removed from the registry, and to have any sigterm method invoked.sendDestroyToObject in the registryReturns true if the object defined a destroy method and the method was invoked.Invokes the destroy method on the specified object. Object must be registered. This method will not remove the object from the registry.message.service3.1.9Static implementation of hemi.message.serviceImplmessage.serviceImpl3.1.9Service that delegates subscriptions and publications at a global and object level.getReportThresholdThe message threshold.Returns the report threshold for sendMessage. Messages sent below this level will not be propogated.setReportThresholdInt or string value. Int values are 0 - 7, and String values are: ALL, DEBUG, ADVISORY, NORMAL, WARNING, ERROR, FATAL, NONESets the report threshold for sendMessage. Messages sent below this level will not be propogated. If a number, retrieve the level name If the level name is a valid index ... getEntriesArray of recent messages.Returns the current message buffer.clearEntriesClears message entries.getDeliveryDelayDelay in milliseconds between publication and delivery.Returns the delay in milliseconds between publication and delivery.setDeliveryDelaySets the delay in milliseconds.Sets the delay in milliseconds between publication and delivery.subscribeThe object for which the subscription will belong.The name of the publication.Function to be invoked on message publication.Reference object, such as the publication owner, used to filter publications to this subscription.Subscribes an object to receive message publications for the specified publication name.unsubscribeThe object for which the subscription belongs.The name of the publication.Function invoked on message publication.Unsubscribes an object from receiving message publications for the specified publication name.Returns true if unsubscribed, false otherwise.sigtermTermination signal indicating the message service should stop processing messages and subscriptions, and be prepared for destruction.flushClears delayed delivery cache._delayPublishIdentifier of the cached message item to be delivered for the corresponding subscribers.End action for a delayed publication. Cached message is sent directly on to publication.publishThe name of the publication.Data being published.Publishes the specified data to registered subscribers. If delayed delivery is in effect, caches the message data and sends it after the preset delay in milliseconds._publishThe name of the publication.Data being published.Publishes the specified data to registered subscribers.sendMessageThe message data to be sent.Numeric message code.Bit indicating the message should raise an alert.Sends the specified message as a Message to all onsendmessage subscribers.The Message created for this message.parseMessageA Message object.Formatted message.Parses a message object and returns a formatted construct suitable for printing to a log. After a message definition is registered, the encoded definition data must be resorted Otherwise, the message definition may (and probably will) return the wrong label! The hemi.util.logger invokes this for new message definitions Given some code in the format of ###.###.### Return the corresponding instruction object xml3.1.9XML Utilities for making AJAX and JSON requests, result caching, request pooling, and XML-XHTML node manipulation.Synchronous GETMake a synchronous request for an XML document.[xml_dom_object] = getXml(path);var oXml = Hemi.xml.getXml("/Data/Test1.xml");Asynchronous GETMake an asynchronous request for an XML document.[int] = getXml(path,custom_handler,1,{optional_id});function HandleXml(s,v){ var oXml = v.xdom;}Hemi.xml.getXml("/Data/Test1.xml",HandleXml,1);Cached Asynchronous GETAsynchronously request an XML document, and cached the result for later referal.[int] = getXml(path,custom_handler,1,request_id,1);function HandleXml(s,v){ var oXml = v.xdom;}Hemi.xml.getXml("/Data/Test1.xml",HandleXml,1,"cache-me",1);Synchronous POSTSynchronously post data to the server.[xml_dom_object] = postXml(path,data);var oPostThis = Hemi.xml.newXmlDocument("Request");var oData = oPostThis.createElement("data");oData.setAttribute("id","data-id");oData.setAttribute("value","data-value");oPostThis.documentElement.appendChild(oData);var oResponseXml = Hemi.xml.postXml("/Data/TestData.aspx",oPostThis);Asynchronous POSTAsynchronously post data to the server.[int] = postXml(path,data,custom_handler,1,{optional_id});function HandleXml(s,v){ var oResponseXml = v.xdom;}var oPostThis = Hemi.xml.newXmlDocument("Request");var oResponseXml = Hemi.xml.postXml("/Data/TestData.aspx",oPostThis,HandlePostXml,1);xml_content_typeSpecifies the content type to use posting data.text_content_typeSpecifies the content type to use requesting and receiving text data (eg: JSON).auto_content_typeSpecifies whether to determine posted content type by included post value.form_content_typeSpecifies the content type to use when auto_content_type is true and the post value is a string.ax_http_controlSpecifies the name of the registered ActiveX control to use for XML requests.ax_http_controlSpecifies the name of the registered ActiveX control to use for XML requests.gadget_modeSpecifies whether the xml package is operating in a mode that better supports Windows Sidebar Gadgets.gadget_controlSpecifies the name of the registered ActiveX control to use for XML requests when in Gadget mode.gadget_base_pathSpecifies the base path to use when operating in Gadget mode. The base path should be in the format of a file URI, such as file:///c:/....setCacheEnabledboolean indicating whether caching is enabled.getCacheEnabledboolean indicating whether caching is enabled.setPoolEnabledboolean indicating whether pooling is enabled.getPoolEnabledboolean indicating whether pooling is enabled.parseXmlDocumentXML source text.XMLDocument object.newXmlDocumentName of root node to create in new document.XMLDocument object.getRequestArrayAn array of requests.Returns an array of XML requests.clearClears the request maps and caches.clearCacheClears the response cache.getXmlHttpArrayArray of XmlHttp objects.resetXmlHttpObjectPoolResets the current pool with new instances of XMLHttpRequest objects.testXmlHttpObjectTests whether an XMLHTTPRequest object can be created.Bit indicating whether a new XMLHTTPRequest object was created.newXmlHttpObjectCreates a new XMLHTTPRequest object.Bit indicating whether to wrap the new object in an internal XmlHttp object for use with pooling.Pool index to set on new XmlHttp object.Bit indicating whether this is a test operation, and to return true if the object was created, or false otherwise.Return value is determined by the specified parameters.returnXmlHttpObjectToPoolReturns an in-use XmlHttp object to the pool of available resources.Pool index of the XmlHttp object to be returned.Bit indicating whether the pool object was requested for asynchronous operation.getXmlHttpObjectFromPoolRetrieves the next available XmlHttp object from the pool of available resources.Bit indicating whether the pool object is requested for asynchronous operation.An XmlHttp object.getJSONRetrieve a JSON object from the specified path.Path of the JSON source. If specifying the server, note the server name and port must match the context host name and port.Function to invoke when a response is received.Bit indicating whether the request is an asynchronous operation.Identifier to assign to the request.Bit indicating whether the response should be cached.Returns boolean for asynchronous operations, and a JSON object for synchronous operations.getTextRetrieve text from the specified path.Path of the text source. If specifying the server, note the server name and port must match the context host name and port.Function to invoke when a response is received.Bit indicating whether the request is an asynchronous operation.Identifier to assign to the request.Bit indicating whether the response should be cached.Returns boolean for asynchronous operations, and text for synchronous operations.getXmlRetrieve an XML document from the specified path.Path of the XML source. If specifying the server, note the server name and port must match the context host name and port.Function to invoke when a response is received.Bit indicating whether the request is an asynchronous operation.Identifier to assign to the request.Bit indicating whether the response should be cached.Returns boolean for asynchronous operations, and an XMLDocument object for synchronous operations.postJSONPosts a JSON object to the specified path and returns any JSON response.Path of the XML source. If specifying the server, note the server name and port must match the context host name and port.XMLDocument to post the serverFunction to invoke when a response is received.Bit indicating whether the request is an asynchronous operation.Identifier to assign to the request.Returns boolean for asynchronous operations, and a JSON object for synchronous operations.postTextPosts text to the specified path and returns any text response.Path of the XML source. If specifying the server, note the server name and port must match the context host name and port.XMLDocument to post the serverFunction to invoke when a response is received.Bit indicating whether the request is an asynchronous operation.Identifier to assign to the request.Returns boolean for asynchronous operations, and text for synchronous operations.postXmlPosts an XML document to the specified path and returns any XML response.Path of the XML source. If specifying the server, note the server name and port must match the context host name and port.XMLDocument to post the serverFunction to invoke when a response is received.Bit indicating whether the request is an asynchronous operation.Identifier to assign to the request.Returns boolean for asynchronous operations, and an XMLDocument object for synchronous operations.onloadxmlThe Hemi.xml object representing the request.Message published to all subscribers when an xml request has completed loading. This message is published for text and JSON requests made through the XML request._request_xmlhttpAssembles and opens an XMLHTTP Request.Path to the XML data source.Handler invoked for asynchronous requests.Bit indicating whether the request is asynchronous.Identifier used to track the request and retrieve cached results.Bit indicating whether the request is a post.XML Document to send with post request.Bit indicating whether the response should be cached.Int indicating whether the request and response as text (1) or JSON (2) instead of XML (0).Returns a boolean value for asynchronous requests, an XML Document for synchronous requests, text when the text bit is set to (1), and a JSON object when the text bit is set to (2). 2011/02/22 Only use the proxy if loaded TODO - need to add in the feature tag support so statements like this check can be stripped from the whole compilation Otherwise, it's wasted space 2011/02/22 - isProxied checks for a proxy protocol and supported data.io bus type 2011/02/20 - This is an early phase proxy - the general data exchange across components needs to have a clean entry/exit through data.io instead of straight xml For current compatibility, it's shimmed into the xml-handling. NOTE: Because this is a shim, it does not use any of the xml utility level caching. Also, it's an ugly duplication of the XML OM reconstruction 2011/02/22 - Strip any proxy protocol tags, which may occur for matching proxy protocols and unsupported bus types alert(i + "\n" + r.ct); alert(z); transformNodeTransforms the specified Document with the specified XSL document.XML Document to be transformed. If specified as a string, the string is used as a path to request the XML Document.XSL Document to transform the XML Document. If specified as a string, the string is used as a path to request the XSL Document.DOMNode to transform.Identifier used when requesting the XML Document.Identifier used when requesting the XSL Document.Bit indicating whether a request for the XSL Document should be cached.Bit indicating whether the transformation should expect a type text/plain as a result.Depending on the type of copy operation, returns a reference to the newly created node. alert(o==null); selectSingleNodeReturns a DOM Node selected from the specified document and based on the specified path.XMLDocument.XPath query.Context node.Returns a DOM Node based on the specified xpath query.selectNodesReturns an array of DOM Nodes selected from the specified document and based on the specified path.XMLDocument.XPath query.Context node.Returns an array of DOM Nodes based on the specified xpath query.queryNodesReturns an array of DOM Nodes selected from the specified document and based on the specified parent node name, node name, and attribute name and values.XMLDocument.Parent element name.Element name. Defaults to parent if not specified.Attribute name.Attribute value.Returns an array of DOM Nodes based on the specified parent node name, node name, and attribute name and value.queryNodeReturns a DOM Node selected from the specified document and based on the specified parent node name, node name, and attribute name and values.XMLDocument.Parent element name.Element name. Defaults to parent if not specified.Attribute name.Attribute value.Returns a DOM Node based on the specified parent node name, node name, and attribute name and value.serializeReturns a string representation of the specified node and its children.XML DOM Node.String representation of the specified node. 2011/04/10 Switch order to take property over XMLSerializer IE 9.0 has problems with XMLSerializer and the responseXML document getCDATAValueReturns a concatenation of all CDATA values that are immediate children of the specified node.XML DOM Node.Returns a concatenation of all child CDATA values.getInnerTextReturns a concatenation of text nodes belonging to all children of the specified node.DOM Node.Bit indicating to only return the first text value.Returns the inner text of the specified node.removeChildrenRemoves all child nodes of the specified node.DOM Node.Bit indicating to send a termination signal to any backing objects if a Hemi reference identifier is found.swapNodeReplaces the specified node.DOM Node to replace.New DOM Node.setInnerXHTMLCopies the child nodes of the specified source node into the specified target node.DOM Node into which the source node children will be copied.DOM Node from which nodes will be copied into the target node.Bit indicating whether to keep the children of the target node, or to remove them before copying in the new contents.Document object to use when creating elements for the target node.Bit indicating whether recursion should be blocked.Bit indicating whether whitespace should be preserved.Bit indicating whether HTML source nodes should be cloned instead of incrementally recreated.Optional callback handler for substituting values prior to copying. Useful for templates.Depending on the type of copy operation, returns a reference to the newly created node.JSONReviverCustom reviver for handling date values.Key name.Key value.Revived key value for use with JSON. if(v == v.caller) break; Framework base classes, including: Hemi for creating framework objects and loading external libraries; Hemi.xml for AJAX and JSON requests (libXmlRequest derivative); Hemi.registry for object repository management; Hemi.message for delegating message subscriptions and publications.Hemi_api.htmlAPI Index