Uses of Class
com.kodexa.client.Document

Packages that use Document

Package	Description
com.kodexa.client	Provides the classes necessary to create, and interact with, the Kodexa Content Model, note that this interaction in Java has been simplified compared with the Python implementation
com.kodexa.client.connectors	Provides the classes necessary to create connectors which are used as the starting points for a Pipeline
com.kodexa.client.pipeline	Provides the classes necessary to create a local pipeline for running PipelineSteps and working with Documents
com.kodexa.client.registry	Provides the classes for managing the registration of stores and source types
com.kodexa.client.remote	Provides the classes for create pipeline steps which are hosted in the Kodexa Cloud, and also the ability to create a KodexaCloudPipeline that will process documents completely in the cloud.
com.kodexa.client.sink	Provides the classes necessary to create basic sinks for use with a Pipeline
com.kodexa.client.steps	Provides the classes necessary to create processing steps that can be used on a Pipeline
com.kodexa.client.store	Provides the classes necessary to create, and interact document and data stores.

Uses of Document in com.kodexa.client

Methods in com.kodexa.client that return Document

Modifier and Type	Method	Description
Document	Document.addLabel(String label)	Add the given label to the document
static Document	Document.fromBytes(byte[] bytes)
static Document	Document.fromInputStream(InputStream inputStream)
static Document	Document.fromJson(String json)	Deprecated.
static Document	Document.fromKddb(File file)
static Document	Document.fromMsgPack(byte[] bytes)	Deprecated.
static Document	Document.fromMsgPack(File file)	Deprecated.
static Document	Document.fromMsgPack(InputStream is)	Deprecated.
static Document	Document.fromText(String text)
static Document	Document.fromUrl(String url)
Document	ContentNode.getDocument()
Document	Document.removeLabel(String label)	Remove the given label to the document

Constructors in com.kodexa.client with parameters of type Document

Constructor	Description
ContentNode(Document document)
SqlitePersistenceLayer(Document document)
SqlitePersistenceLayer(File kddbFile, Document document)
SqlitePersistenceLayer(InputStream kddbInputStream, Document document)

Uses of Document in com.kodexa.client.connectors

Methods in com.kodexa.client.connectors that return Document

Modifier and Type	Method	Description
Document	FolderConnector.next()
Document	InputStreamConnector.next()

Methods in com.kodexa.client.connectors with parameters of type Document

Modifier and Type	Method	Description
InputStream	Connector.getSource(Document document)
InputStream	FolderConnector.getSource(Document document)
InputStream	InputStreamConnector.getSource(Document document)

Uses of Document in com.kodexa.client.pipeline

Methods in com.kodexa.client.pipeline that return Document

Modifier and Type	Method	Description
Document	PipelineContext.getOutputDocument()	Returns the final output document, or null if there isn't one
Document	DocumentConnector.next()
Document	ClassBasedStep.process(Document document, PipelineContext context)
Document	PipelineStepWrapper.process(Document document, PipelineContext context)

Methods in com.kodexa.client.pipeline with parameters of type Document

Modifier and Type	Method	Description
InputStream	DocumentConnector.getSource(Document document)
Document	ClassBasedStep.process(Document document, PipelineContext context)
Document	PipelineStepWrapper.process(Document document, PipelineContext context)
void	PipelineContext.setOutputDocument(Document document)	Sets the final output document for the pipeline

Constructors in com.kodexa.client.pipeline with parameters of type Document

Constructor	Description
DocumentConnector(Document document)
Pipeline(Document document)

Uses of Document in com.kodexa.client.registry

Methods in com.kodexa.client.registry with parameters of type Document

Modifier and Type	Method	Description
InputStream	SourceRegistry.getSource(Document document)

Uses of Document in com.kodexa.client.remote

Methods in com.kodexa.client.remote that return Document

Modifier and Type	Method	Description
Document	AbstractKodexaSession.getOutputDocument(CloudSession session, CloudExecution execution)
Document	RemoteAction.process(Document document, PipelineContext pipelineContext)

Methods in com.kodexa.client.remote with parameters of type Document

Modifier and Type	Method	Description
CloudExecution	AbstractKodexaSession.executeService(CloudSession session, Document document, PipelineContext context, Options options, Map<String,Object> parameters)	Execute the service in Kodexa
Document	RemoteAction.process(Document document, PipelineContext pipelineContext)

Constructors in com.kodexa.client.remote with parameters of type Document

Constructor	Description
RemotePipeline(String ref, Document document)

Uses of Document in com.kodexa.client.sink

Methods in com.kodexa.client.sink that return Document

Modifier and Type	Method	Description
Document	InMemorySink.getDocument(int i)

Methods in com.kodexa.client.sink with parameters of type Document

Modifier and Type	Method	Description
void	InMemorySink.sink(Document document)
void	Sink.sink(Document document)

Uses of Document in com.kodexa.client.steps

Methods in com.kodexa.client.steps that return Document

Modifier and Type	Method	Description
Document	PipelineStep.process(Document document, PipelineContext context)	The pipeline will call the process method, passing each document to the step.

Methods in com.kodexa.client.steps with parameters of type Document

Modifier and Type	Method	Description
Document	PipelineStep.process(Document document, PipelineContext context)	The pipeline will call the process method, passing each document to the step.

Uses of Document in com.kodexa.client.store

Methods in com.kodexa.client.store that return Document

Modifier and Type	Method	Description
abstract Document	AbstractFileSystemDocumentStore.getDocument(int position)
Document	JsonDocumentStore.getDocument(int position)
Document	MsgPackDocumentStore.getDocument(int position)
Document	AbstractFileSystemDocumentStore.next()

Methods in com.kodexa.client.store with parameters of type Document

Modifier and Type	Method	Description
InputStream	AbstractFileSystemDocumentStore.getSource(Document document)
void	JsonDocumentStore.sink(Document document)
void	MsgPackDocumentStore.sink(Document document)