Package de.elo.mover.main.helper

Class KeywordListHelper

java.lang.Object
de.elo.mover.main.helper.KeywordListHelper
public class KeywordListHelper
extends java.lang.Object

Überschrift: KeywordListHelper.

Beschreibung: Hilfsmethoden für die ELO Stichwortlisten.

Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2020

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  KeywordListHelper.KeywordComparator
    Klasse für den Vergleich von Stichwörtern.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.lang.String KWID_GROUP_ORDER_DELIM
    Trennzeichen zwischen Gruppe und Reihenfolge.

  • Constructor Summary

    Constructors
    Constructor Description
    KeywordListHelper()  

  • Method Summary

    Modifier and Type Method Description
    static ASKeywordsDynamicResult checkoutKeywordsDynamic​(IXconnect ixConnect, de.elo.ix.client.KeywordsDynamicInfo keywordsDynamicInfo)
    Liefert eine dynamische Stichwortliste für die angegebenen Kriterien zurück.
    static boolean containsKeyword​(de.elo.ix.client.Keyword keyword, java.lang.String searchTerm)
    Meldet zurück, ob das Stichwort den angegebenen Suchbegriff enthält.
    static boolean containsKeywordEntry​(de.elo.ix.client.KeywordList keywordList, java.lang.String searchTerm)
    Meldet zurück, ob die Stichwortliste den angegebenen Suchbegriff enthält.
    static boolean deleteKeywords​(IXconnect ixConnect, java.lang.String[] keywordIds)
    Löscht die angegebenen Stichwörter und meldet zurück, ob das Löschen erfolgreich war.
    static void dumpKeywordList​(IXconnect ixConnect, de.elo.ix.client.Keyword keyword, int indent)
    Loggt die Einträge der angegebenen Stichwortliste.
    static java.lang.String[] getFieldTerms​(IXconnect ixConnect, de.elo.ix.client.DocMaskLine docMaskLine, java.lang.String searchTerm, int maxTerms)
    Liefert die eingegebenen Suchbegriffe für die angegebene Maskenzeile (F7-Suche) zurück.
    static de.elo.ix.client.KeywordList getKeywordList​(IXconnect ixConnect, java.lang.String keywordId, de.elo.ix.client.KeywordZ keywordZ, int maxCount)
    Lädt die entsprechende Stichwortliste aus dem IndexServer herunter und liefert diese Liste zurück.
    static de.elo.ix.client.Keyword[] getKeywords​(IXconnect ixConnect, java.lang.String[] keywordIds, de.elo.ix.client.KeywordZ keywordZ, int maxCount, boolean withLock)
    Liefert die zugehörigen Stichwörtern( Untereinträge ) zu den angegebenen Stichwörtern zurück.
    static java.lang.String[] parseId​(java.lang.String id)
    Liefert eine Liste mit der Gruppen ID und der Reihenfolge ID zurück.
    static void saveKeywords​(IXconnect ixConnect, de.elo.ix.client.Keyword[] keywordList)
    Speichert die angegebene Liste mit Stichwörtern.
    static void sortAlphabetical​(de.elo.ix.client.KeywordList keywordList)
    Sortiert die angegebene Stichwortliste alphabetisch.
    static void unlockKeyword​(IXconnect ixConnect, java.lang.String keywordId)
    Lock auf eine Stichwortliste aufheben.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • KWID_GROUP_ORDER_DELIM

      public static java.lang.String KWID_GROUP_ORDER_DELIM
      Trennzeichen zwischen Gruppe und Reihenfolge.

  • Constructor Details

    • KeywordListHelper

      public KeywordListHelper()

  • Method Details

    • getKeywordList

      public static de.elo.ix.client.KeywordList getKeywordList​(IXconnect ixConnect, java.lang.String keywordId, de.elo.ix.client.KeywordZ keywordZ, int maxCount) throws byps.RemoteException, java.lang.Exception
      Lädt die entsprechende Stichwortliste aus dem IndexServer herunter und liefert diese Liste zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keywordId - Id der Stichwortliste
      keywordZ - KeywordZ
      maxCount - Maximale Anzahl an zurückgelieferten Stichwörtern
      Returns:
      Stichwortliste
      Throws:
      byps.RemoteException
      java.lang.Exception

    • getKeywords

      public static de.elo.ix.client.Keyword[] getKeywords​(IXconnect ixConnect, java.lang.String[] keywordIds, de.elo.ix.client.KeywordZ keywordZ, int maxCount, boolean withLock) throws byps.RemoteException, java.lang.Exception
      Liefert die zugehörigen Stichwörtern( Untereinträge ) zu den angegebenen Stichwörtern zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keywordIds - Liste mit Stichwort-Ids
      keywordZ - KeywordZ
      maxCount - Maximale Anzahl an auszucheckenden Stichwörtern
      withLock - Stichwortliste sperren
      Returns:
      Liste mit Stichwörtern
      Throws:
      byps.RemoteException
      java.lang.Exception

    • saveKeywords

      public static void saveKeywords​(IXconnect ixConnect, de.elo.ix.client.Keyword[] keywordList) throws byps.RemoteException, java.lang.Exception
      Speichert die angegebene Liste mit Stichwörtern.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keywordList - Liste mit Stichwörtern
      Throws:
      byps.RemoteException
      java.lang.Exception

    • deleteKeywords

      public static boolean deleteKeywords​(IXconnect ixConnect, java.lang.String[] keywordIds) throws byps.RemoteException, java.lang.Exception
      Löscht die angegebenen Stichwörter und meldet zurück, ob das Löschen erfolgreich war.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keywordIds - Liste mit Stichwort-Ids
      Returns:
      Löschen erfolgreich
      Throws:
      byps.RemoteException
      java.lang.Exception

    • unlockKeyword

      public static void unlockKeyword​(IXconnect ixConnect, java.lang.String keywordId) throws byps.RemoteException, java.lang.Exception
      Lock auf eine Stichwortliste aufheben.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keywordId - Id der Stichwortliste
      Throws:
      byps.RemoteException
      java.lang.Exception

    • checkoutKeywordsDynamic

      public static ASKeywordsDynamicResult checkoutKeywordsDynamic​(IXconnect ixConnect, de.elo.ix.client.KeywordsDynamicInfo keywordsDynamicInfo) throws java.lang.Exception
      Liefert eine dynamische Stichwortliste für die angegebenen Kriterien zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keywordsDynamicInfo - Parameter für die dynamische Stichwortliste
      Returns:
      AS-Objekt für die dynamische Stichwortliste
      Throws:
      java.lang.Exception

    • getFieldTerms

      public static java.lang.String[] getFieldTerms​(IXconnect ixConnect, de.elo.ix.client.DocMaskLine docMaskLine, java.lang.String searchTerm, int maxTerms) throws java.lang.Exception
      Liefert die eingegebenen Suchbegriffe für die angegebene Maskenzeile (F7-Suche) zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      docMaskLine - Zeile einer Maske
      searchTerm - Suchbegriff
      maxTerms - Maximale Anzahl der Treffer
      Returns:
      Liste mit den Suchergebnissen
      Throws:
      java.lang.Exception

    • containsKeywordEntry

      public static boolean containsKeywordEntry​(de.elo.ix.client.KeywordList keywordList, java.lang.String searchTerm) throws java.lang.Exception
      Meldet zurück, ob die Stichwortliste den angegebenen Suchbegriff enthält.
      Parameters:
      keywordList - Stichwortliste
      searchTerm - Suchbegriff
      Returns:
      Stichwortliste enthält den Suchbegriff
      Throws:
      java.lang.Exception

    • containsKeyword

      public static boolean containsKeyword​(de.elo.ix.client.Keyword keyword, java.lang.String searchTerm) throws java.lang.Exception
      Meldet zurück, ob das Stichwort den angegebenen Suchbegriff enthält.
      Parameters:
      keyword - Stichwort
      searchTerm - Suchbegriff
      Returns:
      Stichwort enthält den Suchbegriff
      Throws:
      java.lang.Exception

    • parseId

      public static java.lang.String[] parseId​(java.lang.String id) throws java.lang.Exception
      Liefert eine Liste mit der Gruppen ID und der Reihenfolge ID zurück.
      Parameters:
      id - ID
      Returns:
      Liste mit Gruppen ID und Reihenfolge ID
      Throws:
      java.lang.Exception

    • dumpKeywordList

      public static void dumpKeywordList​(IXconnect ixConnect, de.elo.ix.client.Keyword keyword, int indent) throws java.lang.Exception
      Loggt die Einträge der angegebenen Stichwortliste.
      Parameters:
      ixConnect - Indexserver-Verbindung
      keyword - Stichwort
      indent - Anzahl der Leerzeichen vor der Ausgabe
      Throws:
      java.lang.Exception

    • sortAlphabetical

      public static void sortAlphabetical​(de.elo.ix.client.KeywordList keywordList) throws java.lang.Exception
      Sortiert die angegebene Stichwortliste alphabetisch.
      Parameters:
      keywordList - Stichwortliste
      Throws:
      java.lang.Exception