A C D E F G H I J K L M N O P R S T U V W 
All Classes All Packages

A

AbstractFileSystemDocumentStore - Class in com.kodexa.client.store
 
AbstractFileSystemDocumentStore(String, boolean) - Constructor for class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
AbstractKodexaConnection - Class in com.kodexa.client.remote
 
AbstractKodexaConnection() - Constructor for class com.kodexa.client.remote.AbstractKodexaConnection
 
AbstractKodexaSession - Class in com.kodexa.client.remote
Abstract base for both Cloud Service and Cloud Pipelines in Kodexa
AbstractKodexaSession(String) - Constructor for class com.kodexa.client.remote.AbstractKodexaSession
 
accept(File, String) - Method in class com.kodexa.client.connectors.FolderConnector.WildcardMatcher
 
addConnector(Connector) - Method in class com.kodexa.client.registry.SourceRegistry
 
addFeature(ContentFeature) - Method in class com.kodexa.client.ContentNode
 
addFeature(String, String) - Method in class com.kodexa.client.ContentNode
 
addLabel(String) - Method in class com.kodexa.client.Document
Add the given label to the document
addMixin(String) - Method in class com.kodexa.client.Document
 
addParameter(String, String) - Method in class com.kodexa.client.pipeline.Pipeline
 
addStep(PipelineStep) - Method in class com.kodexa.client.pipeline.Pipeline
 
addStep(Class, Options) - Method in class com.kodexa.client.pipeline.Pipeline
 
addStep(String, Options) - Method in class com.kodexa.client.pipeline.Pipeline
 
addStore(String, DataStore) - Method in class com.kodexa.client.pipeline.PipelineContext
Add the given store to the pipeline context
attachSource() - Method in class com.kodexa.client.pipeline.Options
 

C

canEqual(Object) - Method in class com.kodexa.client.ContentClassification
 
canEqual(Object) - Method in class com.kodexa.client.ContentFeature
 
canEqual(Object) - Method in class com.kodexa.client.ContentNode
 
canEqual(Object) - Method in class com.kodexa.client.Document
 
canEqual(Object) - Method in class com.kodexa.client.FeatureSet
 
canEqual(Object) - Method in class com.kodexa.client.NodeFeatures
 
canEqual(Object) - Method in class com.kodexa.client.pipeline.PipelineParameter
 
canEqual(Object) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
canEqual(Object) - Method in class com.kodexa.client.remote.CloudExecution
 
canEqual(Object) - Method in class com.kodexa.client.remote.CloudExecutionStep
 
canEqual(Object) - Method in class com.kodexa.client.remote.CloudSession
 
canEqual(Object) - Method in class com.kodexa.client.remote.CloudStore
 
canEqual(Object) - Method in class com.kodexa.client.remote.ContentObject
 
canEqual(Object) - Method in class com.kodexa.client.remote.KodexaPlatform
 
canEqual(Object) - Method in class com.kodexa.client.remote.Page
 
canEqual(Object) - Method in exception com.kodexa.client.remote.ProcessingException
 
canEqual(Object) - Method in class com.kodexa.client.SourceMetadata
 
canEqual(Object) - Method in class com.kodexa.client.store.StoredRow
 
canEqual(Object) - Method in class com.kodexa.client.store.TableStore
 
ClassBasedStep - Class in com.kodexa.client.pipeline
 
ClassBasedStep(Class) - Constructor for class com.kodexa.client.pipeline.ClassBasedStep
 
close() - Method in class com.kodexa.client.Document
 
close() - Method in class com.kodexa.client.SqlitePersistenceLayer
 
CloudExceptionDetail - Class in com.kodexa.client.remote
 
CloudExceptionDetail() - Constructor for class com.kodexa.client.remote.CloudExceptionDetail
 
CloudExecution - Class in com.kodexa.client.remote
An instance of an execution that is running in the Kodexa Cloud
CloudExecution() - Constructor for class com.kodexa.client.remote.CloudExecution
 
CloudExecutionStep - Class in com.kodexa.client.remote
 
CloudExecutionStep() - Constructor for class com.kodexa.client.remote.CloudExecutionStep
 
CloudSession - Class in com.kodexa.client.remote
An instance of a session in the Kodexa Cloud
CloudSession() - Constructor for class com.kodexa.client.remote.CloudSession
 
CloudSessionType - Enum in com.kodexa.client.remote
The types of session that can be created in Kodexa
CloudStore - Class in com.kodexa.client.remote
 
CloudStore() - Constructor for class com.kodexa.client.remote.CloudStore
 
com.kodexa.client - package 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 - package 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 - package com.kodexa.client.pipeline
Provides the classes necessary to create a local pipeline for running PipelineSteps and working with Documents
com.kodexa.client.registry - package com.kodexa.client.registry
Provides the classes for managing the registration of stores and source types
com.kodexa.client.remote - package 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 - package com.kodexa.client.sink
Provides the classes necessary to create basic sinks for use with a Pipeline
com.kodexa.client.steps - package com.kodexa.client.steps
Provides the classes necessary to create processing steps that can be used on a Pipeline
com.kodexa.client.store - package com.kodexa.client.store
Provides the classes necessary to create, and interact document and data stores.
condition(String) - Method in class com.kodexa.client.pipeline.Options
 
connector - Variable in class com.kodexa.client.pipeline.Pipeline
 
Connector - Interface in com.kodexa.client.connectors
A connector is used at the beginning of a Pipeline to allow one or more documents to be processed
ContentClassification - Class in com.kodexa.client
 
ContentClassification() - Constructor for class com.kodexa.client.ContentClassification
 
ContentFeature - Class in com.kodexa.client
A feature that has been applied to a node of the content model
ContentFeature() - Constructor for class com.kodexa.client.ContentFeature
 
ContentNode - Class in com.kodexa.client
A node in a content tree
ContentNode(Document) - Constructor for class com.kodexa.client.ContentNode
 
ContentObject - Class in com.kodexa.client.remote
 
ContentObject() - Constructor for class com.kodexa.client.remote.ContentObject
 
createClone() - Method in class com.kodexa.client.pipeline.Options
 
createContentNode(String, String) - Method in class com.kodexa.client.Document
 
createSession(CloudSessionType) - Method in class com.kodexa.client.remote.AbstractKodexaSession
 
CURRENT_VERSION - Static variable in class com.kodexa.client.Document
 

D

DataStore - Interface in com.kodexa.client.store
 
deserialize(String, Map<String, Object>) - Method in class com.kodexa.client.registry.StoreRegistry
 
DictionaryStore - Class in com.kodexa.client.store
 
DictionaryStore(Map<String, Object>) - Constructor for class com.kodexa.client.store.DictionaryStore
 
Document - Class in com.kodexa.client
A Kodexa document is a representation of a set of content which combines content, metadata and features it is the core model for handling content
Document() - Constructor for class com.kodexa.client.Document
 
Document(File) - Constructor for class com.kodexa.client.Document
 
Document(InputStream) - Constructor for class com.kodexa.client.Document
 
DocumentConnector - Class in com.kodexa.client.pipeline
 
DocumentConnector(Document) - Constructor for class com.kodexa.client.pipeline.DocumentConnector
 
DocumentStore - Interface in com.kodexa.client.store
 

E

enabled(boolean) - Method in class com.kodexa.client.pipeline.Options
 
equals(Object) - Method in class com.kodexa.client.ContentClassification
 
equals(Object) - Method in class com.kodexa.client.ContentFeature
 
equals(Object) - Method in class com.kodexa.client.ContentNode
 
equals(Object) - Method in class com.kodexa.client.Document
 
equals(Object) - Method in class com.kodexa.client.FeatureSet
 
equals(Object) - Method in class com.kodexa.client.NodeFeatures
 
equals(Object) - Method in class com.kodexa.client.pipeline.PipelineParameter
 
equals(Object) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
equals(Object) - Method in class com.kodexa.client.remote.CloudExecution
 
equals(Object) - Method in class com.kodexa.client.remote.CloudExecutionStep
 
equals(Object) - Method in class com.kodexa.client.remote.CloudSession
 
equals(Object) - Method in class com.kodexa.client.remote.CloudStore
 
equals(Object) - Method in class com.kodexa.client.remote.ContentObject
 
equals(Object) - Method in class com.kodexa.client.remote.KodexaPlatform
 
equals(Object) - Method in class com.kodexa.client.remote.Page
 
equals(Object) - Method in exception com.kodexa.client.remote.ProcessingException
 
equals(Object) - Method in class com.kodexa.client.SourceMetadata
 
equals(Object) - Method in class com.kodexa.client.store.StoredRow
 
equals(Object) - Method in class com.kodexa.client.store.TableStore
 
executeService(CloudSession, Document, PipelineContext, Options, Map<String, Object>) - Method in class com.kodexa.client.remote.AbstractKodexaSession
Execute the service in Kodexa

F

FAILED - com.kodexa.client.remote.ProcessingStatus
 
FeatureSet - Class in com.kodexa.client
A feature set is a natural way to pass around features that are related to a specific Document.
FeatureSet() - Constructor for class com.kodexa.client.FeatureSet
 
FolderConnector - Class in com.kodexa.client.connectors
Implementation of a Connector for reading from a local directory
FolderConnector() - Constructor for class com.kodexa.client.connectors.FolderConnector
 
FolderConnector(String, String, boolean) - Constructor for class com.kodexa.client.connectors.FolderConnector
 
FolderConnector.WildcardMatcher - Class in com.kodexa.client.connectors
 
forceInitialize - Variable in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
fromBytes(byte[]) - Static method in class com.kodexa.client.Document
 
fromFolder(String, String, boolean) - Static method in class com.kodexa.client.pipeline.Pipeline
 
fromFolder(String, String, String, boolean) - Static method in class com.kodexa.client.remote.RemotePipeline
 
fromInputStream(InputStream) - Static method in class com.kodexa.client.Document
 
fromInputStream(InputStream) - Static method in class com.kodexa.client.pipeline.Pipeline
 
fromInputStream(String, InputStream) - Static method in class com.kodexa.client.remote.RemotePipeline
 
fromJson(String) - Static method in class com.kodexa.client.Document
Deprecated.
fromKddb(File) - Static method in class com.kodexa.client.Document
 
fromMsgPack(byte[]) - Static method in class com.kodexa.client.Document
Deprecated.
fromMsgPack(File) - Static method in class com.kodexa.client.Document
Deprecated.
fromMsgPack(InputStream) - Static method in class com.kodexa.client.Document
Deprecated.
fromText(String) - Static method in class com.kodexa.client.Document
 
fromText(String) - Static method in class com.kodexa.client.pipeline.Pipeline
Create a pipeline with a single document as input containing the content from this text
fromText(String, String) - Static method in class com.kodexa.client.remote.RemotePipeline
Create a new pipeline based on a remote reference and a text document
fromUrl(String) - Static method in class com.kodexa.client.Document
 
fromUrl(String) - Static method in class com.kodexa.client.pipeline.Pipeline
 
fromUrl(String, String) - Static method in class com.kodexa.client.remote.RemotePipeline
 

G

get() - Method in class com.kodexa.client.pipeline.Options
 
getAccessToken() - Static method in class com.kodexa.client.remote.KodexaPlatform
 
getAllContent(String) - Method in class com.kodexa.client.ContentNode
Returns all the contents from this node and all its children
getAllContentForContentNode(ContentNode, String) - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getChecksum() - Method in class com.kodexa.client.SourceMetadata
 
getChildNodes(ContentNode) - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getChildren() - Method in class com.kodexa.client.ContentNode
 
getCid() - Method in class com.kodexa.client.SourceMetadata
 
getClasses() - Method in class com.kodexa.client.Document
 
getColumns() - Method in class com.kodexa.client.store.TableStore
 
getCondition() - Method in class com.kodexa.client.pipeline.Options
 
getConfidence() - Method in class com.kodexa.client.ContentClassification
 
getConnector() - Method in class com.kodexa.client.SourceMetadata
 
getContent() - Method in class com.kodexa.client.ContentNode
 
getContent() - Method in class com.kodexa.client.remote.Page
 
getContentNode() - Method in class com.kodexa.client.Document
 
getContentObjects() - Method in class com.kodexa.client.remote.CloudExecution
List of the content objects available from the execution
getContentParts() - Method in class com.kodexa.client.ContentNode
 
getContentType() - Method in class com.kodexa.client.remote.ContentObject
The content type (DOCUMENT/NATIVE)
getCount() - Method in class com.kodexa.client.sink.InMemorySink
 
getCount() - Method in interface com.kodexa.client.sink.Sink
 
getCount() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
getCreated() - Method in class com.kodexa.client.SourceMetadata
 
getData() - Method in class com.kodexa.client.remote.CloudStore
 
getData() - Method in class com.kodexa.client.store.StoredRow
 
getDescription() - Method in exception com.kodexa.client.remote.ProcessingException
 
getDiagnostics() - Method in exception com.kodexa.client.remote.ProcessingException
 
getDocument() - Method in class com.kodexa.client.ContentNode
 
getDocument(int) - Method in class com.kodexa.client.sink.InMemorySink
 
getDocument(int) - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
getDocument(int) - Method in class com.kodexa.client.store.JsonDocumentStore
 
getDocument(int) - Method in class com.kodexa.client.store.MsgPackDocumentStore
 
getDocumentFamilyId() - Method in class com.kodexa.client.SourceMetadata
 
getErrorMessage() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
getErrorType() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
getExceptionDetail() - Method in class com.kodexa.client.remote.CloudExecution
Get the exception details from the steps
getExceptionDetails() - Method in class com.kodexa.client.remote.CloudExecutionStep
 
getExecutedVersion() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
getExtension() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
getExtension() - Method in class com.kodexa.client.store.JsonDocumentStore
 
getExtension() - Method in class com.kodexa.client.store.MsgPackDocumentStore
 
getFeatures() - Method in class com.kodexa.client.ContentNode
 
getFeatures() - Method in class com.kodexa.client.NodeFeatures
 
getFeatureType() - Method in class com.kodexa.client.ContentFeature
The type of feature (ie spatial, html, tag)
getFile(String) - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
getHeaders() - Method in class com.kodexa.client.SourceMetadata
 
getHelp() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
getId() - Method in class com.kodexa.client.remote.CloudExecution
Unique ID for the execution
getId() - Method in class com.kodexa.client.remote.CloudExecutionStep
 
getId() - Method in class com.kodexa.client.remote.CloudSession
The unique ID of the cloud session
getId() - Method in class com.kodexa.client.remote.CloudStore
 
getId() - Method in class com.kodexa.client.remote.ContentObject
 
getId() - Method in class com.kodexa.client.store.StoredRow
 
getIndex() - Method in class com.kodexa.client.ContentNode
 
getInputId() - Method in class com.kodexa.client.remote.CloudExecution
The ID of the input document (content object)
getInstance() - Static method in class com.kodexa.client.registry.SourceRegistry
 
getInstance() - Static method in class com.kodexa.client.registry.StoreRegistry
 
getLabel() - Method in class com.kodexa.client.ContentClassification
 
getLabels() - Method in class com.kodexa.client.Document
 
getLabels() - Method in class com.kodexa.client.remote.ContentObject
 
getLastModified() - Method in class com.kodexa.client.SourceMetadata
 
getLineageDocumentUuid() - Method in class com.kodexa.client.SourceMetadata
 
getMap() - Method in class com.kodexa.client.pipeline.Options
 
getMessage() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
getMessage() - Method in exception com.kodexa.client.remote.ProcessingException
 
getMetadata() - Method in class com.kodexa.client.Document
 
getMimeType() - Method in class com.kodexa.client.SourceMetadata
 
getMixins() - Method in class com.kodexa.client.Document
 
getName() - Method in interface com.kodexa.client.connectors.Connector
 
getName() - Method in class com.kodexa.client.connectors.FolderConnector
 
getName() - Method in class com.kodexa.client.connectors.InputStreamConnector
 
getName() - Method in class com.kodexa.client.ContentFeature
The name of the feature (ie tag name or div or line etc)
getName() - Method in class com.kodexa.client.pipeline.ClassBasedStep
 
getName() - Method in class com.kodexa.client.pipeline.DocumentConnector
 
getName() - Method in class com.kodexa.client.pipeline.PipelineParameter
 
getName() - Method in class com.kodexa.client.remote.CloudStore
 
getName() - Method in class com.kodexa.client.remote.ContentObject
 
getName() - Method in class com.kodexa.client.remote.RemoteAction
 
getName() - Method in class com.kodexa.client.sink.InMemorySink
 
getName() - Method in interface com.kodexa.client.sink.Sink
 
getName() - Method in interface com.kodexa.client.steps.PipelineStep
The name of the pipeline step
getName() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
getNodeByUuid(String) - Method in class com.kodexa.client.Document
 
getNodeByUuid(String) - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getNodeCountByType(String) - Method in class com.kodexa.client.Document
 
getNodeCountByType(String) - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getNodeFeatures() - Method in class com.kodexa.client.FeatureSet
 
getNodesByType(String) - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getNodeUuid() - Method in class com.kodexa.client.NodeFeatures
 
getNumberOfElements() - Method in class com.kodexa.client.remote.Page
 
getOrgSlug() - Method in class com.kodexa.client.store.StoredRow
 
getOriginalFilename() - Method in class com.kodexa.client.SourceMetadata
 
getOriginalPath() - Method in class com.kodexa.client.SourceMetadata
 
getOutputDocument() - Method in class com.kodexa.client.pipeline.PipelineContext
Returns the final output document, or null if there isn't one
getOutputDocument() - Method in class com.kodexa.client.remote.CloudExecution
 
getOutputDocument(CloudSession, CloudExecution) - Method in class com.kodexa.client.remote.AbstractKodexaSession
 
getOutputId() - Method in class com.kodexa.client.remote.CloudExecution
The ID of the output document (content object)
getParameterMap() - Method in class com.kodexa.client.pipeline.PipelineContext
 
getParameters() - Method in class com.kodexa.client.pipeline.PipelineContext
The parameters that were passed to the pipeline
getParent() - Method in class com.kodexa.client.ContentNode
 
getParentId() - Method in class com.kodexa.client.ContentNode
 
getPersistanceLayer() - Method in class com.kodexa.client.Document
 
getPersistenceLayer() - Method in class com.kodexa.client.Document
 
getRef() - Method in class com.kodexa.client.remote.AbstractKodexaSession
 
getRequestConfig() - Method in class com.kodexa.client.remote.AbstractKodexaConnection
 
getRowNum() - Method in class com.kodexa.client.store.StoredRow
 
getRows() - Method in class com.kodexa.client.store.TableStore
 
getSelector() - Method in class com.kodexa.client.ContentClassification
 
getSize() - Method in class com.kodexa.client.remote.Page
 
getSlug() - Method in class com.kodexa.client.store.StoredRow
 
getSource() - Method in class com.kodexa.client.Document
 
getSource(Document) - Method in interface com.kodexa.client.connectors.Connector
 
getSource(Document) - Method in class com.kodexa.client.connectors.FolderConnector
 
getSource(Document) - Method in class com.kodexa.client.connectors.InputStreamConnector
 
getSource(Document) - Method in class com.kodexa.client.pipeline.DocumentConnector
 
getSource(Document) - Method in class com.kodexa.client.registry.SourceRegistry
 
getSource(Document) - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
getSourceDocumentUuid() - Method in class com.kodexa.client.SourceMetadata
 
getSourceOrdering() - Method in class com.kodexa.client.store.StoredRow
 
getStatus() - Method in class com.kodexa.client.remote.CloudExecution
The status of the execution
getStatus() - Method in class com.kodexa.client.remote.CloudExecutionStep
 
getStatusCode() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
getSteps() - Method in class com.kodexa.client.remote.CloudExecution
List of the step that are part of the execution
getStore(String) - Method in class com.kodexa.client.pipeline.PipelineContext
Get a specific store
getStoreNames() - Method in class com.kodexa.client.pipeline.PipelineContext
Return a set of the names of the stores in the pipeline
getStoreRef() - Method in class com.kodexa.client.remote.ContentObject
The reference to the store holding this content object if it is null then the content object is in cache and part of a session
getStores() - Method in class com.kodexa.client.remote.CloudExecution
List of the stores available from the execution
getTable() - Method in class com.kodexa.client.store.StoredRow
 
getTable(String) - Method in class com.kodexa.client.store.RemoteTableDataStore
 
getTable(String, int, int) - Method in class com.kodexa.client.store.RemoteTableDataStore
Returns a list of maps that represent all the data in the store
getTableStore(CloudSession, CloudExecution, CloudStore) - Method in class com.kodexa.client.remote.AbstractKodexaSession
 
getTaggedNodeByTagUuid(String) - Method in class com.kodexa.client.Document
 
getTaggedNodeByTagUuid(String) - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getTaggedNodes() - Method in class com.kodexa.client.Document
 
getTaggedNodes() - Method in class com.kodexa.client.SqlitePersistenceLayer
 
getTaxonomies() - Method in class com.kodexa.client.Document
 
getTaxonomy() - Method in class com.kodexa.client.ContentClassification
 
getTaxonomyRef() - Method in class com.kodexa.client.store.StoredRow
 
getTotalElements() - Method in class com.kodexa.client.remote.Page
 
getTotalPages() - Method in class com.kodexa.client.remote.Page
 
getType() - Method in class com.kodexa.client.ContentNode
 
getUrl() - Static method in class com.kodexa.client.remote.KodexaPlatform
 
getUuid() - Method in class com.kodexa.client.ContentNode
 
getUuid() - Method in class com.kodexa.client.Document
 
getValue() - Method in class com.kodexa.client.ContentFeature
A list of the values that the feature has
getValue() - Method in class com.kodexa.client.pipeline.PipelineParameter
 
getVersion() - Method in class com.kodexa.client.Document
 
getVersion() - Method in class com.kodexa.client.store.StoredRow
 

H

hashCode() - Method in class com.kodexa.client.ContentClassification
 
hashCode() - Method in class com.kodexa.client.ContentFeature
 
hashCode() - Method in class com.kodexa.client.ContentNode
 
hashCode() - Method in class com.kodexa.client.Document
 
hashCode() - Method in class com.kodexa.client.FeatureSet
 
hashCode() - Method in class com.kodexa.client.NodeFeatures
 
hashCode() - Method in class com.kodexa.client.pipeline.PipelineParameter
 
hashCode() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
hashCode() - Method in class com.kodexa.client.remote.CloudExecution
 
hashCode() - Method in class com.kodexa.client.remote.CloudExecutionStep
 
hashCode() - Method in class com.kodexa.client.remote.CloudSession
 
hashCode() - Method in class com.kodexa.client.remote.CloudStore
 
hashCode() - Method in class com.kodexa.client.remote.ContentObject
 
hashCode() - Method in class com.kodexa.client.remote.KodexaPlatform
 
hashCode() - Method in class com.kodexa.client.remote.Page
 
hashCode() - Method in exception com.kodexa.client.remote.ProcessingException
 
hashCode() - Method in class com.kodexa.client.SourceMetadata
 
hashCode() - Method in class com.kodexa.client.store.StoredRow
 
hashCode() - Method in class com.kodexa.client.store.TableStore
 
hasNext() - Method in class com.kodexa.client.connectors.FolderConnector
 
hasNext() - Method in class com.kodexa.client.connectors.InputStreamConnector
 
hasNext() - Method in class com.kodexa.client.pipeline.DocumentConnector
 
hasNext() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 

I

index - Variable in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
indexFile - Variable in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
InMemorySink - Class in com.kodexa.client.sink
An in-memory sink for capturing documents from a pipeline
InMemorySink() - Constructor for class com.kodexa.client.sink.InMemorySink
 
InputStreamConnector - Class in com.kodexa.client.connectors
 
InputStreamConnector() - Constructor for class com.kodexa.client.connectors.InputStreamConnector
 
InputStreamConnector(InputStream) - Constructor for class com.kodexa.client.connectors.InputStreamConnector
 
isAttachSource() - Method in class com.kodexa.client.pipeline.Options
 
isEnabled() - Method in class com.kodexa.client.pipeline.Options
 
isParameterized() - Method in class com.kodexa.client.pipeline.Options
 
isSingle() - Method in class com.kodexa.client.ContentFeature
Is the feature a single value
isVirtual() - Method in class com.kodexa.client.Document
 

J

JsonDocumentStore - Class in com.kodexa.client.store
 
JsonDocumentStore(String) - Constructor for class com.kodexa.client.store.JsonDocumentStore
 
JsonDocumentStore(String, boolean) - Constructor for class com.kodexa.client.store.JsonDocumentStore
 
jsonOm - Static variable in class com.kodexa.client.remote.AbstractKodexaConnection
 

K

KodexaException - Exception in com.kodexa.client
An exception that is thrown if issues occur within the Kodexa client
KodexaException(String) - Constructor for exception com.kodexa.client.KodexaException
Create an exception with a message and no cause
KodexaException(String, Throwable) - Constructor for exception com.kodexa.client.KodexaException
Create a new exception with the provided message and cause
KodexaPlatform - Class in com.kodexa.client.remote
The configuration object (static) for the connection to Kodexa
KodexaPlatform() - Constructor for class com.kodexa.client.remote.KodexaPlatform
 

L

loadDocument() - Method in class com.kodexa.client.SqlitePersistenceLayer
 

M

mergeStores(CloudSession, CloudExecution, PipelineContext) - Method in class com.kodexa.client.remote.AbstractKodexaSession
 
messagePackOm - Static variable in class com.kodexa.client.remote.AbstractKodexaConnection
 
MsgPackDocumentStore - Class in com.kodexa.client.store
 
MsgPackDocumentStore(String) - Constructor for class com.kodexa.client.store.MsgPackDocumentStore
 
MsgPackDocumentStore(String, boolean) - Constructor for class com.kodexa.client.store.MsgPackDocumentStore
 

N

next() - Method in class com.kodexa.client.connectors.FolderConnector
 
next() - Method in class com.kodexa.client.connectors.InputStreamConnector
 
next() - Method in class com.kodexa.client.pipeline.DocumentConnector
 
next() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
NodeFeatures - Class in com.kodexa.client
 
NodeFeatures() - Constructor for class com.kodexa.client.NodeFeatures
 

O

OBJECT_MAPPER - Static variable in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
OptionDrivenStep - Interface in com.kodexa.client.pipeline
An option drive step has the ability to have options passed and set on it
options(Options) - Method in class com.kodexa.client.remote.RemoteAction
 
options(Options) - Method in class com.kodexa.client.remote.RemotePipeline
 
Options - Class in com.kodexa.client.pipeline
A simple structure for capturing the options for a Kodexa Cloud Action in Java
Options() - Constructor for class com.kodexa.client.pipeline.Options
 

P

Page<T> - Class in com.kodexa.client.remote
Base implementation of pagination wrapper
Page() - Constructor for class com.kodexa.client.remote.Page
 
parameterized(boolean) - Method in class com.kodexa.client.pipeline.Options
 
parameters - Variable in class com.kodexa.client.pipeline.Pipeline
 
parameters(List<PipelineParameter>) - Method in class com.kodexa.client.pipeline.Pipeline
 
parameters(Map<String, Object>) - Method in class com.kodexa.client.remote.RemoteAction
 
parameters(Map<String, Object>) - Method in class com.kodexa.client.remote.RemotePipeline
 
path - Variable in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
PENDING - com.kodexa.client.remote.ProcessingStatus
 
pipeline - com.kodexa.client.remote.CloudSessionType
 
Pipeline - Class in com.kodexa.client.pipeline
A Pipeline allows you to put together steps from a connector to a sink to enable re-use and encapsulation of steps.
Pipeline(Connector) - Constructor for class com.kodexa.client.pipeline.Pipeline
 
Pipeline(Document) - Constructor for class com.kodexa.client.pipeline.Pipeline
 
PipelineContext - Class in com.kodexa.client.pipeline
The pipeline context is used to manage state through a running pipeline
PipelineContext() - Constructor for class com.kodexa.client.pipeline.PipelineContext
 
PipelineParameter - Class in com.kodexa.client.pipeline
 
PipelineParameter() - Constructor for class com.kodexa.client.pipeline.PipelineParameter
 
PipelineParameter(String, Object) - Constructor for class com.kodexa.client.pipeline.PipelineParameter
 
PipelineStep - Interface in com.kodexa.client.steps
An interface that describes the contract for a pipeline step.
PipelineStepWrapper - Class in com.kodexa.client.pipeline
 
PipelineStepWrapper(PipelineStep, Options) - Constructor for class com.kodexa.client.pipeline.PipelineStepWrapper
 
process(Document, PipelineContext) - Method in class com.kodexa.client.pipeline.ClassBasedStep
 
process(Document, PipelineContext) - Method in class com.kodexa.client.pipeline.PipelineStepWrapper
 
process(Document, PipelineContext) - Method in class com.kodexa.client.remote.RemoteAction
 
process(Document, PipelineContext) - Method in interface com.kodexa.client.steps.PipelineStep
The pipeline will call the process method, passing each document to the step.
ProcessingException - Exception in com.kodexa.client.remote
Representation of a processing exception that has occurred in the Kodexa Cloud
ProcessingException() - Constructor for exception com.kodexa.client.remote.ProcessingException
 
ProcessingException(String, String, Map<String, Object>) - Constructor for exception com.kodexa.client.remote.ProcessingException
 
ProcessingStatus - Enum in com.kodexa.client.remote
The processing status valid values
putNative(String, InputStream) - Method in class com.kodexa.client.store.RemoteDocumentStore
 

R

readIndex() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
RemoteAction - Class in com.kodexa.client.remote
A step that is hosted in the Kodexa Cloud
RemoteAction(String) - Constructor for class com.kodexa.client.remote.RemoteAction
 
RemoteAction(String, String) - Constructor for class com.kodexa.client.remote.RemoteAction
 
RemoteAction(String, String, Options) - Constructor for class com.kodexa.client.remote.RemoteAction
 
RemoteDocumentStore - Class in com.kodexa.client.store
 
RemoteDocumentStore(String) - Constructor for class com.kodexa.client.store.RemoteDocumentStore
 
RemotePipeline - Class in com.kodexa.client.remote
A remote-hosted Pipeline
RemotePipeline(String, Connector) - Constructor for class com.kodexa.client.remote.RemotePipeline
 
RemotePipeline(String, Document) - Constructor for class com.kodexa.client.remote.RemotePipeline
 
RemotePipelineSession - Class in com.kodexa.client.remote
 
RemotePipelineSession(String) - Constructor for class com.kodexa.client.remote.RemotePipelineSession
 
RemoteTableDataStore - Class in com.kodexa.client.store
A remote data table store
RemoteTableDataStore(String) - Constructor for class com.kodexa.client.store.RemoteTableDataStore
 
removeFeature(ContentFeature) - Method in class com.kodexa.client.ContentNode
 
removeLabel(String) - Method in class com.kodexa.client.Document
Remove the given label to the document
resetConnector() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
run() - Method in class com.kodexa.client.pipeline.Pipeline
 
run() - Method in class com.kodexa.client.remote.RemotePipeline
 

S

saveIndex() - Method in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
service - com.kodexa.client.remote.CloudSessionType
 
set(String, Object) - Method in class com.kodexa.client.pipeline.Options
 
setAccessToken(String) - Static method in class com.kodexa.client.remote.KodexaPlatform
 
setChecksum(String) - Method in class com.kodexa.client.SourceMetadata
 
setCid(String) - Method in class com.kodexa.client.SourceMetadata
 
setClasses(List<ContentClassification>) - Method in class com.kodexa.client.Document
 
setColumns(List<String>) - Method in class com.kodexa.client.store.TableStore
 
setConfidence(Float) - Method in class com.kodexa.client.ContentClassification
 
setConnector(String) - Method in class com.kodexa.client.SourceMetadata
 
setContent(String) - Method in class com.kodexa.client.ContentNode
 
setContent(List<T>) - Method in class com.kodexa.client.remote.Page
 
setContentNode(ContentNode) - Method in class com.kodexa.client.Document
 
setContentObjects(List<ContentObject>) - Method in class com.kodexa.client.remote.CloudExecution
List of the content objects available from the execution
setContentParts(List<Object>) - Method in class com.kodexa.client.ContentNode
 
setContentType(String) - Method in class com.kodexa.client.remote.ContentObject
The content type (DOCUMENT/NATIVE)
setCreated(String) - Method in class com.kodexa.client.SourceMetadata
 
setData(TableStore) - Method in class com.kodexa.client.remote.CloudStore
 
setData(Map<String, String>) - Method in class com.kodexa.client.store.StoredRow
 
setDescription(String) - Method in exception com.kodexa.client.remote.ProcessingException
 
setDiagnostics(Map<String, Object>) - Method in exception com.kodexa.client.remote.ProcessingException
 
setDocumentFamilyId(String) - Method in class com.kodexa.client.SourceMetadata
 
setErrorMessage(String) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
setErrorType(String) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
setExceptionDetails(CloudExceptionDetail) - Method in class com.kodexa.client.remote.CloudExecutionStep
 
setExecutedVersion(String) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
setFeatures(List<ContentFeature>) - Method in class com.kodexa.client.ContentNode
 
setFeatures(List<ContentFeature>) - Method in class com.kodexa.client.NodeFeatures
 
setFeatureType(String) - Method in class com.kodexa.client.ContentFeature
The type of feature (ie spatial, html, tag)
setHeaders(Map<String, Object>) - Method in class com.kodexa.client.SourceMetadata
 
setHelp(String) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
setId(String) - Method in class com.kodexa.client.remote.CloudExecution
Unique ID for the execution
setId(String) - Method in class com.kodexa.client.remote.CloudExecutionStep
 
setId(String) - Method in class com.kodexa.client.remote.CloudSession
The unique ID of the cloud session
setId(String) - Method in class com.kodexa.client.remote.CloudStore
 
setId(String) - Method in class com.kodexa.client.remote.ContentObject
 
setId(String) - Method in class com.kodexa.client.store.StoredRow
 
setIndex(int) - Method in class com.kodexa.client.ContentNode
 
setInputId(String) - Method in class com.kodexa.client.remote.CloudExecution
The ID of the input document (content object)
setLabel(String) - Method in class com.kodexa.client.ContentClassification
 
setLabels(List<String>) - Method in class com.kodexa.client.Document
 
setLabels(List<String>) - Method in class com.kodexa.client.remote.ContentObject
 
setLastModified(String) - Method in class com.kodexa.client.SourceMetadata
 
setLineageDocumentUuid(String) - Method in class com.kodexa.client.SourceMetadata
 
setMessage(String) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
setMessage(String) - Method in exception com.kodexa.client.remote.ProcessingException
 
setMetadata(Map<String, Object>) - Method in class com.kodexa.client.Document
 
setMimeType(String) - Method in class com.kodexa.client.SourceMetadata
 
setMixins(List<String>) - Method in class com.kodexa.client.Document
 
setName(String) - Method in class com.kodexa.client.ContentFeature
The name of the feature (ie tag name or div or line etc)
setName(String) - Method in class com.kodexa.client.pipeline.PipelineParameter
 
setName(String) - Method in class com.kodexa.client.remote.CloudStore
 
setName(String) - Method in class com.kodexa.client.remote.ContentObject
 
setNodeFeatures(List<NodeFeatures>) - Method in class com.kodexa.client.FeatureSet
 
setNodeUuid(String) - Method in class com.kodexa.client.NodeFeatures
 
setNumberOfElements(long) - Method in class com.kodexa.client.remote.Page
 
setOptions(Options) - Method in class com.kodexa.client.pipeline.ClassBasedStep
 
setOptions(Options) - Method in interface com.kodexa.client.pipeline.OptionDrivenStep
 
setOrgSlug(String) - Method in class com.kodexa.client.store.StoredRow
 
setOriginalFilename(String) - Method in class com.kodexa.client.SourceMetadata
 
setOriginalPath(String) - Method in class com.kodexa.client.SourceMetadata
 
setOutputDocument(Document) - Method in class com.kodexa.client.pipeline.PipelineContext
Sets the final output document for the pipeline
setOutputId(String) - Method in class com.kodexa.client.remote.CloudExecution
The ID of the output document (content object)
setParameters(List<PipelineParameter>) - Method in class com.kodexa.client.pipeline.PipelineContext
The parameters that were passed to the pipeline
setParent(ContentNode) - Method in class com.kodexa.client.ContentNode
 
setParentId(Integer) - Method in class com.kodexa.client.ContentNode
 
setPersistenceLayer(SqlitePersistenceLayer) - Method in class com.kodexa.client.Document
 
setRowNum(int) - Method in class com.kodexa.client.store.StoredRow
 
setRows(List<List<Object>>) - Method in class com.kodexa.client.store.TableStore
 
setSelector(String) - Method in class com.kodexa.client.ContentClassification
 
setSingle(boolean) - Method in class com.kodexa.client.ContentFeature
Is the feature a single value
setSink(Sink) - Method in class com.kodexa.client.pipeline.Pipeline
 
setSink(Sink) - Method in class com.kodexa.client.remote.RemotePipeline
Set the sink
setSize(long) - Method in class com.kodexa.client.remote.Page
 
setSlug(String) - Method in class com.kodexa.client.store.StoredRow
 
setSource(SourceMetadata) - Method in class com.kodexa.client.Document
 
setSourceDocumentUuid(String) - Method in class com.kodexa.client.SourceMetadata
 
setSourceOrdering(String) - Method in class com.kodexa.client.store.StoredRow
 
setStatus(String) - Method in class com.kodexa.client.remote.CloudExecution
The status of the execution
setStatus(String) - Method in class com.kodexa.client.remote.CloudExecutionStep
 
setStatusCode(int) - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
setSteps(List<CloudExecutionStep>) - Method in class com.kodexa.client.remote.CloudExecution
List of the step that are part of the execution
setStoreRef(String) - Method in class com.kodexa.client.remote.ContentObject
The reference to the store holding this content object if it is null then the content object is in cache and part of a session
setStores(List<CloudStore>) - Method in class com.kodexa.client.remote.CloudExecution
List of the stores available from the execution
setTable(String) - Method in class com.kodexa.client.store.StoredRow
 
setTaxonomies(List<String>) - Method in class com.kodexa.client.Document
 
setTaxonomy(String) - Method in class com.kodexa.client.ContentClassification
 
setTaxonomyRef(String) - Method in class com.kodexa.client.store.StoredRow
 
setTotalElements(long) - Method in class com.kodexa.client.remote.Page
 
setTotalPages(long) - Method in class com.kodexa.client.remote.Page
 
setType(String) - Method in class com.kodexa.client.ContentNode
 
setUrl(String) - Static method in class com.kodexa.client.remote.KodexaPlatform
 
setUuid(String) - Method in class com.kodexa.client.ContentNode
 
setUuid(String) - Method in class com.kodexa.client.Document
 
setValue(Object) - Method in class com.kodexa.client.pipeline.PipelineParameter
 
setValue(List<Object>) - Method in class com.kodexa.client.ContentFeature
A list of the values that the feature has
setVersion(String) - Method in class com.kodexa.client.Document
 
setVersion(String) - Method in class com.kodexa.client.store.StoredRow
 
setVirtual(boolean) - Method in class com.kodexa.client.Document
 
sink(Document) - Method in class com.kodexa.client.sink.InMemorySink
 
sink(Document) - Method in interface com.kodexa.client.sink.Sink
 
sink(Document) - Method in class com.kodexa.client.store.JsonDocumentStore
 
sink(Document) - Method in class com.kodexa.client.store.MsgPackDocumentStore
 
Sink - Interface in com.kodexa.client.sink
 
SourceMetadata - Class in com.kodexa.client
 
SourceMetadata() - Constructor for class com.kodexa.client.SourceMetadata
 
SourceRegistry - Class in com.kodexa.client.registry
The registry of source types, used in Kodexa to allow us to separate access to sources from the steps and pipeline
SourceRegistry() - Constructor for class com.kodexa.client.registry.SourceRegistry
 
SqlitePersistenceLayer - Class in com.kodexa.client
A Persistence Layer that works with the document to allow it to be interacted with
SqlitePersistenceLayer(Document) - Constructor for class com.kodexa.client.SqlitePersistenceLayer
 
SqlitePersistenceLayer(File, Document) - Constructor for class com.kodexa.client.SqlitePersistenceLayer
 
SqlitePersistenceLayer(InputStream, Document) - Constructor for class com.kodexa.client.SqlitePersistenceLayer
 
start() - Static method in class com.kodexa.client.pipeline.Options
 
StoredRow - Class in com.kodexa.client.store
 
StoredRow() - Constructor for class com.kodexa.client.store.StoredRow
 
storeFolder - Variable in class com.kodexa.client.store.AbstractFileSystemDocumentStore
 
StoreRegistry - Class in com.kodexa.client.registry
 
StoreRegistry() - Constructor for class com.kodexa.client.registry.StoreRegistry
 
stores - Variable in class com.kodexa.client.pipeline.PipelineContext
The available stores
SUCCESS - com.kodexa.client.remote.ProcessingStatus
 

T

TableStore - Class in com.kodexa.client.store
 
TableStore() - Constructor for class com.kodexa.client.store.TableStore
 
TableStore(Map<String, Object>) - Constructor for class com.kodexa.client.store.TableStore
 
toBytes() - Method in class com.kodexa.client.Document
 
toBytes() - Method in class com.kodexa.client.SqlitePersistenceLayer
 
toInputStream() - Method in class com.kodexa.client.Document
 
toInputStream() - Method in class com.kodexa.client.SqlitePersistenceLayer
 
toJson() - Method in class com.kodexa.client.Document
Deprecated.
toJson(boolean) - Method in class com.kodexa.client.Document
Deprecated.
toMsgPack() - Method in class com.kodexa.client.Document
Deprecated.
toString() - Method in class com.kodexa.client.ContentClassification
 
toString() - Method in class com.kodexa.client.ContentFeature
 
toString() - Method in class com.kodexa.client.ContentNode
 
toString() - Method in class com.kodexa.client.Document
 
toString() - Method in class com.kodexa.client.FeatureSet
 
toString() - Method in class com.kodexa.client.NodeFeatures
 
toString() - Method in class com.kodexa.client.pipeline.PipelineParameter
 
toString() - Method in class com.kodexa.client.remote.CloudExceptionDetail
 
toString() - Method in class com.kodexa.client.remote.CloudExecution
 
toString() - Method in class com.kodexa.client.remote.CloudExecutionStep
 
toString() - Method in class com.kodexa.client.remote.CloudSession
 
toString() - Method in class com.kodexa.client.remote.CloudStore
 
toString() - Method in class com.kodexa.client.remote.ContentObject
 
toString() - Method in class com.kodexa.client.remote.KodexaPlatform
 
toString() - Method in class com.kodexa.client.remote.Page
 
toString() - Method in exception com.kodexa.client.remote.ProcessingException
 
toString() - Method in class com.kodexa.client.SourceMetadata
 
toString() - Method in class com.kodexa.client.store.StoredRow
 
toString() - Method in class com.kodexa.client.store.TableStore
 

U

updateNode(ContentNode) - Method in class com.kodexa.client.SqlitePersistenceLayer
 

V

valueOf(String) - Static method in enum com.kodexa.client.remote.CloudSessionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.kodexa.client.remote.ProcessingStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.kodexa.client.remote.CloudSessionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.kodexa.client.remote.ProcessingStatus
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForExecution(CloudSession, CloudExecution) - Method in class com.kodexa.client.remote.AbstractKodexaSession
 
WildcardMatcher(String) - Constructor for class com.kodexa.client.connectors.FolderConnector.WildcardMatcher
Creates a new matcher with the given expression.
A C D E F G H I J K L M N O P R S T U V W 
All Classes All Packages