Package de.elo.mover.main.helper

Class SearchHelper

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

Überschrift: SearchHelper.

Beschreibung: Hilfsklasse für die Such-Funktionalität.

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

  • Constructor Summary

    Constructors 
    Constructor Description
    SearchHelper()  

  • Method Summary

    Modifier and Type Method Description
    static de.elo.ix.client.FindByIndex createFindByDate​(java.lang.String isoDate)
    Erzeugt ein "FindByIndex"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindByFulltext createFindByFulltext​(java.lang.String searchTerm)
    Erzeugt ein "FindByFulltext"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindByIndex createFindByIndex()
    Erzeugt ein leeres "FindByIndex"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindByIndex createFindByName​(java.lang.String searchTerm)
    Erzeugt ein "FindByIndex"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindByNotes createFindByNotes​(java.lang.String searchTerm)
    Erzeugt ein "FindByNotes"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindByNotes createFindByNotes​(java.lang.String searchTerm, int type)
    Erzeugt ein "FindByNotes"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindByVersion createFindByVersion​(java.lang.String versionNr, java.lang.String versionComment, java.lang.String versionMD5, boolean workVersionOnly)
    Erzeugt ein "FindByVersion"-Objekt mit den angegebenen Daten.
    static de.elo.ix.client.FindDirect createFindDirect​(java.lang.String searchTerm, boolean searchInFulltext, boolean searchInIndex, boolean searchInMemo, boolean searchInSordName, boolean searchInNotes, boolean searchInVersions)
    Erzeugt das "FindDirect"-Objekt und liefert das Objekt zurück.
    static de.elo.ix.client.FindInfo createFindInfoByChildren​(int parentId, boolean inclDelElements)
    Erzeugt ein "FindInfo"-Objekt, das für die Suche nach Untereinträgen verwendet wird.
    static de.elo.ix.client.FindInfo createFindInfoByDate​(java.lang.String isoDate)
    Erzeugt ein "FindInfo"-Objekt, das für die Suche nach dem angegebenen Datum benötigt wird.
    static de.elo.ix.client.FindInfo createFindInfoByFulltext​(java.lang.String searchTerm, java.lang.String searchMask)
    Erzeugt ein "FindInfo"-Objekt für die Volltextsuche und liefert das Objekt zurück.
    static de.elo.ix.client.FindInfo createFindInfoByLinks​(int objId)
    Erzeugt ein "FindInfo"-Objekt für die Suche nach Links.
    static de.elo.ix.client.FindInfo createFindInfoByName​(java.lang.String searchTerm)
    Erzeugt ein "FindInfo"-Objekt für die Suche nach einem Dateinamen und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindInfo createFindInfoByNotes​(java.lang.String searchTerm, int type)
    Erzeugt ein "FindInfo"-Objekt, das für die Suche nach Randnotizen benötigt wird.
    static de.elo.ix.client.FindInfo createFindInfoByObjIds​(int[] objIds)
    Erzeugt ein "FindInfo"-Objekt für die Suche nach mehreren Objekt-IDs.
    static de.elo.ix.client.FindInfo createFindInfoByPreview​(boolean prevAvail, boolean prevError)
    Erzeugt ein "FindInfo"-Objekt für die Suche nach Dokumenten mit einer Dokumentenvorschau.
    static de.elo.ix.client.FindInfo createFindInfoBySordHist​(de.elo.ix.client.SordHistKey[] sordHistKeys)
    Erzeugt ein "FindInfo"-Objekt für die Suche in den Metadaten.
    static de.elo.ix.client.FindOptions createFindOptions()
    Erzeugt ein "FindOptions"-Objekt und liefert dieses Objekt zurück.
    static de.elo.ix.client.FindResult createFindResult​(java.lang.String[] objIds, java.util.List<de.elo.ix.client.Sord> sords)
    Erzeugt ein Suchergebnis, welches die angegebenen Objekte enthält.
    static de.elo.ix.client.FindUserInfo createFindUserInfo​(java.lang.String name, java.lang.String descr, int[] userIds, boolean onlyUsers, boolean onlyGroups, boolean returnUserInfoMap)
    Erzeugt ein "FindUserInfo"-Objekt mit den angegebenen Daten.
    static java.util.ArrayList<de.elo.ix.client.Sord> doSearch​(IXconnect ixConnect, de.elo.ix.client.FindInfo findInfo)
    Führt eine Suche für die angegebenen Suchkriterien aus.
    static de.elo.ix.client.ContextTerm[] getContextTerms​(IXconnect ixConnect, java.lang.String searchTerm, int maxResults)
    Liefert die Kontextoren für den angegebenen Suchbegriff zurück.
    static de.elo.ix.client.ObjKey[] getObjKeys​(org.json.JSONArray jsonArray)
    Erzeugt eine Liste mit Zeilen und liefert die Liste zurück.
    static java.lang.String replaceOR​(java.lang.String query)
    Ein Komma durch OR ersetzen, wenn es nicht Teil einer Phrase ist.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • createFindByFulltext

      public static de.elo.ix.client.FindByFulltext createFindByFulltext​(java.lang.String searchTerm) throws java.lang.Exception
      Erzeugt ein "FindByFulltext"-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      Returns:
      "FindByFulltext"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoByFulltext

      public static de.elo.ix.client.FindInfo createFindInfoByFulltext​(java.lang.String searchTerm, java.lang.String searchMask) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt für die Volltextsuche und liefert das Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      searchMask - Suchmaske
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindOptions

      public static de.elo.ix.client.FindOptions createFindOptions()
      Erzeugt ein "FindOptions"-Objekt und liefert dieses Objekt zurück.
      Returns:
      "FindOptions"-Objekt

    • createFindDirect

      public static de.elo.ix.client.FindDirect createFindDirect​(java.lang.String searchTerm, boolean searchInFulltext, boolean searchInIndex, boolean searchInMemo, boolean searchInSordName, boolean searchInNotes, boolean searchInVersions) throws java.lang.Exception
      Erzeugt das "FindDirect"-Objekt und liefert das Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      searchInFulltext - Suche im Volltext
      searchInIndex - Suche in den Feldern
      searchInMemo - Suche im Zusatztext
      searchInSordName - Suche in der Bezeichnung
      searchInNotes - Notizen durchsuchen
      searchInVersions - Suche in Versionskommentar und Versionsnummer
      Returns:
      "FindDirect"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoByName

      public static de.elo.ix.client.FindInfo createFindInfoByName​(java.lang.String searchTerm) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt für die Suche nach einem Dateinamen und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindByName

      public static de.elo.ix.client.FindByIndex createFindByName​(java.lang.String searchTerm) throws java.lang.Exception
      Erzeugt ein "FindByIndex"-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      Returns:
      "FindByIndex"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoByDate

      public static de.elo.ix.client.FindInfo createFindInfoByDate​(java.lang.String isoDate)
      Erzeugt ein "FindInfo"-Objekt, das für die Suche nach dem angegebenen Datum benötigt wird.
      Parameters:
      isoDate - Iso-Datum
      Returns:
      "FindInfo"-Objekt

    • createFindByDate

      public static de.elo.ix.client.FindByIndex createFindByDate​(java.lang.String isoDate)
      Erzeugt ein "FindByIndex"-Objekt und liefert dieses Objekt zurück.
      Parameters:
      isoDate - Iso-Datum
      Returns:
      "FindByIndex"-Objekt

    • createFindInfoByNotes

      public static de.elo.ix.client.FindInfo createFindInfoByNotes​(java.lang.String searchTerm, int type) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt, das für die Suche nach Randnotizen benötigt wird.
      Parameters:
      searchTerm - Suchbegriff
      type - Notiztyp
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindByIndex

      public static de.elo.ix.client.FindByIndex createFindByIndex()
      Erzeugt ein leeres "FindByIndex"-Objekt und liefert dieses Objekt zurück.
      Returns:
      "FindByIndex"-Objekt

    • createFindByNotes

      public static de.elo.ix.client.FindByNotes createFindByNotes​(java.lang.String searchTerm) throws java.lang.Exception
      Erzeugt ein "FindByNotes"-Objekt und liefert dieses Objekt zurück. Mit diesem Objekt wird in allen Typen von Notizen gesucht.
      Parameters:
      searchTerm - Suchbegriff
      Returns:
      "FindByNotes"-Objekt
      Throws:
      java.lang.Exception

    • createFindByNotes

      public static de.elo.ix.client.FindByNotes createFindByNotes​(java.lang.String searchTerm, int type) throws java.lang.Exception
      Erzeugt ein "FindByNotes"-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      type - Notiztyp
      Returns:
      "FindByNotes"-Objekt
      Throws:
      java.lang.Exception

    • createFindByVersion

      public static de.elo.ix.client.FindByVersion createFindByVersion​(java.lang.String versionNr, java.lang.String versionComment, java.lang.String versionMD5, boolean workVersionOnly) throws java.lang.Exception
      Erzeugt ein "FindByVersion"-Objekt mit den angegebenen Daten.
      Parameters:
      versionNr - Versionsnummer
      versionComment - Versionskommentar
      versionMD5 - MD5 Wert der Version
      workVersionOnly - Nur Arbeitsversion durchsuchen
      Returns:
      "FindByVersion"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoByChildren

      public static de.elo.ix.client.FindInfo createFindInfoByChildren​(int parentId, boolean inclDelElements) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt, das für die Suche nach Untereinträgen verwendet wird.
      Parameters:
      parentId - ID des übergeordneten Eintrags
      inclDelElements - Inklusive gelöschte Einträge
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoByObjIds

      public static de.elo.ix.client.FindInfo createFindInfoByObjIds​(int[] objIds) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt für die Suche nach mehreren Objekt-IDs.
      Parameters:
      objIds - Liste mit Objekt-IDs
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoBySordHist

      public static de.elo.ix.client.FindInfo createFindInfoBySordHist​(de.elo.ix.client.SordHistKey[] sordHistKeys) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt für die Suche in den Metadaten.
      Parameters:
      sordHistKeys - Liste mit Metadatenversionen
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindInfoByPreview

      public static de.elo.ix.client.FindInfo createFindInfoByPreview​(boolean prevAvail, boolean prevError)
      Erzeugt ein "FindInfo"-Objekt für die Suche nach Dokumenten mit einer Dokumentenvorschau.
      Parameters:
      prevAvail - Vorschaudokument vorhanden
      prevError - Vorschaufehler vorhanden
      Returns:
      "FindInfo"-Objekt

    • createFindInfoByLinks

      public static de.elo.ix.client.FindInfo createFindInfoByLinks​(int objId) throws java.lang.Exception
      Erzeugt ein "FindInfo"-Objekt für die Suche nach Links.
      Parameters:
      objId - Objekt-ID des Eintrags
      Returns:
      "FindInfo"-Objekt
      Throws:
      java.lang.Exception

    • createFindUserInfo

      public static de.elo.ix.client.FindUserInfo createFindUserInfo​(java.lang.String name, java.lang.String descr, int[] userIds, boolean onlyUsers, boolean onlyGroups, boolean returnUserInfoMap)
      Erzeugt ein "FindUserInfo"-Objekt mit den angegebenen Daten.
      Parameters:
      name - Benutzernamen
      descr - Benutzerbeschreibung
      userIds - Liste mit Benutzer-IDs
      onlyUsers - Nur Benutzer
      onlyGroups - Nur Gruppen
      returnUserInfoMap - Alle Benutzerinformationen liefern
      Returns:
      "FindUserInfo"-Objekt

    • createFindResult

      public static de.elo.ix.client.FindResult createFindResult​(java.lang.String[] objIds, java.util.List<de.elo.ix.client.Sord> sords) throws java.lang.Exception
      Erzeugt ein Suchergebnis, welches die angegebenen Objekte enthält.
      Parameters:
      objIds - Liste mit Objekt-IDs
      sords - Liste mit Einträgen
      Returns:
      "FindResult"-Objekt
      Throws:
      java.lang.Exception

    • doSearch

      public static java.util.ArrayList<de.elo.ix.client.Sord> doSearch​(IXconnect ixConnect, de.elo.ix.client.FindInfo findInfo) throws java.lang.Exception
      Führt eine Suche für die angegebenen Suchkriterien aus.
      Parameters:
      ixConnect - Indexserver-Verbindung
      findInfo - Suchkriterien
      Returns:
      Liste mit Einträgen
      Throws:
      java.lang.Exception

    • replaceOR

      public static java.lang.String replaceOR​(java.lang.String query) throws java.lang.Exception
      Ein Komma durch OR ersetzen, wenn es nicht Teil einer Phrase ist.
      Parameters:
      query - Suchabfrage
      Returns:
      Umgewandelter String
      Throws:
      java.lang.Exception

    • getContextTerms

      public static de.elo.ix.client.ContextTerm[] getContextTerms​(IXconnect ixConnect, java.lang.String searchTerm, int maxResults) throws java.lang.Exception
      Liefert die Kontextoren für den angegebenen Suchbegriff zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      searchTerm - Suchbegriff
      maxResults - maximale Anzahl an Treffern
      Returns:
      Liste mit Kontextoren
      Throws:
      java.lang.Exception

    • getObjKeys

      public static de.elo.ix.client.ObjKey[] getObjKeys​(org.json.JSONArray jsonArray) throws java.lang.Exception
      Erzeugt eine Liste mit Zeilen und liefert die Liste zurück.
      Parameters:
      jsonArray - JSONArray
      Returns:
      Liste mit Zeilen
      Throws:
      java.lang.Exception