calculator_contract

The contract between the framework Unicorn and an observer is composed of two files located on observer side :

• observer.wadl
• observer.rdf

To learn more : http://www.w3.org/QA/Tools/Unicorn/contract/

Table of Contents observer.wadl full source of observer.wadl Explanation observer.rdf

observer.wadl

An xml file which has to be validated by the schema [wiki:observer-response.xsd]. This file tells to Unicorn

• what are possible input methods of the observer (input by URI?, by text? or by file?)
• what are possible parameters for each input method
• what is the type of the parameters

Some examples:

• appc-checker.wadl
• css-validator.wadl
• markup-validator.wadl

This contract usually has 2 main parts:

<application>
  <grammars>
    <xs:schema>   
       ...
       Part 1: Declaration of types
       ...
    </xs:schema>
  </grammars>

  <resources>
    ...
      Part 2: Declaration of possible input methods and possible parameters for each method
    ...
  </resources>
</application>

full source of observer.wadl

<?xml version="1.0"  encoding="utf-8"?>

<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://research.sun.com/wadl wadl.xsd"
      xmlns="http://research.sun.com/wadl"
      xmlns:xs="http://www.w3.org/2001/XMLSchema"
      xmlns:uco="http://www.w3.org/unicorn/observationresponse">
    
    <xs:schema>
      <xs:element name="tX2">
        <xs:complexType>
        <xs:choice>
          <xs:element name="0" />
          <xs:element name="1" />
         </xs:choice>
        </xs:complextype>
      </xs:element>
    </xs:schema>
  
    <resources base="http://localhost/">
      <resource uri="calculator.php">
        <method name="GET" id="CalculatorGET">
          <request>
            <query_variable name="uri" />
            <query_variable name="x2" type="tX2"/>
            <query_variable name="xn"/>
          </request>
        </method>
      </resource>
    </resources>
</application>

Explanation

• The first part defines a complex type tX2. A tX2 type can take only two values, 0 or 1.
• Inside <resources>..&lt;/ressources&gt;</resources> tags, we define several ressources of our observer. In our case, we have just one resource, calculator.php, based on !http://localhost/ (Full path of our observer will be !http://localhost/calculator.php).
• Our observer have only one input method (read from an URI), so we have to define the only one entry <method>..</method>

 There are two attributes for the tag <method></method> : 

• • • name : GET or POST.
    • id : method's key name. We'll use this id in observer.rdf.

 This input method takes 3 parameters (of which two are optional).
     * uri : path of a file which contains some simple arithmetic operations (notype define).
     * x2 : (optional) it's a complex type to multiply results by 2 (which is declared in the first part). 
     * xn : (optional) to multiply results by n.

---

observer.rdf

This file contains all localized information, lists of mimetypes handled by each method of the observer and information about input parameter handle by the observer. This file has an ucn:Observer element which contains :

    * A rdf:ID attribute as reference to the WADL file.
    * Zero or more ucn:name elements as the name of the observer in different language.
    * Zero or more ucn:description element to describe the observer in different language.
    * Zero or more ucn:help element, link to a help page about the observer in different language.
    * One or more ucn:inputMethod containing the exactly one ucn:Parameter itself containing One or more ucn:mimetype elements to define each mimetype handled by the method.

In our case we have just one method, CalculatorGET, which takes an uri containing text. So the mimetype will be text/plain.

&lt&#59;rdf&#58&#59;RDF
	xmlns&#58&#59;rdf&#61&#59;&quot&#59;&amp&#59;rdf&#59&#59;&#35&#59;&quot&#59;
	xmlns&#58&#59;rdfs&#61&#59;&quot&#59;&amp&#59;rdfs&#59&#59;&#35&#59;&quot&#59;
	xmlns&#58&#59;ucn&#61&#59;&quot&#59;&amp&#59;ucn&#59&#59;&#35&#59;&quot&#59;
	xmlns&#61&#59;&quot&#59;&amp&#59;ucn&#59&#59;&#35&#59;&quot&#59;
	xml&#58&#59;base&#61&#59;&quot&#59;&amp&#59;ucn&#59&#59;&quot&#59;
	&gt&#59;

	&lt&#59;ucn&#58&#59;Observer ucn&#58&#59;id&#61&#59;&quot&#59;calculator&quot&#59; ucn&#58&#59;reference&#61&#59;&quot&#59;calculator&quot&#59;&gt&#59;
	
		&lt&#59;ucn&#58&#59;name xml&#58&#59;lang&#61&#59;&quot&#59;en&quot&#59;&gt&#59;Calculator&lt&#59;/ucn:name&gt&#59;
		&lt&#59;ucn&#58&#59;name xml&#58&#59;lang&#61&#59;&quot&#59;fr&quot&#59;&gt&#59;Calculatrice&lt&#59;/ucn:name&gt&#59;
		&lt&#59;ucn&#58&#59;description xml&#58&#59;lang&#61&#59;&quot&#59;en&quot&#59;&gt&#59;An observer who evaluates simple arithmetic operations.&lt&#59;/ucn:description&gt&#59;
		&lt&#59;ucn&#58&#59;description xml&#58&#59;lang&#61&#59;&quot&#59;fr&quot&#59;&gt&#59;Un observateur qui évalue des opérations arithmétiques.&lt&#59;/ucn:description&gt&#59;
		
		&lt&#59;ucn&#58&#59;inputMethod&gt&#59;
			&lt&#59;ucn&#58&#59;ParameterURI ucn&#58&#59;methodName&#61&#59;&quot&#59;CalculatorGET&quot&#59; ucn&#58&#59;parameterName&#61&#59;&quot&#59;uri&quot&#59;&gt&#59;
   		            &lt&#59;ucn&#58&#59;mimetype&gt&#59;text/plain&lt&#59;/ucn:mimetype&gt&#59;
			&lt&#59;/ucn:parameteruri&gt&#59;
		&lt&#59;/ucn:inputmethod&gt&#59;

	&lt&#59;/ucn:observer&gt&#59;

&lt&#59;/rdf:rdf&gt&#59;