Package com.attivio.sdk.client
Interface DocumentProcessorApi
-
- All Superinterfaces:
ExposedApi
- All Known Implementing Classes:
MockDocumentProcessorApi
public interface DocumentProcessorApi extends ExposedApi
Simple api that runs documents directly through a specified ingest workflow.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IngestDocument
process(IngestDocument doc, java.lang.String workflow)
Process a given document by running it through a given workflow.
-
-
-
Method Detail
-
process
IngestDocument process(IngestDocument doc, java.lang.String workflow) throws AttivioException
Process a given document by running it through a given workflow.The specified workflow must contain only the following types of stages:
- A document transformer of type
DocumentModifyingTransformer
- A document transformer of type
FieldValueCreatingTransformer
- A document transformer of type
FieldValueModifyingTransformer
- Any workflow (other than index) that meets the same restrictions as the original workflow
NOTE: If the specified workflow contains any components using a non-default implementation of
ProcessingFeedbackDocumentTagger
, any processing errors that occur may not be handled correctly by this service- Parameters:
doc
-workflow
-- Returns:
- the output document(s) as a list
- Throws:
AttivioException
- if thePlatformMessage
returned as a result of processing is not an instance ofDocumentList
with a singleIngestDocument
, if there is an error during processing, or if input workflow does not pass verification
- A document transformer of type
-
-