Obsah

• Co je UJO?
• Proč používat architekturu UJO?
• Jak napíšeme třídu objektu UJO?
• XML serializace
• Jak vytvořit JavaBean?
• Podpora komponenty JTable
• Jak na rozšíření?
• Výkon
• Jaké jsou další možnosti využití?
• Referenční aplikace
• Domovská stránka projektu
• Licence
• FAQ

Co je UJO ?

• otevřený kód
• revoluční architektura objektu postavená na dvou rozhraních, která zjednodušuje manipulaci objektů pomocí sestavovacího nástroje aplikace při zachování výborné rychlosti
• výkonná XML serializace
• CSV serializace
• Resource bundle serializace
• podpora komponenty JTable
• objekt si řídí sám dostupnost svých atributů
• property listener je možné implementovat na jednom místě pro všechny property třídy včetně potomků
• podpora JavaBeans
• úsporný zdrojový kód vašich UJO objektů
• kontrola unitovými testy
• malá velikost frameworku bez dalších závislostí

• Key.setValue(Ujo, VALUE) - pro zápis hodnoty do objektu a
• Key.getValue(Ujo) - pro čtení hodnoty.

• MapUjo - snadná implementace pro vývojáře s dostatečným výkonem pro běžné aplikace postavená na objektu HashMap
• ArrayUjo - špičkový výkon objektů je srovnatelný s rychlostí zápisu do JavaBeans, je implementovaný pomocí pole objektů
• BeanUjo - tato implementace mapuje klíče přímo na metody objektu JavaBean pomocí Java reflexe

Proč ?

• snadná serializace objektů do formátů XML PropertyResourceBundle a CSV.
• architektura objektů je obecně vhodná pro strojové zpracování atributů objektu. Příkladem využití může být generická implementace metod equals(), hash() a řady dalších..
• architektura umožňuje vytvořit odkaz na atribut UJO (nikoli jejich hodnot) a celý seznam atributů lze předat do nějaké metody - například ve formátu KeyList. Tuto vlastnost lze využít například pro definici sloupců tabulky, či pro označení sloupců pro řazení seznamu UJO objektů.
• defaultní implementace UJO objektů jsou součástí projektu.
• framework obsahuje připravenou implementaci UjoTableModel pro Swing. Pro jednoduchou vizualizaci UJO objektů není třeba implementovat rozhraní TableModel.
• architektura je vhodná pro stavbu dynamických objektů za běhu aplikace (zatím není implementováno)
• knihovna je velice malá (zabírá kolem 65kB) a je nezávislá na knihovnách třetích stran. Tuto vlastnost lze zhodnotit například v menších aplikacích spustitelných Java Web Start.
• pokud oželíme některé typové kontroly je možné framework přepsat do verze Java SE 1.4.
• četnost využití metod Java reflexe je minimální a v případě potřeby je možné napsat vlastní implementaci UJO objektů bez reflexe.
• pro zápis jednoho atributu postačuje jediný řádek zdrojového kódu, JavaBeans potřebují (při standardním zápisu) řádků 7 (1 field + 3 řádky setter + 3 getter).
• krátká doba učení, jádro projektu tvoří pouze dva základní typy rozhraní (Interface), dále jejich implementace a třídu UjoManager, která poskytuje UJO objektům služby (nejen perzistentní ).
• funkce frameworku je pravidelně kontrolována řadou JUnitových testů.

Jak ?

Kód třídy

import org.ujorm.implementation.map.*;
public class Person extends MapUjo {
 
  public static final Key<Person,String > NAME = newKey("Name", String.class);
  public static final Key<Person,Boolean> MALE = newKey("Male", Boolean.class);
  public static final Key<Person,Double > CASH = newKey("Cash", Double.class);

}

1. Person.writeValue(Key, Object), nebo
2. Key.setValue(person, Object).

import static org.Person.*;
Person person = new Person();

// Writing:
NAME.setValue(person, "Pavel Ponec");
MALE.setValue(person, true);
CASH.setValue(person, 34.5);

// Reading:
String  name = NAME.of(person); // method of() is an alias for MapProperty.getValue()
boolean male = MALE.of(person);
double  cash = CASH.of(person);

import static org.Person.*;
Person person = new Person(); // An extension of MapUjoExt

// Writing:
person.set(NAME, "Pavel Ponec");
person.set(MALE, true);
person.set(CASH, 34.5);

// Reading:
String  name = person.get(NAME);
boolean male = person.get(MALE);
double  cash = person.get(CASH);

• generické datové typy doplňovat i na pravou stranu výrazu podle vzoru levé části výrazu, nebo
• parametr -Xlint:unchecked při kompilaci nezapínat
• třídu označit anotací @SuppressWarnings("unchecked").
  Osobně jsem zvolil tuto možnost, kód se zprůhlední a případné kolize na stejném řádku je možné snadno uhlídat.
• od verze 0.72 je pro tvorbu Property implementovaná typově bezpečná metoda newKey(name, type)

Implementace metody equals()

public boolean equals(Object obj) {
  return UjoManager.getInstanceManager().equals(this, (Ujo) obj );
}

Implementace metody clone()

public Object clone() {
  return UjoManager.getInstanceManager().clone(this, 1, null);
}

Implementace metody hash()

public int hash() {
  return UjoManager.getInstanceManager().getHash(this);
}

XML serializace

 Person person;
...

// Make Serialization:
UjoManagerXML.getInstance().saveXML(writer, person, null, "My Export");

// Make Deserialization:
person = UjoManagerXML.getInstance().parseXML(inputStream, Person.class, "My Import");

<?xml version="1.0" encoding="UTF-8"?>
<body>
  <Name>Pavel Ponec</Name>
  <Male>true</Male>
  <Cash>34.5</Cash>
</body>

List Property

public class Person extends MapUjo { 
  public static final MapProperty    <Person,String> NAME  = newKey("Name", String.class);
  public static final MapPropertyList<Person,Child> CHILDS = newListProperty("Child", Child.class);
}

Zákaz exportu

• typu akce (XML export, Resource Bundle export, ...)
• atributu
• jeho hodnotě
• a případně i na kontextu celé akce

public boolean readAuthorization(int action, Key property, Object value, Object context) {
  switch(action) {
    case ACTION_XML_EXPORT: 
      return property!=NAME;
    default: {
      return super.readAuthorization(action, property, value, context);
    }
  }
}

Zápis XML atributu

• implementovat vlastní řešení metody readAuthorization(...). Pro rozlišení se využívá autorizační test pro akci ACTION_XML_ELEMENT, návratová hodnota FALSE je zpráva pro zápis XML atributu. Příklad použití, ve kterém se property NAME zapisuje jako XML atribut:

  @Override
  public boolean readAuthorization(int action, Key property, Object value, Object context) {
    switch(action) {
      case ACTION_XML_ELEMENT: return property!=NAME; // the NAME will be an attribute of an element
      default: return super.readAuthorization(action, property, value, context);
    }
  }
  

• pokud použiváte některého abstraktního rodiče (MapUjo, ArrayUjo), je možné označit property přímo anotací @XmlAttribute podle vzoru:

  @XmlAttribute
  public static final MapProperty<Ujo,String> NAME = newKey("Name", String.class);
  

  Výchozí implementace metody readAuthorization(...) v rodičovské třídě rozpoznává přiřazenou anotaci a tak mechanismus stále funguje výše popsaným způsobem.

Jak vytvořit JavaBean?

import org.ujorm.implementation.map.*;
public class Person extends MapUjo {

  public static final MapProperty<Person,String>  NAME = newKey("Name", String.class);
  public static final MapProperty<Person,Double> CASH = newKey("Cash", Double.class);
    
  public void setName(String name) {
    NAME.setValue(this, name);
  }
  public String getName() {
    return NAME.getValue(this);
  }
  public void setCash(Integer cash) {
    CASH.setValue(this, cash);
  }
  public Integer getCash() {
    return CASH.getValue(this);
  }
}

Podpora komponenty JTable

// Create a model for all attributes:
UjoTableModel<Person> model = new UjoTableModel(Person.NAME, Person.MALE, Person.BIRTH);
// or simply: ... model = new UjoTableModel(Person.class)
jTable.setModel(model);

// We can set an data optionaly:
List<Person> persons = new ArrayList();
model.setRows(persons);

// Add a row:
model.addRow(new Person());

// Set a value:
model.setValueAt("Prokop", 0, Person.NAME );

// Get the last row of table:
Person person = model.getRowLast();

// Sort the model:
model.sort(true, Person.NAME);

Srovnání s AbstractTableModel

• getColumnName(int column)
• getColumnClass(int column)
• getColumnCount()
• getRowCount()
• getValueAt(int rowIndex, int columnIndex)
• setValueAt(Object value, int rowIndex, int columnIndex)

Jak na rozšíření?

public class PersonExt extends Person {

  public static final MapProperty<PersonExt,Float> WEIGHT = new MapProperty("Weight", Float.class);
  public static final MapProperty<PersonExt,Date>  BORN   = new MapProperty("Born"  , Date.class);

}

Výkon

• počet iterací testu je 5 milionů
• v každé iteraci se vytvoří nová instance UJO objektu,
• zapíšou se hodnoty 10-ti atributů,
• všechny hodnoty se přečtou,
• objekt se uvolní pro Garbage collector a
• zveřejněné výsledky jsou aritmetickým průměrem hodnot ze čtyř pokusů

Serializace UJO objektů z XML je postavena na rychlém SAX parseru, rychlostní testy jsou velice příznivé zejména ve srovnání s rychlostí XML serializace (XMLEncoder, XMLDecoder) implementované v JRE.

• všechny business objekty jsou stejného typu (v rámci jednoho testu)
• každý business objekt obsahuje 11 atributů včetně jednoho rekurzivního typu ArrayList
• celkový počet instancí business objektu 6000
• maximální hloubka zanoření 4 levels
• test byl proveden třídou XmlSpeedTest2 (druhý průchod) ze skupiny JUnit testů
• zveřejněné výsledky jsou aritmetickým průměrem hodnot ze čtyř pokusů

Jak?

Perzistence

• Celou hierarchii UJO objektů lze uložit ve formátu XML pomocí třídy UjoManagerXML. Pro další informaci viz třídu UjoXml .
• UJO objekt lze ukládat ve formátu PropertyResourceBundle.
• UJO objekt bude možné v některé další verzi ukládat ve formátu CSV.
• Použití UJO objektů ve frameworku Cayenne (nástroj pro řešení ORM). Cayenne pracuje s perzistentními třídami podobně, jako implementace MapUjo. Protože perzistentní objekty se tvoří pomocí šablony, lze šablonu snadno upravit tak, aby implementovala rozhraní Ujo.

Servlet

ServletRequest request;
UjoTextable person;
Key personName;
...
person.writeValueString(personName, request.getParameters(personName.getName());

Referenční aplikace

• veškerá persistence je realizovaná pomocí frameworku UJO. V projektu se používá ukládání do formátu XML, parametry se ukládají do formátu Resource Bundle.
• všechny datové modely objektu JTable jsou buď přímo instancí, nebo potomkem UjoTable .
• zajímavá je malá velikost aplikace jWorkSheet, zabírá přibližně 170 kB včetně knihovny UJO.

Kde?

Licence

FAQ

• Q: Seznam objektů Keys je seřazený?
• A: Záleží to na implementaci. Třída ArrayUjo vrací seznam seřazený vždy. Třída MapUjo vrací Keys zpravidla v pořadí ve kterém jsou zapsány ve zdrojovém kódu. Protože však metoda Java reflexe toto pořadí negarantuje, tak v případě, že je chybné pořadí keys může být kritické je doporučeno nějaké řešení na principu ArrayUjo.
• Q: Jaký bude výsledek při čtení hodnot UJO, které nebyly dosud iniciované?
• A: výsledek je závislý na implementaci UJO objektu
• B: Výchozí implementaci (AbstractUjo) vrací defaultní hodnotu z Key.
• Q: Je možné nějak vyčistit Keys cache?
• A: Ano, metodou ve třídě UjoManager.
• Q: Jak lokalizovat názvy keys?
• A: Názvy keys lze použít jako klíč pro vyledání v objektu typu java.util.ResourceBundle
• Q: Jsou někde další příklady použití UJO?
• A: Další příklady najdete kromě aplikace JWorkSheet i v JUnitových testech Ujormu.
• Q: Není zpracování UJO pomalé?
• A: Implementace je velice rychlá, viz kapitola Výkon.

Seznam změn

• 2008/06 - Verze 0.80 přichází s rozhraním UjoExt
• 2007/10 - První veřejná verze 0.70 je uvolněna pod licencí Apache License, Version 2.0.