Uses of Interface
org.corpus_tools.pepper.modules.DocumentController

Packages that use DocumentController

Package	Description
org.corpus_tools.pepper.core
org.corpus_tools.pepper.impl
org.corpus_tools.pepper.modules

Uses of DocumentController in org.corpus_tools.pepper.core

Classes in org.corpus_tools.pepper.core that implement DocumentController

Modifier and Type	Class	Description
class	DocumentControllerImpl	Stores the global status of a SDocument.

Fields in org.corpus_tools.pepper.core with type parameters of type DocumentController

Modifier and Type	Field	Description
protected Hashtable<String,ConcurrentLinkedQueue<DocumentController>>	DocumentBus.documentBus	This table is the central management object of the DocumentBus.
protected List<DocumentController>	PepperJobImpl.documentControllers	A list of all DocumentControllerImpl objects corresponding to each SDocument belonging to this job.

Methods in org.corpus_tools.pepper.core that return DocumentController

Modifier and Type	Method	Description
DocumentController	ModuleControllerImpl.next()	Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.
DocumentController	ModuleControllerImpl.next(boolean ignorePermissionForDocument)	{@inheritDoc ModuleController#next(boolean)}
DocumentController	DocumentBus.pop(String outputControllerId)	Returns a DocumentController object, which is on first place of the internal queue (regarding the FIFO principle).
DocumentController	DocumentBus.pop(String outputControllerId, boolean ignorePermissionForDocument)	Returns a DocumentController object, which is on first place of the internal queue (regarding the FIFO principle).
DocumentController	TerminalDocumentBus.pop(String outputControllerId)	Returns a DocumentController object, which is on first place of the internal queue (regarding the FIFO principle).
DocumentController	TerminalDocumentBus.pop(String outputControllerId, boolean ignorePermissionForDocument)

Methods in org.corpus_tools.pepper.core that return types with arguments of type DocumentController

Modifier and Type	Method	Description
Set<DocumentController>	PepperJobImpl.getActiveDocuments()	Returns a set of all currently active documents.
Hashtable<String,ConcurrentLinkedQueue<DocumentController>>	DocumentBus.getDocumentBus()	Returns the table, which is the central management object of the DocumentBus.
List<DocumentController>	PepperJobImpl.getDocumentControllers()	Returns a list of all DocumentControllerImpl objects corresponding to each SDocument belonging to this job.

Methods in org.corpus_tools.pepper.core with parameters of type DocumentController

Modifier and Type	Method	Description
void	ModuleControllerImpl.complete(DocumentController documentController)	Adds the given DocumentController to the output document bus to be processed by the next PepperModule objects.
void	ModuleControllerImpl.delete(DocumentController documentController)	Notifies the Pepper framework, that the SDocument being contained in passed DocumentController shall not be processed any further by following Pepper modules.
boolean	PepperJobImpl.getPermissionForProcessDoument(DocumentController controller)	Returns true, if a SDocument or more precisely spoken a SDocumentGraph could be woken up or imported.
void	DocumentBus.put(DocumentController documentController)	Adds the given DocumentController object to the queue.
void	InitialDocumentBus.put(DocumentController documentController)	Adds the given DocumentController object to the queue.
void	PepperJobImpl.releaseDocument(DocumentController controller)	Releases a document and reduces the internal counter for the number of currently processed documents (PepperJobImpl.getNumOfActiveDocuments()).

Uses of DocumentController in org.corpus_tools.pepper.impl

Methods in org.corpus_tools.pepper.impl that return types with arguments of type DocumentController

Modifier and Type	Method	Description
protected Map<String,DocumentController>	PepperModuleImpl.getDocumentId2DC()	Returns the map relating Identifier belonging to SDocument objects to their DocumentController container.

Methods in org.corpus_tools.pepper.impl with parameters of type DocumentController

Modifier and Type	Method	Description
boolean	PepperMapperControllerImpl.getPermissionForProcessDoument(DocumentController controller)	{@inheritDoc PepperJobImpl#getPermissionForProcessDoument(DocumentController)}

Uses of DocumentController in org.corpus_tools.pepper.modules

Methods in org.corpus_tools.pepper.modules that return DocumentController

Modifier and Type	Method	Description
DocumentController	MappingSubject.getDocumentController()	Returns the document controller, if one was set.
DocumentController	ModuleController.next()	Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.
DocumentController	ModuleController.next(boolean ignorePermissionForDocument)	Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

Methods in org.corpus_tools.pepper.modules with parameters of type DocumentController

Modifier and Type	Method	Description
void	ModuleController.complete(DocumentController documentController)	Adds the given DocumentController to the output document bus to be processed by the next PepperModule objects.
void	ModuleController.delete(DocumentController documentController)	Notifies the Pepper framework, that the SDocument being contained in passed DocumentController shall not be processed any further by following Pepper modules.
boolean	PepperMapperController.getPermissionForProcessDoument(DocumentController controller)	{@inheritDoc PepperJobImpl#getPermissionForProcessDoument(DocumentController)}
void	MappingSubject.setDocumentController(DocumentController documentController)	If the set Identifier belongs to a SDocument, it's controller can be passed with this method.