## Uses of Interface
org.appng.api.search.Document

- Packages that use Document
  Package | Description
  --- | ---
  org.appng.api.search | Provides an API to the indexing and searching functionality of appNG
  org.appng.search | Base package for the search component
  org.appng.search.indexer | Types used to provide indexing functionality
  org.appng.search.json | Model classes representing the results of a search
  org.appng.search.searcher | Types used to provide search functionality

- - ### Uses of Document in org.appng.api.search

    Methods in org.appng.api.search that return Document
    Modifier and Type | Method and Description
    --- | ---
    `Document` | DocumentEvent.`getDocument()`

    Constructors in org.appng.api.search with parameters of type Document
    Constructor and Description
    `DocumentEvent(Document document, Observable.Event event)`

  - ### Uses of Document in org.appng.search

    Methods in org.appng.search that return types with arguments of type Document
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Document>` | SearchProvider.`doSearch(Environment env, Site site, Application application, org.apache.lucene.store.Directory directory, String term, String language, String[] parseFields, org.apache.lucene.analysis.Analyzer analyzer, String highlightWith, Map<String,String> parameters)` Performs the actual search

  - ### Uses of Document in org.appng.search.indexer

    Classes in org.appng.search.indexer that implement Document
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SimpleDocument` A basic `Document`-implementation, suitable for most cases.

    Methods in org.appng.search.indexer that return types with arguments of type Document
    Modifier and Type | Method and Description
    --- | ---
    `Observable<Document>` | SimpleDocument.`getObservable()`

    Methods in org.appng.search.indexer with parameters of type Document
    Modifier and Type | Method and Description
    --- | ---
    `int` | SimpleDocument.`compareTo(Document other)`

    Method parameters in org.appng.search.indexer with type arguments of type Document
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SimpleDocument.`addObserver(Observer<? super Document> observer)`
    `boolean` | SimpleDocument.`removeObserver(Observer<? super Document> observer)`
    `void` | SimpleDocument.`setObservable(Observable<Document> observable)`

  - ### Uses of Document in org.appng.search.json

    Methods in org.appng.search.json with parameters of type Document
    Modifier and Type | Method and Description
    --- | ---
    `static Result` | Result.`fromDocument(Document d)`

  - ### Uses of Document in org.appng.search.searcher

    Methods in org.appng.search.searcher that return types with arguments of type Document
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Document>` | StandardSearcher.`doSearch(Environment env, Site site, Application application, org.apache.lucene.store.Directory directory, String term, String language, String[] parseFields, org.apache.lucene.analysis.Analyzer analyzer, String highlightWith, Map<String,String> parameters)`

Copyright © 2011–2023 aiticon GmbH. All rights reserved.