DifferenceToXmlDoc (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax table to syntax template, tags and edits)
Line 1: Line 1:
{{Template:UserStatistics:DifferenceToXmlDoc subtitle}}
{{Template:UserStatistics:DifferenceToXmlDoc subtitle}}
The <var>DifferenceToXmlDoc</var> method returns to an [[<var>[[XmlDoc_class#The_XmlDoc_class|XML document]]</var> the difference in values between one <var>[[UserStatistics_class|UserStatistics]]</var> object and another for all [[UserStatistics class#login|Login]] (also called "Final") statistics with non-zero values (by default) or for all Login statistics including those with zero values.
   
   
This method returns to an XML document the difference in values between one
UserStatistics object and another for all Login statistics with non-zero values
(by default) or for all Login statistics (as an option).
See the description of [[UserStatistics class#login|login statistics]].
==Syntax==
==Syntax==
{{Template:UserStatistics:DifferenceToXmlDoc syntax}}
{{Template:UserStatistics:DifferenceToXmlDoc syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%doc</i></th>
<tr><th>%doc</th>
<td>A [[Janus SOAP]] XmlDoc object variable to contain the listing of the difference values of the Login statistics. </td></tr>
<td>A [[Janus SOAP]] XmlDoc object variable to contain the listing of the difference values of the Login statistics. </td></tr>
<tr><th><i>%ustat</i></th>
<tr><th>%userStatistics</th>
<td>A UserStatistics object variable. </td></tr>
<td>A <var>userStatistics</var> object variable. </td></tr>
<tr><th><i>%ustatOld</i></th>
<tr><th>ustatOld</th>
<td>An older UserStatistics object variable for the same user login as ''%ustat''. </td></tr>
<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStatistics</var>.</td></tr>
<tr><th><b>Zeros= </b><i>bool</i></th>
<tr><th>Zeros</th>
<td>This name required argument (<tt>Zeros</tt>) is a boolean value that indicates whether differences with a zero value should be included in the returned data. Zeros is an optional argument that defaults to <tt>False</tt>, which results in non-zero values only being included. </td></tr>
<td>This <var>[[Methods#Named parameters|Name-Required]]</var> argument (<var class="term">Zeros</var>) is a <var>[[boolean]]</var> value that indicates whether differences with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <code>False</code>, which results in non-zero values only being included. </td></tr>
<tr><th><b>AttributeValues= </b><i>bool</i></th>
<tr><th>AttributeValues</th>
<td>This name required argument (<tt>AttributeValues</tt>) is a boolean value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements.  For example, <tt><DKRD>1107</DKRD></tt> is text format, and <tt><DKRD value="1107"/></tt> is attribute-value format.  The default value is <tt>False</tt>, which produces text format. </td></tr>
<td>This <var>Name-Required</var> argument (<code>AttributeValues</code>) is a <var>[[boolean]]</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements.  For example, <code><DKRD>1107</DKRD></code> is text format, and <code><DKRD value="1107"/></code> is attribute-value format.  The default value is <code>False</code>, which produces text format. </td></tr>
<tr><th><b>AttributeNames= </b><i>bool</i></th>
<tr><th>AttributeNames</th>
<td>This name required argument (<tt>AttributeNames</tt>) is a boolean value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a &amp;amp;ldquo;name&amp;amp;rdquo; attribute.  For example, <tt><DKRD>1107</DKRD></tt> is element-name format, and the following is name-as-attribute format: <p class="code"><nowiki><stat name="DKRD">   1107 </stat> </nowiki></p> The default value is <tt>False</tt>, which produces element-name format. </td></tr>
<td>This <var>Name-Required</var> argument (<code>AttributeNames</code>) is a <var>[[boolean]]</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute.  For example, <code><DKRD>1107</DKRD></code> is element-name format, and the following is name-as-attribute format:
<tr><th><b>NamesToLower= </b><i>bool</i></th>
<p class="code"><nowiki><stat name="DKRD">
<td>This name required argument (<tt>NamesToLower</tt>) is a boolean value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <tt>False</tt>.</td></tr>
    1107
</stat>
</nowiki></p>
The default value is <code>False</code>, which produces element-name format.</td></tr>
<tr><th>NamesToLower</th>
<td>This <var>Name-Required</var> argument (<code>NamesToLower</code>) is a <var>[[boolean]]</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <code>False</code>.</td></tr>
</table>
</table>


==Usage notes==
<ul>
<li>The [[Difference (UserStatistics function)|Difference]] function returns the value
differences between two UserStatistics objects for the Login statistic you specify.
The [[DifferenceToString (UserStatistics function)|DifferenceToString]] function returns to a longstring
the value differences for all, or all non-zero, Login statistics.
</ul>
==Examples==
==Examples==
<ol><li>
The display of non-zero difference statistics below is produced
The display of non-zero difference statistics below is produced by a sequence of statements like the following:
by a sequence of statements like the following:
<p class="code">%doc is object xmldoc
<p class="code"><nowiki>%doc is object xmldoc
%statStart is object userstatistics
%statStart is object userstatistics
%statEnd is object userstatistics
%statEnd is object userstatistics
  . . .
  . . .
%doc = %statEnd:differencetoXmlDoc(%statStart, zeros=false)
%doc = %statEnd:differencetoXmlDoc(%statStart, zeros=false)
%doc:Print
%doc:print
</nowiki></p>
</p>
The following are sample results:
The following are sample results:
<p class="code"><nowiki><UserStatisticsDifferences time="20080903121750819"
<p class="code"><nowiki><UserStatisticsDifferences time="20080903121750819"
Line 55: Line 46:
</UserStatisticsDifferences>
</UserStatisticsDifferences>
</nowiki></p>
</nowiki></p>
<li>Using the:
A <code>%doc = %statEnd:differencetoXmlDoc(%statStart)</code>
<p class="code">%doc = %statEnd:differencetoXmlDoc(%statStart)</p>
statement would
statement would return all the statistics, including those with a <code>0</code> value.
return all the statistics, including those with a <code>0</code> value.
</ol>
 
==See also==
==See also==
<ul>
<li><var>[[Difference (UserStatistics function)|Difference]]</var> which returns the value differences between two <var>UserStatistics</var> objects for the Login statistic you specify.
<li><var>[[DifferenceToString (UserStatistics function)|DifferenceToString]]</var> which returns to a <var>longstring</var> containing the value differences for all, or all non-zero, Login statistics.
</ul>
{{Template:UserStatistics:DifferenceToXmlDoc footer}}
{{Template:UserStatistics:DifferenceToXmlDoc footer}}

Revision as of 11:10, 30 March 2011

Login timestamps difference in xml format (UserStatistics class)

The DifferenceToXmlDoc method returns to an [[XML document the difference in values between one UserStatistics object and another for all Login (also called "Final") statistics with non-zero values (by default) or for all Login statistics including those with zero values.

Syntax

%doc = userStatistics:DifferenceToXmlDoc( ustatOld, [Zeros= boolean], - [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean])

Syntax terms

%doc A Janus SOAP XmlDoc object variable to contain the listing of the difference values of the Login statistics.
%userStatistics A userStatistics object variable.
ustatOld An older UserStatistics object variable for the same user login as userStatistics.
Zeros This Name-Required argument (Zeros) is a boolean value that indicates whether differences with a zero value should be included in the returned data. Zeros is an optional argument that defaults to False, which results in non-zero values only being included.
AttributeValues This Name-Required argument (AttributeValues) is a boolean value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example, <DKRD>1107</DKRD> is text format, and <DKRD value="1107"/> is attribute-value format. The default value is False, which produces text format.
AttributeNames This Name-Required argument (AttributeNames) is a boolean value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example, <DKRD>1107</DKRD> is element-name format, and the following is name-as-attribute format:

<stat name="DKRD"> 1107 </stat>

The default value is False, which produces element-name format.
NamesToLower This Name-Required argument (NamesToLower) is a boolean value that indicates whether statistic names are to be displayed in lowercase characters. The default value is False.

Examples

  1. The display of non-zero difference statistics below is produced by a sequence of statements like the following:

    %doc is object xmldoc %statStart is object userstatistics %statEnd is object userstatistics . . . %doc = %statEnd:differencetoXmlDoc(%statStart, zeros=false) %doc:print

    The following are sample results:

    <UserStatisticsDifferences time="20080903121750819" userNumber="20" loginTime="20080903115821710" baseTime="20080903121750818"> <SQWR>2</SQWR> <MOVE>2</MOVE> <DKAR>2</DKAR> </UserStatisticsDifferences>

  2. Using the:

    %doc = %statEnd:differencetoXmlDoc(%statStart)

    statement would return all the statistics, including those with a 0 value.

See also

  • Difference which returns the value differences between two UserStatistics objects for the Login statistic you specify.
  • DifferenceToString which returns to a longstring containing the value differences for all, or all non-zero, Login statistics.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=DifferenceToXmlDoc_(UserStatistics_function)&oldid=13522"