rest/datatypes

Revision as of 22:50, 31 August 2007 by Tantek (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)

Jump to: navigation, search

Datatypes in HTML

One of the challenges of using HTML as a data transport is that everything, by default, is a string. This page explores ways to use microformats -- specifically, class names -- to encode data type information, e.g., for use with xoxo and rest/ahah, in order to allow lossless import/export from various languages. These could also be used with forms to provide rest/descriptions of the type of data expected.

Contents


Contributors

Examples

These are the primary datatypes in a range of different languages and formats. Note that we are only concerned with "primitive" datatypes (loosely defined), as structured datatypes (list/array, hash/dictionary) are handled by xoxo.

Datatype comparison table
Language/format string float integer boolean data date/time null
XML Schema string float, double decimal, integer, etc. boolean hexBinary, base64Binary duration, dateTime, date, time nil
XML-RPC string double i4, int boolean base64 dateTime.iso8601 nil
Mac OS X plists string real integer true, false data date nil
JSON (JavaScript) string number number true, false N/A Date nil
YAML tags str int float bool null (base 64) N/A null
SQL (JDBC) char,varchar float, double, real decimal, numeric bit binary date, time, timestamp  ?
C char[] float, double int, long, short bool, int char[] N/A (void*)0
Java char, String float, double int, long, short, byte boolean N/A util.Date null
PHP string float (double) integer boolean array N/A NULL
Perl array scalar scalar scalar array N/A
Python str float, complex int, long bool binascii, base64 time,datetime
Ruby + lib String Float Fixnum, Bignum TrueClass,FalseClass Hash Date NilClass
REBOL string! decimal! integer! logic! binary! date!, time! none!

Analysis

The most common set of datatypes appears to be those represented by XML-RPC, which (perhaps fortunately) also has historical precedence on the web:

While not perfect, these certainly cover the 80% case, and are reasonably well-defined. That said, there are a number of open questions about how to use them:

  1. should 'string' also be explicitly specified, or can it be assumed?
    • Assumed, and also defined as utf-8. Kevin Marks 16:39, 13 Feb 2006 (PST)
    • Agreed with Kevin. 'string' should be the default if no type is specified. Publishers MAY explicitly specify 'string'. - Tantek
    • Shouldn't the encoding be that of the page the markup is found on (as specified in the HTTP and HTML specs), rather than defined as utf-8? Jim Ancona
    • Jim, that's a good point, the encoding should be determined by the rules of the containing document ((X)HTML) and protocol (HTTP). - Tantek
  2. does 'int' always mean 32-bits?
    1. If so, what should be used for 64-bit integers or cryptographic (256-bit+) numbers?
      1. Python's 'long' is simple, but ambiguous.
      2. Ruby's BigNum is clear but much less common.
      3. XML-Schema has so many types it is hard to say.
        • In this case, XML-Schema makes the distinction that 'int' represents a standard 32 bit integer, while 'integer' represents a signed integer of arbitrary length.
      4. SQL's "decimal", perhaps?
    2. If not, how should conforming implementations react to longer integers than they can handle?
      • I think integer is fine - we don't have an explict constraint here. Do you want to define +Inf -Inf and NaN behavior? Certainly when building testcases and examples include these.
  1. Is it worth deviating from the standard to allow "dateTime" as an alias? (the one case where XML Schema is actually simpler)
    • See comments below regarding date-time.

Proposal

The proposal is to adopt XML-RPC scalar values as the class names for typed microformats, with the following caveats:

Integers

Date and Time

Binary Data

String

Usage

To indicate that a particular micforomat uses typed values, precede or follow that microformat with the class name typed, as in:

 <ol class=''typed xoxo''>

or

 <ol class=''xoxo typed''>
In other words, this defines what might be called the "
typed
" microformat.

Summary

Example

<ol class="typed xoxo"> # every XOXO must begin with ol or ul
 <li>   
 <dl>  
  <dt>key</dt><dd>value</dd>
  <dt>integer</dt><dd class="int">137</dd>
  <dt>real</dt><dd class="double">3.14159265</dd>
  <dt>date</dt><dd class="datetime">1994-11-05T13:15:30Z</dd>
  <dt>date(abbr)</dt><dd class="datetime"><abbr title="1994-11-05">November 5, 1994</abbr></dd>
  <dt>true</dt><dd class="boolean">1</dd>
  <dt>false</dt><dd class="boolean">0</dd>
  <dt>data</dt><dd class="binary"><a href="data:;base64,sdcfo2JTiXE=" type="image/jpg">my image</a></dd>
 </dl>
 </li>
</ol>

References

See Also

rest/datatypes was last modified: Wednesday, December 31st, 1969

Views