|
Carrot2 Framework
API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.carrot2.webapp.Broadcaster
final class Broadcaster
Broadcaster and synchronization point for threads utilizing
RawDocuments from a single input.
| Constructor Summary | |
|---|---|
Broadcaster()
Creates an initially empty broadcaster, ready to accept new documents on broadcastDocument(RawDocument). |
|
Broadcaster(SearchResults results)
Creates a fixed broadcaster which contains all search results from the beginning. |
|
| Method Summary | |
|---|---|
void |
attach()
|
void |
broadcastDocument(RawDocument doc)
|
void |
detach()
|
Iterator |
docIterator()
|
void |
endProcessing()
|
void |
endProcessingWithError(Exception e)
|
List |
getDocuments()
|
boolean |
inUse()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Broadcaster()
broadcastDocument(RawDocument).
public Broadcaster(SearchResults results)
| Method Detail |
|---|
public final void broadcastDocument(RawDocument doc)
throws ProcessingException
ProcessingExceptionpublic void endProcessing()
public void attach()
public void detach()
public boolean inUse()
public Iterator docIterator()
public List getDocuments()
public void endProcessingWithError(Exception e)
|
Please refer to project documentation at
http://project.carrot2.org |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||