Zoe XML-RPC Specification Docs

Note: I copied these from Paul Scott Murphy's Java documentation, primarily so I could have some readable docs and so I could point to these for others to work with. Just to be clear, these are Paul's docs.

Creating a Specification

A SpecificationFactory is used to create instances of an {@link alt.dev.szobject.SZSpecification SZSpecification} object from the Java object mapping of an XML-RPC request.

This mapping is as follows:

A specification is an XML-RPC <struct> containing two members:

• A <string> called "class" that indicates the class of object to be returned by searches with this specification,
• And a <struct> called "qualifier" that contains a qualifier.

A qualifier is an XML-RPC <struct> containing two members:

• A <string> called "type" that indicates the type of qualifier. Its value can be one of:
  • "keyvalue",
  • "keycomparison",
  • "and",
  • "or", or
  • "not", and
• A member called "details" that contains the qualifier's details. This member's type differs depending on the type member of the qualifier.

A keyvalue qualifier's details is an XML-RPC <struct> containing three members:

• A <string> called "key" that indicates the object key for while a value is being operated on,
• A <string> called "operator" that can be one of:
  • "caseInsensitiveLike",
  • "contains",
  • "equal",
  • "greaterThan",
  • "greaterThanOrEqualTo",
  • "lessThan",
  • "lessThanOrEqualTo",
  • "like", or
  • "notEqual",
• And either:
  • A <string> value,
  • A <string> object url, or
  • A <dateTime.iso8601>.
  In each case, this element is given the name "value".

A keycomparison qualifier's details is an XML-RPC <struct> containing three members:

• A <string> called "leftKey",
• A <string> called "operator" that can be one of the same operators as listed for the keyvalue qualifier details, and
• A <string> called "rightKey".

An and qualifier's details is an XML-RPC <array> containing any number of qualifier values.

An or qualifier's details is an XML-RPC <array> containing any number of qualifier values.

A not qualifier's details is an XML-RPC <struct> containing a single qualifier member.

A user should create an instance of this class for a particular target class from a particular store, and pass the {@link java.util.Hashtable Hashtable} representation of an XML-RPC specification structure to the {@link #generate(Hashtable) generate} method.

@author Paul Scott-Murphy @version 0.1