Public:BWmeta service/Java mapping

From YaddaWiki

(Difference between revisions)
Jump to: navigation, search
(→History)
Line 41: Line 41:
<!-- * Only the following property types are present: a primitive type, a String, another "Y" object, a List of Strings or "Y" objects. -->
<!-- * Only the following property types are present: a primitive type, a String, another "Y" object, a List of Strings or "Y" objects. -->
 +
 +
== Rich text support ==
 +
 +
Starting with BWmeta 1.2.1, support for rich text is planned for certain fields.
 +
For example, the following should be a valid fragment of BWmeta 1.2.1:
 +
  <'''bwmeta:description''' lang="eng" type="abstract">
 +
      <'''xhtml:em'''>Lorem ipsum</'''xhtml:em'''> dolor sit amet <'''mathml:math'''>[...]</'''mathml:math'''>
 +
  </'''bwmeta:description'''>
 +
 +
...

Revision as of 12:53, 5 October 2010

Service details
NameBWmeta
Code location
(relative to SVN root)		projects/dir/bwmeta-core
Javadoc
Contact personJakub Jurkiewicz

History

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

Model Name Works with
BWmeta versions 		Usage areas Comments
Repo model 1.0.0 ÷ 1.0.5 Processes, YaddaWeb Hibernate-oriented
DeskLight model 1.0.0 ÷ 1.0.5 DeskLight
"Y" model 1.2.0 ÷ 1.2.1 Pack Management

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 1.2.1, support for rich text is planned for certain fields. For example, the following should be a valid fragment of BWmeta 1.2.1: 

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

...

Retrieved from "https://wiki.yadda.icm.edu.pl/yadda/Public:BWmeta_service/Java_mapping"
Personal tools