Podręcznik referencyjny: Aplikacje typu Lista

Grupa docelowa

• Programiści aplikacji

Opis

• Zestaw kolumn
• Możliwość konfigurowania
• Wyszukiwanie szczegółowe
• Model programowania
• Aplikacje działające w tle
• Eksport i usługi sieciowe RESTful

Zestaw kolumn

Możliwość konfigurowania

Wyszukiwanie szczegółowe

Model programowania

Wizualizacja

Filtr

Aplikacje działające w tle

• Obiekty wybrane w obszarze roboczym są przenoszone do aplikacji działającej w tle
• Właściwości wyszukiwania wprowadzone w nagłówku aplikacji typu Lista w momencie wywołania akcji są przenoszone do aplikacji działającej w tle, z którą wykonywane jest zapytanie do bazy danych w momencie uruchomienia aplikacji działającej w tle. Wynik tego zapytania może różnić się od tego, które zostało już wykonane w aplikacji. W związku z tym, użytkownik niekoniecznie widział wcześniej wynik wyszukiwania, a liczba obiektów do przetworzenia może nieświadomie skutkować niezamierzonym zakresem.

• Zarówno obiekty wybrane w obszarze roboczym, jak i charakterystyki wyszukiwania z nagłówka listy są przesyłane do aplikacji działającej w tle. W czasie wykonywania aplikacji w tle wykonywane jest zapytanie do bazy danych z funkcjami wyszukiwania, ale w tym przypadku wszystkie obiekty wybrane w obszarze roboczym są pomijane (lista negatywna).

Eksport i usługi sieciowe RESTful

Obiekty deweloperskie

Typy obiektów deweloperskich Search i Search extension

Zakładka From/Where: Zapytanie do bazy danych

com.cisag.app.edu.obj.Book BOOK
  LEFT OUTER JOIN com.cisag.app.general.obj.Partner EMPLOYEE
    ON BOOK:employee = EMPLOYEE:guid

Klucze obce

REMOVABLE JOIN

SELECT BOOK:code
  FROM com.cisag.app.edu.obj.Book BOOK
  REMOVABLE LEFT OUTER JOIN
     com.cisag.app.general.obj.Partner EMPLOYEE
    ON BOOK:employee = EMPLOYEE:guid

SELECT BOOK:code
  FROM com.cisag.app.edu.obj.Book BOOK

Automatyczna optymalizacja

SELECT BOOK:code, EMPLOYEE:number
  FROM com.cisag.app.edu.obj.Book BOOK
    LEFT OUTER JOIN
    com.cisag.app.general.obj.Partner EMPLOYEE
    ON BOOK:employee = EMPLOYEE:guid

SELECT BOOK:code, BOOK:employee
  FROM com.cisag.app.edu.obj.Book BOOK

Partner partner = om.getObject(
      Partner.getPrimaryKey(rs.getGuid(2));
  String number = partner.getNumber();

Zakładka Atrybuty: Zestaw kolumn

Kolumna Nazwa

• Nazwa musi być unikalna w ramach wyszukiwania
• Nazwa służy jako identyfikacja kolumny i jest również używana poza własnym obiektem deweloperskim, np. w interfejsach programowania oraz zapisanych układach i wzorcach wyszukiwania
• Aby móc przenieść wyrażenie filtru do aplikacji typu Lista jako parametr aplikacji, nazwa kolumny musi być używana jako nazwa parametru

Kolumna Wyrażenie

• Odniesienie do atrybutu obiektu biznesowego (składnia: ALIAS:Nazwa atrybutu)
• Wyrażenie obliczane przez bazę danych (patrz rozdział Kolumny obliczane)
• Odniesienie do obiektu biznesowego (patrz rozdział Złożone typy danych)
• Puste, jeśli dotyczy atrybutu wirtualnego (patrz rozdział Pole wyboru: Wirtualnie)

Kolumny obliczane

BO:a - BO:b
BO:a + BO:b + BO:c
SUM(BO:a) - SUM(BO:b)
SUM(BO:a) - BO:b // niedostępne

• Funkcje agregujące często mogą być lepiej obliczane w bazie danych
• Proste obliczenia mogą być wykonywane bez wirtualnych kolumn i nie wymagają specjalnych rendererów
• Kolumny mogą być filtrowane i sortowane w bazie danych (nie dotyczy funkcji agregujących)

• Atrybuty wirtualne i renderery są nadal wymagane dla Special Parts
• Baza danych może dawać inne wyniki dla niektórych operacji niż wyspecjalizowane logiki w Comarch ERP Enterprise (np. reguły uruchamiania)
• Długość wyrażenia jest ograniczona do 100 znaków

Złożone typy danych

Parts lub całe obiekty biznesowe mogą być również zawarte w zestawie kolumn pod następującymi warunkami:

• Do wizualizacji (obszar wyświetlania) wymagany jest odpowiedni FormatFactory lub RendererFactory
• Filtrowanie i sortowanie jest możliwe tylko z dodatkowymi (wirtualnymi) atrybutami (wyjątek: Special parts są oferowane przez system)
• Parts są wybierane w edytorze wyszukiwania jak zwykłe atrybuty
• W przypadku obiektów biznesowych w polu Wyrażenie określa się tylko alias (bez nazwy atrybutu). Pole wyboru Obiekt biznesowy musi być również aktywowane.

Pole wyboru: Wirtualnie

Pole wyboru: Obiekt biznesowy

Pole wyboru: Zaprogramowany filtr

Pole wyboru: Możliwość filtrowania

Pole wyboru: Możliwe sortowanie

Pole wyboru: Możliwy do wyświetlenia

Pole wyboru: Klucz zwrotu

• transfer i dostęp z przetwarzania w tle
• atrybuty do łączenia szczegółowych wyszukiwań
• atrybuty, które są sprawdzane podczas analizy wybranych lub zaznaczonych wierszy

Logiczny typ danych

Zalecenia dotyczące zestawu kolumn

Etykieta

Znacznik usuwania

Zakładka Układy

Zakładka Ustawienia

Hook

Baza danych

• Zestaw kolumn zawiera już jeden lub więcej atrybutów, które razem zapewniają unikalną identyfikację obiektu (np. klucz podstawowy obiektu biznesowego). Te atrybuty oznaczone jako klucz zwrotu w zestawie kolumn są zawsze zawarte w klauzuli SELECT. Ze względu na unikalność klucza zwrotu, żadne zduplikowane obiekty nie mogą wystąpić w wyniku, a dodatkowe DISTINCT tylko niepotrzebnie obciążyłoby bazę danych.
• Jeśli to możliwe, relacje Do-N powinny być zlecane wyszukiwaniom szczegółowym
• W klauzuli SELECT automatycznie uwzględniany jest nie tylko klucz zwrotu, ale także wszystkie właściwości sortowania i grupowania. Wynik zależy zatem również od tego, czy i które kolumny są używane do sortowania i grupowania.

Typ obiektu deweloperskiego Search extension

Typ obiektu deweloperskiego Application

Typ obiektu deweloperskiego Application extension

Typ obiektu deweloperskiego Data description

• Pełna etykieta i pomoc kontekstowa
• FormatFactory
• RendererFactory
• FilterExpressionEditorFactory
• DataDescriptionFilter
• Typ zawartości (dla stringów)

Pełna etykieta i pomoc kontekstowa

Factory

Obiekty biznesowe proxy

Obiekty konfiguracyjne

Obiekty repozytorium

Aktualizacja danych

Interfejsy programowania Java

CisCustomisableCockpit

Metody hook

Dalsze metody

Akcje i przetwarzanie w tle

• były dołączane do przycisku akcji na standardowym pasku przycisków
• bieżące kryteria wyszukiwania i wybór użytkownika były przesyłane jako parametry do aplikacji działającej w tle, a parametry te były używane w aplikacji działającej w tle do iteracji po wybranych obiektach

Rejestrowanie akcji

@Override
protected void postInit() {
  Action action1 = new Action(...);
  Action action2 = new Action(...);
  List<Action> actions = new ArrayList<Action>();
  actions.add(testBatch1Action);
  actions.add(testBatch2Action);
  setExecuteActions(actions);
}

Przekazanie parametrów do aplikacji działającej w tle

protected void performAction(Action action) {
  switch (action.getId());
  case ...
    CisBatchJob batch = ...
    CisParameterList params = getBatchApplicationParameters();
    batch.setParameters(params);
    :
:
}

Zapytanie ResultSet w aplikacji działającej w tle

public CisParameterList run(int action, CisParameterList parms) {
  CisBatchJobSearchStatement stmt =
      om.getBatchJobSearchStatement(parms);
  CisResultSet rs = stmt.execute();
  int position = stmt.getResultPosition("bookGuid");
  try {
    while (rs.next()) {
      byte[] guid = rs.getGuid(position);
        :
    }
  } catch (SQLException ex) {
    throw new RuntimeException(ex);
  } finally {
    rs.close();
  }
:
}

AbstractOrderCockpit

• Baza i pozycje
• Łańcuch dokumentów powiązanych
• Uprawnienia (uprawnienia do treści)
• Znacznik usuwania
• SearchContext
• Wyszukiwanie szczegółowe

• com.cisag.app.sales.cockpit.ui.CustomerProposalCockpitBase
• com.cisag.app.sales.cockpit.ui.CustomerProposalCockpitDetail
• com.cisag.app.purchasing.cockpit.ui.RequestForProposalCockpitBase

SearchView

• Klasa reprezentuje konkretną klasę, która może być również używana bezpośrednio, tj. bez wyprowadzania oddzielnej klasy. Derywacja jest konieczna tylko wtedy, gdy metody takie jak preSearch() mają zostać zmienione.
• Link do powiązanego obiektu deweloperskiego Search jest tworzony przez wywołanie tej metody: init(String searchName)
• Do przypisania tytułu do komponentu można użyć następujących metod: setTitle(String) i setTitleFrom(…)
• Należy użyć następującej metody, aby określić, czy komponent zapewnia zakres zapytań: setAllowFilter(boolean)
• Szczegółowe wyszukiwania nie są oferowane
• Następująca metoda może być użyta do kontrolowania, gdzie przechowywane są widoki (układy) zdefiniowane dla tego komponentu: should.setStorageLocation(StorageLocation)
• Te wartości są dostępne do wyboru:
  • StorageLocation.SEARCH — jest wartością domyślną i oznacza, że widoki są zapisywane w odniesieniu do obiektu deweloperskiego Search. W tym przypadku zapisane widoki są współdzielone przez wszystkie aplikacje typu Lista i SearchViews, które odnoszą się do tego samego obiektu deweloperskiego Search.
  • StorageLocation.APPLICATION. — SearchViews, które są używane jako edytor w aplikacji z konfigurowalnym interfejsem użytkownika, mogą alternatywnie używać wartości StorageLocation.APPLICATION. W takim przypadku widoki są przechowywane jako część odpowiednich widoków aplikacji i są niezależne od innych zastosowań obiektu deweloperskiego Search.

GridSearchSupport

Konfiguracja

Filtrowanie

Wynik wyszukiwania

Wybór

Filtrowanie obiektów

Wartości domyślne

Przykład

@Overwrite
protected void resetFilter() {
  // Inicjalizacja z zapisanymi wartościami
  super.resetFilter();
  GridSearchSupport gss = getGridSearchSupport();
  // Nie zmieniaj już zdefiniowanych wartości
  if (gss.getFilterExpression("partnerNumber") == null) {
    gss.setFilterExpression("partnerNumber",
        StringFilterExpressionList.create(
            "com.cisag.app.edu:CockpitEmployeeNumber.lt", "A*");
  }
}

Manipulowanie zapytaniem do bazy danych

• Zmiana metody preSearch() klasy CisCustomisableCockpit (lub SearchView)
• Implementacja SearchHook

Wyszukiwanie szczegółowe

GridSearchSupport.addDetailSearch(
 String parent, // tylko dla wyszukiwania szczegółowego
 String alias,
 String searchName,
 Action action,
 String[] parentColumnNames,
 String[] detailColumnNames)

Przykład

Action a1 = new Action(0, "com.example.search.DetailAction1");
Action a2 = new Action(0, "com.example.search.DetailAction2");
String[] parentColumnNames = {"guid"};
String[] detailColumnNames = {"parent"};
GridSearchSupport gss = getGridSearchSupport();
gss.addDetailSearch(null, "D1",
 "com.example.search.Detail", a1,
 parentColumnNames, detailColumnNames);
gss.addDetailSearch("D1", "D2",
 "com.example.search.Subdetail", a2,
 parentColumnNames, detailColumnNames); 

Format

public StringBuffer format(Object obj, StringBuffer toAppendTo,
                           FieldPosition pos);
public Object parseObject(String source, ParsePosition pos);

FormatFactory

public Format createFormat(DataDescription dataDescription);

FormatFactoryRegistry

Kolumny wirtualne

public public StringBuffer format(Object value,
    StringBuffer toAppendTo, FieldPosition pos) {
  if (value instanceof Map) {
    Map values = (Map) value;
    Object attr1 = values.get("attr1");
    Object attr2 = values.get("attr2");
    ...
  }
  return toAppendTo;
}

Renderer

RendererFactory

public Renderer createRenderer(byte[] guid,
    DataDescription dataDescription)

RendererFactoryRegistry

TextRenderer

public String getText(Object value);

public class SimpleTextRendererFactory
    implementuje RendererFactory {
  public Renderer createRenderer(byte[] guid,
      DataDescription dataDescription) {
    return new SimpleTextRenderer();
  }
  private class SimpleTextRenderer
      implementuje Renderer.TextRenderer {
    public String getText(Object value) {
      if (value != null) {
        return String.valueOf(value);
      }
      return null;
    }
  }
}

IconRenderer

public Icon getIcon(Object value);

public class DocumentKindRendererFactory
    implementuje RendererFactory {
  private final Icon iconDocument = Icon.getIcon(...);
  private final Icon iconNote = Icon.getIcon(...);
  public Renderer createRenderer(byte[] guid,
      DataDescription dataDescription) {
    return new DocumentKindRenderer();
  }
  private class DocumentKindRenderer
      implementuje Renderer.IconRenderer {
    public Icon getIcon(Object value) {
      if (value != null) {
        switch ((Short) value) {
        case DocumentKinds.DOCUMENT:
          return iconDocument;
        case DocumentKinds.NOTE:
          return iconNote;
        }
      }
      return null;
    }
  }
}

LayeredIconRenderer

public Icon[] getIcons(Object value);

ToolTipRenderer

public Icon[] getIcons(Object value);

URIRenderer

public URI getUri(Object value);

public URI getUri(Object value) {
  if (value != null) {
    CisObject obj = ... // przekonwertuj parametr "value" na CisObject
    BusinessEntityLink link = LinkUtili-ty.createBusinessEntityLink(
        LinkUtility.DEFAULT_FLAGS, env.getDatabaseGuid(), o);
    if (link != null) {
      return URI.create(LinkUtility.toUrlString(link));
    }
  }
  return null;
}

VisualElementRenderer

public VisualElement getVisualElement(Object value);

Kolumny wirtualne

public String getText(Object value) {
  if (value instanceof Map) {
    Map values = (Map) value;
    Object attr1 = values.get("attr1");
    Object attr2 = values.get("attr2");
    ...
    return ...
  }
  return null;
}

FilterExpression

FilterExpressionList

SingleExpression

• EQUALS
• UNEQUAL (<>)
• LESS (<)
• GREATER (>)
•  LESS_EQUAL (<=)
• GREATHER_EQUAL (>=)

RangeExpression

InvalidExpression

StringFilterExpressionList

ByteFilterExpressionList, ShortFilterExpressionList, IntegerFilterExpressionList, LongFilterExpressionList i DecimalFilterExpressionList

• ByteFilterExpressionList
• ShortFilterExpressionList
• IntegerFilterExpressionList
• LongFilterExpressionList
• DecimalFilterExpressionList

FilterExpression expr =
      IntegerFilterExpressionList.create(path, 1);

FilterExpression expr =
      IntegerFilterExpressionList.create(path, 1, 3, 5);

FilterExpression expr =
      IntegerFilterExpressionList.createRange(path, 1, 9);

FilterExpression expr =
      IntegerFilterExpressionList.createRange(path, 1, null);

FilterExpression expr = IntegerFilterExpressionList.create(path,
 IntegerFilterExpressionList.createSingleExpression(
 ExpressionType.UNEQUAL, 0