Backend¶

/document¶

• třídy Coords, DocumentSize, Page, PcGts, Point, TextEquiv, TextLine, TextRegion, TextWord
  • struktury objektů používaných na BE buď při načítání XML souborů nebo při vytváření odpovědí pro FE (z nich se vytváří příslušná odpověď jako JSON)

/model¶

• třídy DocumentDetailResponse, DocumentResponse, ResponseMessage, SearchRequest, SearchResponse
  • struktury objektů používaných ke komunikaci s FE

/¶

• třída FulltextSearchApplication - spouštěcí třída BE
  • metoda main - spouštěcí metoda BE
     
• třída IndexController - třída ke komunikaci s FE
  • metoda search - metoda ke zpracování požadavku k vyhledání výrazu z FE, která vrací objekt typu SearchResponse
  • metoda uploadFile - metoda ke zpracování požadavku k nahrání dokumentů do Solru z FE, která vrací objekt typu ResponseMessage
  • metoda listDocuments - metoda ke zpracování požadavku k vypsání všech dokumentů v Solru z FE, která vrací objekt typu DocumentResponse
  • metoda listSingleDocument - metoda ke zpracování požadavku k vrácení specifického dokumentu ze Solru z FE, která vrací objekt typu DocumentDetailResponse
     
• třída SolrService - třída ke komunikaci se Solrem
  • metoda connect - metoda k připojení BE k Solru a vytvoření corů Documents a Files (vytváří se jen pokud ještě neexistují), metoda je volána rovnou při zapnutí BE (v konstruktoru SolrService())
  • metoda createCore - pomocná metoda volaná metodou connect
  • metoda uploadFiles - metoda k nahrání dokumentů do Solru
  • metoda addFiles - pomocná metoda volaná metodou uploadFiles k nahrání dvojic dokumentů do obou cores
  • metoda addToCores - pomocná metoda volaná metodou addFiles k nahrání dvojic dokumentů do obou cores
  • metoda getFieldNamesFromDocumentsCore - metoda k získání všech názvů polí v coru Documents
  • metoda addFieldToDocumentsCore - metoda k přidání pole do core Documents
  • metoda getImageFromFilesCore - metoda k vrácení obrazového dokumentu z core Files
  • metoda search - metoda k provedení vyhledání výrazu a vrácení nalezených výsledků objektem typu SearchResponse
  • metoda addToDocumentsCore - metoda k nahrání dokumentů do core Documents
  • metoda listAllFiles - metoda k výpisu názvů všech dokumentů v Solru
  • metoda listSingleFile - metoda k vrácení specifického dokumentu ze Solru
     
• třída Utils - třída na pomocné funkce
  • metoda generateRandomStringId - metoda k tvorbě random řetězců, která vrací objekt typu String
  • metoda prepareFiles - z přijatých dokumentů vytvoří páry XML+obrázek (JPEG nebo PNG) dle názvu souboru
  • metoda getFieldAttributes - metoda k vrácení parametrů pole
  • metoda getAddTextFieldRequest - metoda k vytvoření požadavku na přidání pole
  • metoda getNotIndexedAddTextFieldRequest - metoda k vytvoření požadavku na přidání pole s parameterem indexed nastaveným na false
  • metoda getFirstAlternative - vrátí první alternativu, kterou vrátil Solr ve spellchecku
     
• třída XMLLoader - třída k načítání souborů XML
  • metoda loadFile - metoda k načítání souborů XML, která vrací objekt typu PcGts
  • třída XMLReaderWithoutNamespace - pomocná třída, sloužící k ignorování namespace při načítání XML souboru