# Uses of Package
org.appng.api.search

- Packages that use org.appng.api.search
  Package | Description
  --- | ---
  org.appng.api.model | Provides an interface-based view to the domain model of appNG and some very basic interfaces.
  org.appng.api.search | Provides an API to the indexing and searching functionality of appNG
  org.appng.core.model | The non-persistent domain model types.
  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
  org.appng.testsupport | Test-related types

- Classes in org.appng.api.search used by org.appng.api.model
  Class and Description
  Consumer A `Consumer` is aware of several `Producer`s which can be added via the `BlockingQueueAccessor.put(Object)`, `BlockingQueueAccessor.put(Object, long)` and `BlockingQueueAccessor.putWithTimeout(Object, long)` method.
  DocumentEvent A `DocumentEvent` encapsulates a `Document` and an `Observable.Event` associated with this `Document`.
  DocumentProducer A `Producer` that produces `DocumentEvent`s.

- Classes in org.appng.api.search used by org.appng.api.search
  Class and Description
  BlockingQueueAccessor A `BlockingQueue`-based implementation for consumer-producer-scenarios. Note that all available operations are blocking!
  Document A `Document` is tracked by the Lucene searchindex.
  Producer A `Producer` creates a product via the `BlockingQueueAccessor.put(Object)`, `BlockingQueueAccessor.put(Object, long)` and `BlockingQueueAccessor.putWithTimeout(Object, long)` method and offers it to it's (unknown) `Consumer`s via the `BlockingQueueAccessor.get()` , `BlockingQueueAccessor.get(long)` or `BlockingQueueAccessor.getWithTimeout(long)`-method. TODO MM this has nothing to do especially with searching! Design seems overloaded, use a shared single BlockingQueue for communication between consumer and producer!

- Classes in org.appng.api.search used by org.appng.core.model
  Class and Description
  Consumer A `Consumer` is aware of several `Producer`s which can be added via the `BlockingQueueAccessor.put(Object)`, `BlockingQueueAccessor.put(Object, long)` and `BlockingQueueAccessor.putWithTimeout(Object, long)` method.
  DocumentEvent A `DocumentEvent` encapsulates a `Document` and an `Observable.Event` associated with this `Document`.
  DocumentProducer A `Producer` that produces `DocumentEvent`s.

- Classes in org.appng.api.search used by org.appng.search
  Class and Description
  Document A `Document` is tracked by the Lucene searchindex.
  DocumentProducer A `Producer` that produces `DocumentEvent`s.

- Classes in org.appng.api.search used by org.appng.search.indexer
  Class and Description
  BlockingQueueAccessor A `BlockingQueue`-based implementation for consumer-producer-scenarios. Note that all available operations are blocking!
  Consumer A `Consumer` is aware of several `Producer`s which can be added via the `BlockingQueueAccessor.put(Object)`, `BlockingQueueAccessor.put(Object, long)` and `BlockingQueueAccessor.putWithTimeout(Object, long)` method.
  Document A `Document` is tracked by the Lucene searchindex.
  DocumentEvent A `DocumentEvent` encapsulates a `Document` and an `Observable.Event` associated with this `Document`.
  DocumentProducer A `Producer` that produces `DocumentEvent`s.

- Classes in org.appng.api.search used by org.appng.search.json
  Class and Description
  Document A `Document` is tracked by the Lucene searchindex.

- Classes in org.appng.api.search used by org.appng.search.searcher
  Class and Description
  Document A `Document` is tracked by the Lucene searchindex.

- Classes in org.appng.api.search used by org.appng.testsupport
  Class and Description
  Consumer A `Consumer` is aware of several `Producer`s which can be added via the `BlockingQueueAccessor.put(Object)`, `BlockingQueueAccessor.put(Object, long)` and `BlockingQueueAccessor.putWithTimeout(Object, long)` method.
  DocumentEvent A `DocumentEvent` encapsulates a `Document` and an `Observable.Event` associated with this `Document`.
  DocumentProducer A `Producer` that produces `DocumentEvent`s.

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