Package de.elo.mover.main.helper

Class KeywordListHelper

java.lang.Object
de.elo.mover.main.helper.KeywordListHelper
public class KeywordListHelper extends 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 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, String searchTerm)
    Meldet zurück, ob das Stichwort den angegebenen Suchbegriff enthält.
    static boolean
    containsKeywordEntry(de.elo.ix.client.KeywordList keywordList, String searchTerm)
    Meldet zurück, ob die Stichwortliste den angegebenen Suchbegriff enthält.
    static boolean
    deleteKeywords(IXconnect ixConnect, 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 String[]
    getFieldTerms(IXconnect ixConnect, de.elo.ix.client.DocMaskLine docMaskLine, 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, 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, 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 String[]
    parseId(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, 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 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, String keywordId, de.elo.ix.client.KeywordZ keywordZ, int maxCount) throws byps.RemoteException, 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
      Exception

    • getKeywords

      public static de.elo.ix.client.Keyword[] getKeywords(IXconnect ixConnect, String[] keywordIds, de.elo.ix.client.KeywordZ keywordZ, int maxCount, boolean withLock) throws byps.RemoteException, 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
      Exception

    • saveKeywords

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

    • deleteKeywords

      public static boolean deleteKeywords(IXconnect ixConnect, String[] keywordIds) throws byps.RemoteException, 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
      Exception

    • unlockKeyword

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

    • checkoutKeywordsDynamic

      public static ASKeywordsDynamicResult checkoutKeywordsDynamic(IXconnect ixConnect, de.elo.ix.client.KeywordsDynamicInfo keywordsDynamicInfo) throws 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:
      Exception

    • getFieldTerms

      public static String[] getFieldTerms(IXconnect ixConnect, de.elo.ix.client.DocMaskLine docMaskLine, String searchTerm, int maxTerms) throws 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:
      Exception

    • containsKeywordEntry

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

    • containsKeyword

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

    • parseId

      public static String[] parseId(String id) throws 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:
      Exception

    • dumpKeywordList

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

    • sortAlphabetical

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