Public:BWmeta service/Java mapping

From YaddaWiki

Revision as of 08:42, 6 October 2010

History

Three different mappings of BWmeta to Java have been written in the project's lifetime. The following table summarizes the mappings.

Current efforts are focused on replacing the older models (Repo and DeskLight) with the latest one ("Y"). The remainder of this page and all the other pages on BWmeta usage in YADDA assume usage of the "Y" model.

General contracts

Unless explicitly stated in the documentation, every "Y" class has the following properties:

• has a public default constructor.
• every property is protected, but has a public getter and setter.
• getters of String, YLanguage and List properties can never return null. Instead, an empty String, YLanguage.Undetermined or an empty List is returned, respectively.
• for every List<T> property:
  • its getter returns a modifiable List<T>;
  • its getter returns the same reference all the time;
  • its setter accepts any Collection<T> (and copies the contents);
  • there's an adder (which returns this).
• every setter and every list adder returns this, which allows chained setting, e.g.:

new YElement()
    .setId("bwmeta1.element.foo")
    .addName(new YName().setText("Foo").setLanguage(YLanguage.English))
    .addDescription(new YDescription().setText("Lorem ipsum").setLanguage(YLanguage.Latin));

The folowing contracts are to be implemented/verified in the future:

• hashCode() and equals() methods are based on the values of all the properties, i.e., two "Y" objects are equal iff they are of the same type and all their properties are equal.

Rich text support

Starting with BWmeta 2.0.0, support for rich text is introduced for certain fields. By rich text we mean a mixed content of text and tags from namespaces other than bwmeta. For example, the following should be a valid fragment of BWmeta 1.2.1 (assuming that suitable declarations of xhtml and mathml are present):

 <description lang="eng" type="abstract">
     <xhtml:em>Lorem ipsum</xhtml:em> dolor sit amet <mathml:math>[...]</mathml:math>
 </description>

The following fields support rich text:

• name
• description
• tag
• attribute

The change in attribute renders BWmeta 2.0.0 incompatible with BWmeta 1.2.0: The following in BWmeta 1.2.0:

 <attribute key="foo" value="bar"/>

becomes the following in BWmeta 2.0.0:

 <attribute key="foo">
     <value>bar</value>
 </attribute>

This calls for a change in the "Y" model. (...) To be continued.