XBUP - Implementace proudového zpracování

Implementace řeší jak vlastní předávání dat, tak i řízení toku (komunikaci) a transformace jednotlivých typů dat.

• Rozhraní proudových tříd - rozhraní tohoto typu poskytují funkcionalitu pro vlastní přenos dat mezi proudovými třídami a klientem
• Rozhraní řízení datového toku - tato rozhraní umožňují změnit chování datového toku, jako například změna pozice v proudu, či předčasné ukončení proudu.

Základní rozhraní jsou následující:

Rozhraní proudových tříd se liší podle šířky rozhraní, způsobu řízení toku a podpory paralelního zpracování.

Rozhraní pro datové proudy (streams) poskytuje možnost opačného řízení proudu dat a poskytuje oba dva druhy používá především úzké rozhraní. Promě toho může rozhraní podporovat další metody pro řízení toku dat, jako například pohyb v toku na začátek, o zvolený rozsah vpřed či vzad.

• XBInputStream - Vstupní proud s řízením toku příjemcem. Třída implementující toho rozhraní deklaruje, že je schopna generovat události a poskytuje funkci pro postupné získání událostí (pulling). K vstupnímu proudu je k dispozici rozhraní XBInputStreamFilter, které umožňuje provádět filtrování proudu.
   
• XBOutputStream - Výstupní proud s řízení toku odesílatelem. Třída implementující toto rozhraní je schopna pomocí funkce přijímat jednotlivé události. Synchronní varianta dokáže přijímat události od více souběžných proudů najednou. K výstupnímu proudu je k dispozici rozhraní XBOutputStreamFilter, které umožňuje provádět filtrování proudu.
   
• XBStreamable - Rozhraní indikuje metody umožňující serializaci objektu do vstupního i výstupního proudu.
   

K dispozici jsou dále standardní třídy, které umožňují provádět převody mezi různými typy proudu, případně provádět některé druhy transformací nad proudy.

Mezi oběma formami řízení komunikace je možné převádět.

• proud -> události: cyklickým voláním
• události -> proud:

Zpracování vzorem definuje příjem proudu definicí příchozích položek tak, jak by měli přicházet. Zároveň jsou těmito funkcemi vráceny přijaté hodnoty.

• XBStreamChecker - Pro datové proudy poskytuje široké rozhraní pro zpracování vzorem.
   

Následuje několik příkladů možných využití implementovaných tříd a rozhraní.

Proud je možné s výhodou využít například pro serializaci objektů. Pro jednotlivé úrovně protokolu je definováno rozhraní, které zpřístupňuje funkce konverze na datový proud a zpět, které pak umožňuje transformaci vybraných dat protokolu na posloupnost položek tak jak byly definovány v událostech parsování.

Tyto rozhraní jsou následující:

• XBStreamable - deklaruje transformaci do základního kódování bez definice typů bloků. Mělo by vytvořit jediný blok obsahující všechny data o objektu. Má následující přístupové metody:
  
  void WriteToXB(XBOutputStream stream) - metoda pro zápis do proudu
  void ReadFromXB(XBInputStream stream) - metoda pro čtení z proudu
   
• XBLxStreamable - deklaruje transformaci do vyšších úrovní protokolu XBUP, tedy vytváří typovaný blok a napojení na typ dokumentu. Hodnota x odpovídá číslu úrovně. Má tři přístupové metody:
  
  XBTypeBlock getLxBlockType() - Vrací typ bloku
  void WriteToLxXB(XBLxOutputStream stream) - metoda pro zápis do proudu
  void ReadFromLxXB(XBLxInputStream stream) - metoda pro čtení z proudu
   
• XBCLxStreamable - deklaruje transformaci do vyšších úrovní protokolu XBUP s využitím katalogu:
  
  XBTypeBlock getCLxBlockType(XBLxCatalogHandler catalog) - vrací typ kořenového bloku z katalogu
  void WriteToCLxXB(XBLxOutputStream stream, XBLxCatalogHandler catalog) - metoda pro zápis do proudu
  void ReadFromCLxXB(XBLxInputStream stream, XBLxCatalogHandler catalog) - metoda pro čtení z proudu
   
• XBMultiStreamable - definuje více možných způsobů převodu objektu na data v základním tvaru s následujícími přístupovými metodami:
  
  int getXBMCount() - metoda vrací počet možných způsobů zápisu proudu
  void WriteToXBM(XBOutputStream stream, int type) - metoda pro zápis do proudu
  void ReadFromXBM(XBInputStream stream, int type) - metoda pro čtení z proudu
   
• XBLxMultiStreamable - obdoba předchozího rozhraní pro vyšší úrovně, metody jsou obdobné:
  
  int getLxXBMCount() - metoda vrací počet možných způsobů zápisu proudu
  XBTypeBlock getLxBlockType(int type) - Vrací typ bloku
  void WriteToLxXBM(XBLxOutputStream stream, int type) - metoda pro zápis do proudu
  void ReadFromLxXBM(XBLxInputStream stream, int type) - metoda pro čtení z proudu
   

Následující příklad ukazuje možné využití proudu v programovacím jazyce Java pro serializaci textového řetězce. Jde o implementaci v pracovní verzi WR-16:

public class XBString implements XBCL1Streamable {
    
    private String value;

    /** Creates a new instance of XBString */
    public XBString() {
        this.value = "";
    }

    public XBString(String value) {
        this.value = value;
    }

    public XBL1Declaration getXBL1Declaration() {
        throw new UnsupportedOperationException("Not supported yet.");
    }

    /** Serialize object to XBUP Level 1 Stream */
    public void writeXBL1Stream(XBL1OutputStream stream) throws IOException {
        try {
            XBL1Listener listener = XBL1DefaultEventListener.toXBListener(stream);
            listener.beginXBL1(false);
            listener.typeXBL1(new XBCPContextBlock(xbBlockPath));
            listener.attribXBL1(new UBNat32(1)); // Data block pointer
            listener.beginXBL1(false);
            listener.dataXBL1(getValue().getBytes());
            listener.endXBL1();
            listener.endXBL1();
        } catch (XBParseException ex) {
            Logger.getLogger(XBString.class.getName()).log(Level.SEVERE, null, ex);
        }
    }

    /** Serialize object from XBUP Level 1 Stream */
    public void readXBL1Stream(XBL1InputStream stream) throws XBProcessingException {
        try {
            XBL1StreamChecker checker = new XBL1StreamChecker(stream);
            checker.beginXBL1();
            checker.typeXBL1(new XBCPContextBlock(xbBlockPath));
            checker.attribXBL1(new UBNat32(1)); // Data block pointer
            checker.beginXBL1();
            setValue(new String(checker.dataXBL1()));
            checker.endXBL1();
            checker.endXBL1();
        } catch (XBParseException ex) {
            Logger.getLogger(XBString.class.getName()).log(Level.SEVERE, null, ex);
        } catch (IOException ex) {
            Logger.getLogger(XBString.class.getName()).log(Level.SEVERE, null, ex);
        }
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

Seznam zdrojů, literatury a relevantních odkazů.