DifferenceToXmlDoc (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (looks better like that (and consistent with ToXMLDoc))
mNo edit summary
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:UserStatistics:DifferenceToXmlDoc subtitle}}
{{Template:UserStatistics:DifferenceToXmlDoc subtitle}}
The <var>DifferenceToXmlDoc</var> method returns to an <var>[[XmlDoc_class|XmlDoc]]</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 <var>Login</var> statistics including those with zero values.
The <var>DifferenceToXmlDoc</var> method returns to an <var>[[XmlDoc_class|XmlDoc]]</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.
   
   
==Syntax==
==Syntax==
{{Template:UserStatistics:DifferenceToXmlDoc syntax}}
{{Template:UserStatistics:DifferenceToXmlDoc syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%doc</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 <var class="product">[[Janus SOAP]]</var> <var>XmlDoc</var> object variable to contain the listing of the difference values of the Login statistics. </td></tr>
 
<tr><th>%userStatistics</th>
<tr><th>%userStatistics</th>
<td>A <var>userStatistics</var> object variable. </td></tr>
<td>A <var>userStatistics</var> object variable. </td></tr>
<tr><th>ustatOld</th>
<tr><th>ustatOld</th>
<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStatistics</var>.</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>Zeros</th>
 
<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><var>Zeros</var></th>
<tr><th>AttributeValues</th>
<td>This [[Methods#Named parameters|name required]] argument (<var>Zeros</var>) is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> value that indicates whether differences with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in non-zero values only being included. </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:<p class="output"><DKRD>1107</DKRD></p> is text format, and <p class="output"><DKRD value="1107"/></p> is attribute-value format.  The default value is <code>False</code>, which produces text format. </td></tr>
 
<tr><th>AttributeNames</th>
<tr><th><var>AttributeValues</var></th>
<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: <p class="output"><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format:
<td>This name required argument 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.   
<p>
The default value is <var>False</var>, which produces text format. </p></td></tr>
 
<tr><th><var>AttributeNames</var></th>
<td>This name required argument 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:
<p class="code"><stat name="DKRD">
<p class="code"><stat name="DKRD">
     1107
     1107
</stat>
</stat>
</p>
</p>
The default value is <code>False</code>, which produces element-name format.</td></tr>
The default value is <var>False</var>, 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>
<tr><th><var>NamesToLower</var></th>
<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
</table>
</table>


Line 46: Line 55:
</UserStatisticsDifferences>
</UserStatisticsDifferences>
</nowiki></p>
</nowiki></p>
<li>Using the:
<li>Using the following statement would return all the statistics, including those with a <code>0</code> value:
<p class="code">%doc = %statEnd:differencetoXmlDoc(%statStart)</p>
<p class="code">%doc = %statEnd:differencetoXmlDoc(%statStart)</p>
statement would return all the statistics, including those with a <code>0</code> value.
</ol>
</ol>


==See also==
==See also==
<ul>
<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>[[Difference (UserStatistics function)|Difference]]</var> 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.
 
<li><var>[[DifferenceToString (UserStatistics function)|DifferenceToString]]</var> returns a <var>longstring</var> containing the value differences for all, or all non-zero, Login statistics.
</ul>
</ul>
{{Template:UserStatistics:DifferenceToXmlDoc footer}}
{{Template:UserStatistics:DifferenceToXmlDoc footer}}

Latest revision as of 21:35, 20 November 2012

Login timestamps difference in xml format (UserStatistics class)

The DifferenceToXmlDoc method returns to an XmlDoc 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 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 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 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 following statement would return all the statistics, including those with a 0 value:

    %doc = %statEnd:differencetoXmlDoc(%statStart)

See also

  • Difference returns the value differences between two UserStatistics objects for the Login statistic you specify.
  • DifferenceToString returns 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=13533"