Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractConcreteDocumentFactory - Class in com.yahoo.docproc
-
Subtyped by factory classes for concrete document types.
- AbstractConcreteDocumentFactory() - Constructor for class com.yahoo.docproc.AbstractConcreteDocumentFactory
- Accesses - Annotation Interface in com.yahoo.docproc
-
Docprocs tagged with this will read and/or write annotations on the given field(s).
- Accesses.Field - Annotation Interface in com.yahoo.docproc
-
Describes the annotations produced and consumed on one field in a document
- Accesses.Field.Tree - Annotation Interface in com.yahoo.docproc
-
Describes the annotations produced and consumed in one tree on a field
- add(String, Number, Metric.Context) - Method in class com.yahoo.docproc.jdisc.metric.NullMetric
- addAfter(Call, Call) - Method in class com.yahoo.docproc.CallStack
-
Adds an element just after the first occurence of some other element on the stack.
- addAfter(Call, CallStack) - Method in class com.yahoo.docproc.CallStack
-
Adds multiple elements just after another given element on the stack.
- addAfter(Call, DocumentProcessor) - Method in class com.yahoo.docproc.CallStack
-
Adds an element just after the first occurence of some other element on the stack.
- addBefore(Call, Call) - Method in class com.yahoo.docproc.CallStack
-
Adds an element just before the first occurence of some other element on the stack.
- addBefore(Call, CallStack) - Method in class com.yahoo.docproc.CallStack
-
Adds multiple elements just before the first occurence of some element on the stack.
- addBefore(Call, DocumentProcessor) - Method in class com.yahoo.docproc.CallStack
-
Adds an element just before the first occurence of some element on the stack.
- addDocumentOperation(DocumentOperation) - Method in class com.yahoo.docproc.Processing
- addFieldUpdate(FieldUpdate) - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- addLast(Call) - Method in class com.yahoo.docproc.CallStack
-
Adds an element as the last element on this stack
- addLast(CallStack) - Method in class com.yahoo.docproc.CallStack
-
Adds multiple elements as the last elements on this stack
- addLast(DocumentProcessor) - Method in class com.yahoo.docproc.CallStack
-
Adds an element as the last element on this stack
- addNext(Call) - Method in class com.yahoo.docproc.CallStack
-
Push an element as the next element on this stack
- addNext(CallStack) - Method in class com.yahoo.docproc.CallStack
-
Push multiple elements as the next elements on this stack
- addNext(DocumentProcessor) - Method in class com.yahoo.docproc.CallStack
-
Push an element as the next element on this stack
- annotations() - Element in annotation interface com.yahoo.docproc.Accesses.Field
-
The trees of annotations that this docproc accesses on this field
- annotationTypes() - Method in class com.yahoo.docproc.AbstractConcreteDocumentFactory
- applyTo(Document) - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- arrayFieldName() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- arrayFieldName(String) - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- assign(Object) - Method in class com.yahoo.docproc.proxy.ProxyDocument
B
- build() - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- build() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- build() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- build() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- Builder() - Constructor for class com.yahoo.config.docproc.DocprocConfig.Builder
- Builder() - Constructor for class com.yahoo.config.docproc.SchemamappingConfig.Builder
- Builder() - Constructor for class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- Builder() - Constructor for class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- Builder(DocprocConfig) - Constructor for class com.yahoo.config.docproc.DocprocConfig.Builder
- Builder(SchemamappingConfig) - Constructor for class com.yahoo.config.docproc.SchemamappingConfig.Builder
- Builder(SchemamappingConfig.Fieldmapping) - Constructor for class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- Builder(SplitterJoinerDocumentProcessorConfig) - Constructor for class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
C
- call(Processing) - Method in class com.yahoo.docproc.Call
-
Call the DocumentProcessor of this call.
- Call - Class in com.yahoo.docproc
-
A document processor to call - an item on a
CallStack
. - Call(DocumentProcessor) - Constructor for class com.yahoo.docproc.Call
- Call(DocumentProcessor, Metric) - Constructor for class com.yahoo.docproc.Call
-
Creates a new call to a processor with no arguments.
- Call(DocumentProcessor, String, Metric) - Constructor for class com.yahoo.docproc.Call
- callStack() - Method in class com.yahoo.docproc.Processing
-
Returns the processors to call in this processing
- CallStack - Class in com.yahoo.docproc
-
A stack of the processors to call next in this processing.
- CallStack() - Constructor for class com.yahoo.docproc.CallStack
- CallStack(CallStack) - Constructor for class com.yahoo.docproc.CallStack
-
Creates a stack from another stack (starting at the next of the given callstack) This does a deep copy of the stack.
- CallStack(Metric) - Constructor for class com.yahoo.docproc.CallStack
-
Creates an empty stack
- CallStack(String) - Constructor for class com.yahoo.docproc.CallStack
- CallStack(String, Metric) - Constructor for class com.yahoo.docproc.CallStack
-
Creates an empty stack with a name
- CallStack(String, Collection<DocumentProcessor>, Metric) - Constructor for class com.yahoo.docproc.CallStack
-
Creates a stack (with a given name) based on a collection of document processors, which are added to the stack in the iteration order of the collection.
- chain() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping
- chain(String) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- chainMap(String, String) - Method in class com.yahoo.docproc.proxy.SchemaMap
-
The map for a given chain,docproc: "Reverses" the direction, this is the mapping a docproc should do when a doc comes in.
- clear() - Method in class com.yahoo.docproc.CallStack
- clear() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- clearVariables() - Method in class com.yahoo.docproc.Processing
-
Clears all context variables that have been set
- clone() - Method in class com.yahoo.docproc.Call
- clone() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- com.yahoo.config.docproc - package com.yahoo.config.docproc
- com.yahoo.docproc - package com.yahoo.docproc
- com.yahoo.docproc.impl - package com.yahoo.docproc.impl
- com.yahoo.docproc.jdisc - package com.yahoo.docproc.jdisc
- com.yahoo.docproc.jdisc.messagebus - package com.yahoo.docproc.jdisc.messagebus
- com.yahoo.docproc.jdisc.metric - package com.yahoo.docproc.jdisc.metric
- com.yahoo.docproc.jdisc.observability - package com.yahoo.docproc.jdisc.observability
- com.yahoo.docproc.proxy - package com.yahoo.docproc.proxy
- compareTo(FieldValue) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- CONFIG_DEF_MD5 - Static variable in class com.yahoo.config.docproc.DocprocConfig
- CONFIG_DEF_MD5 - Static variable in class com.yahoo.config.docproc.SchemamappingConfig
- CONFIG_DEF_MD5 - Static variable in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- CONFIG_DEF_NAME - Static variable in class com.yahoo.config.docproc.DocprocConfig
- CONFIG_DEF_NAME - Static variable in class com.yahoo.config.docproc.SchemamappingConfig
- CONFIG_DEF_NAME - Static variable in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- CONFIG_DEF_NAMESPACE - Static variable in class com.yahoo.config.docproc.DocprocConfig
- CONFIG_DEF_NAMESPACE - Static variable in class com.yahoo.config.docproc.SchemamappingConfig
- CONFIG_DEF_NAMESPACE - Static variable in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- CONFIG_DEF_SCHEMA - Static variable in class com.yahoo.config.docproc.DocprocConfig
- CONFIG_DEF_SCHEMA - Static variable in class com.yahoo.config.docproc.SchemamappingConfig
- CONFIG_DEF_SCHEMA - Static variable in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- configDoc(DocumentProcessor, DocumentPut) - Method in class com.yahoo.docproc.Call
-
The Document object the proc should work on.
- configure(SchemamappingConfig) - Method in class com.yahoo.docproc.proxy.SchemaMap
- consumes() - Element in annotation interface com.yahoo.docproc.Accesses.Field.Tree
-
The annotation types that this docproc requires in this tree
- contains(Call) - Method in class com.yahoo.docproc.CallStack
-
Returns whether this stack has this call (left)
- contextFieldName() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- contextFieldName(String) - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- createContext(Map<String, ?>) - Method in class com.yahoo.docproc.jdisc.metric.NullMetric
- createProcessingFromDocumentOperations(String, List<DocumentOperation>, CallStack) - Static method in class com.yahoo.docproc.Processing
-
Creates a Processing from a list of operations.
D
- dataType() - Element in annotation interface com.yahoo.docproc.Accesses.Field
-
The datatype of the field
- deconstruct() - Method in class com.yahoo.docproc.impl.DocprocService
- DEFAULT_LATER_DELAY - Static variable in class com.yahoo.docproc.DocumentProcessor.LaterProgress
- description() - Element in annotation interface com.yahoo.docproc.Accesses.Field
- deserialize(Field, FieldReader) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- deserialize(DocumentReader) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- destroy() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandler
- dispatchGetConfig(ConfigInstance.Producer) - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- dispatchGetConfig(ConfigInstance.Producer) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- dispatchGetConfig(ConfigInstance.Producer) - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- docproc() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping
- docproc(String) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- DocprocConfig - Class in com.yahoo.config.docproc
-
This class represents the root node of docproc Copyright Yahoo.
- DocprocConfig(DocprocConfig.Builder) - Constructor for class com.yahoo.config.docproc.DocprocConfig
- DocprocConfig.Builder - Class in com.yahoo.config.docproc
- DocprocConfig.Producer - Interface in com.yahoo.config.docproc
- DocprocExecutor - Class in com.yahoo.docproc.impl
-
An executor executed incoming processings on its CallStack
- DocprocExecutor(DocprocExecutor, CallStack) - Constructor for class com.yahoo.docproc.impl.DocprocExecutor
-
Creates a new named DocprocExecutor, with the same instance variables as the given executor, but a new call stack.
- DocprocExecutor(String, CallStack) - Constructor for class com.yahoo.docproc.impl.DocprocExecutor
-
Creates a new named DocprocExecutor with the given CallStack.
- DocprocService - Class in com.yahoo.docproc.impl
-
The document processing service.
- DocprocService(ComponentId) - Constructor for class com.yahoo.docproc.impl.DocprocService
- DocprocService(ComponentId, CallStack, DocumentTypeManager, int) - Constructor for class com.yahoo.docproc.impl.DocprocService
-
Creates a new docproc service, which is set to be in service.
- DocprocService(String) - Constructor for class com.yahoo.docproc.impl.DocprocService
-
Creates a service with a name with an unbounded input queue.
- DocprocsStatusExtension - Class in com.yahoo.docproc.jdisc.observability
- DocprocsStatusExtension() - Constructor for class com.yahoo.docproc.jdisc.observability.DocprocsStatusExtension
- doctype() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping
- doctype(String) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- DocumentOperationWrapper - Interface in com.yahoo.docproc.impl
- DocumentProcessingHandler - Class in com.yahoo.docproc.jdisc
-
TODO: Javadoc
- DocumentProcessingHandler(ComponentRegistry<DocumentProcessor>, ComponentRegistry<AbstractConcreteDocumentFactory>, ChainsConfig, SchemamappingConfig, DocumentTypeManager, DocprocConfig, ContainerDocumentConfig, Metric) - Constructor for class com.yahoo.docproc.jdisc.DocumentProcessingHandler
- DocumentProcessingHandlerParameters - Class in com.yahoo.docproc.jdisc
-
Class to hold parameters given to DocumentProcessingHandler, typically used by unit tests.
- DocumentProcessingHandlerParameters() - Constructor for class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- DocumentProcessingTask - Class in com.yahoo.docproc.jdisc
- DocumentProcessingTask(RequestContext, DocumentProcessingHandler, DocprocService, ThreadPoolExecutor) - Constructor for class com.yahoo.docproc.jdisc.DocumentProcessingTask
- DocumentProcessor - Class in com.yahoo.docproc
-
A document processor is a component which performs some operation on a document or document update.
- DocumentProcessor() - Constructor for class com.yahoo.docproc.DocumentProcessor
- DocumentProcessor.LaterProgress - Class in com.yahoo.docproc
- DocumentProcessor.Progress - Class in com.yahoo.docproc
-
An enumeration of possible results of calling a process method
- documentTypeName() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- documentTypeName(String) - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- documentTypes() - Method in class com.yahoo.docproc.AbstractConcreteDocumentFactory
- DONE - Static variable in class com.yahoo.docproc.DocumentProcessor.Progress
-
Returned by a processor when it is done with a processing
- doSetFieldValue(Field, FieldValue) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- doWork() - Method in class com.yahoo.docproc.impl.DocprocService
-
Do some work in this service.
- doWorkBlocking() - Method in class com.yahoo.docproc.impl.DocprocService
-
Do some work in this service.
E
- equals(Object) - Method in class com.yahoo.docproc.DocumentProcessor.Progress
- equals(Object) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- equals(Object) - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- ERROR_ABORTED - Enum constant in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
- ERROR_BUSY - Enum constant in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
- ERROR_PROCESSING_FAILURE - Enum constant in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
F
- FAILED - Static variable in class com.yahoo.docproc.DocumentProcessor.Progress
-
Returned by a processor when a processing has failed and it should not be called again for this processing.
- fieldmapping - Variable in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- fieldmapping() - Method in class com.yahoo.config.docproc.SchemamappingConfig
- fieldmapping(int) - Method in class com.yahoo.config.docproc.SchemamappingConfig
- fieldmapping(SchemamappingConfig.Fieldmapping.Builder) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
-
Add the given builder to this builder's list of Fieldmapping builders
- fieldmapping(Consumer<SchemamappingConfig.Fieldmapping.Builder>) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
-
Make a new builder and run the supplied function on it before adding it to the list
- fieldmapping(List<SchemamappingConfig.Fieldmapping.Builder>) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
-
Set the given list as this builder's list of Fieldmapping builders
- Fieldmapping(SchemamappingConfig.Fieldmapping.Builder) - Constructor for class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping
- fieldUpdates() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- findCall(ComponentId) - Method in class com.yahoo.docproc.CallStack
-
Returns the next call to this processor id, or null if no such calls are left
- findCall(DocumentProcessor) - Method in class com.yahoo.docproc.CallStack
-
Returns the next call to this processor, or null if no such calls are left
G
- getApplyOnRestart() - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- getApplyOnRestart() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- getApplyOnRestart() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- getCallStack() - Method in class com.yahoo.docproc.impl.DocprocExecutor
- getCallStack() - Method in class com.yahoo.docproc.impl.DocprocService
-
Returns the processing chain of this service.
- getChains() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandler
- getChainsModel() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
-
Returns the chains model, used to build call stacks.
- getConfig(DocprocConfig.Builder) - Method in interface com.yahoo.config.docproc.DocprocConfig.Producer
- getConfig(SchemamappingConfig.Builder) - Method in interface com.yahoo.config.docproc.SchemamappingConfig.Producer
- getConfig(SplitterJoinerDocumentProcessorConfig.Builder) - Method in interface com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Producer
- getContainerDocConfig() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- getDataType() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getDefMd5() - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- getDefMd5() - Static method in class com.yahoo.config.docproc.DocprocConfig
- getDefMd5() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- getDefMd5() - Static method in class com.yahoo.config.docproc.SchemamappingConfig
- getDefMd5() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- getDefMd5() - Static method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- getDefName() - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- getDefName() - Static method in class com.yahoo.config.docproc.DocprocConfig
- getDefName() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- getDefName() - Static method in class com.yahoo.config.docproc.SchemamappingConfig
- getDefName() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- getDefName() - Static method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- getDefNamespace() - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- getDefNamespace() - Static method in class com.yahoo.config.docproc.DocprocConfig
- getDefNamespace() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- getDefNamespace() - Static method in class com.yahoo.config.docproc.SchemamappingConfig
- getDefNamespace() - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- getDefNamespace() - Static method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- getDelay() - Method in class com.yahoo.docproc.DocumentProcessor.LaterProgress
- getDiscStatus() - Method in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
- getDocMap(String) - Method in class com.yahoo.docproc.DocumentProcessor
- getDocprocServiceRegistry() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandler
- getDocument() - Method in class com.yahoo.docproc.proxy.ProxyDocument
-
The
Document
which this proxies - getDocumentCopy(String, StructuredFieldValue, DocumentId) - Method in class com.yahoo.docproc.AbstractConcreteDocumentFactory
-
Used by the docproc framework to get an instance of a concrete document type without resorting to reflection in a bundle
- getDocumentOperations() - Method in class com.yahoo.docproc.Processing
- getDocumentProcessor() - Method in class com.yahoo.docproc.Call
-
Returns the processor to call.
- getDocumentProcessorId() - Method in class com.yahoo.docproc.Call
-
Returns the ID of the processor to call.
- getDocumentProtocolStatus() - Method in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
- getDocumentType() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- getDocumentTypeManager() - Method in class com.yahoo.docproc.impl.DocprocService
- getDocumentTypeManager() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandler
- getDocumentTypeManager() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- getEndpoint() - Method in class com.yahoo.docproc.impl.ProcessingAccess
- getEndpoint() - Method in class com.yahoo.docproc.Processing
- getExecutor() - Method in class com.yahoo.docproc.impl.DocprocService
-
Returns the DocprocExecutor of this DocprocService.
- getField(String) - Method in class com.yahoo.docproc.proxy.ProxyDocument
-
note that the returned Field may not be in this Document directly, but may refer to a field in a struct contained in it, in which case the returned Field is only useful for obtaining the field type; it can't be used for get() and set().
- getFieldCount() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getFieldMap() - Method in class com.yahoo.docproc.DocumentProcessor
-
Schema map for field names (doctype,from)→to
- getFieldUpdate(Field) - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- getFieldUpdate(String) - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- getFieldValue(Field) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getFieldValue(String) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getId() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getId() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- getLastModified() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getLastPopped() - Method in class com.yahoo.docproc.CallStack
-
Returns the element that was last popped from this stack, or null if none have been popped or the stack is empty
- getMaxNumThreads() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
-
Returns the maximum number of thread that the thread pool will ever attempt to run simultaneously.
- getMetric() - Method in class com.yahoo.docproc.CallStack
- getMetric() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- getName() - Method in class com.yahoo.docproc.CallStack
-
Returns the name of this stack, or null if it is not named
- getName() - Method in class com.yahoo.docproc.impl.DocprocExecutor
- getName() - Method in class com.yahoo.docproc.impl.DocprocService
- getOnceOperationsToBeProcessed() - Method in class com.yahoo.docproc.impl.ProcessingAccess
- getOnceOperationsToBeProcessed() - Method in class com.yahoo.docproc.Processing
- getProcessings() - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- getProcessings() - Method in interface com.yahoo.docproc.jdisc.RequestContext
- getQueueSize() - Method in class com.yahoo.docproc.impl.DocprocService
- getReason() - Method in class com.yahoo.docproc.DocumentProcessor.Progress
- getSchemaMap() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
-
Returns the schema map to be used by the docproc handler.
- getSerializedSize() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getServiceName() - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- getServiceName() - Method in interface com.yahoo.docproc.jdisc.RequestContext
- getServiceName() - Method in class com.yahoo.docproc.Processing
-
Returns the name of the service processing this.
- getThreadPoolExecutor() - Method in class com.yahoo.docproc.impl.DocprocService
- getType() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- getUri() - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- getUri() - Method in interface com.yahoo.docproc.jdisc.RequestContext
- getVariable(String) - Method in class com.yahoo.docproc.Processing
-
Returns a context variable, or null if it is not set
- getVariableAndNameIterator() - Method in class com.yahoo.docproc.Processing
-
Returns an iterator of all context variables that are set
- getWrappedDocumentOperation() - Method in interface com.yahoo.docproc.impl.DocumentOperationWrapper
- getWrappedDocumentOperation() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- getWrappedDocumentOperation() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
H
- HandledProcessingException - Exception in com.yahoo.docproc.impl
-
Exception generated by known bad input in a docproc.
- HandledProcessingException(String) - Constructor for exception com.yahoo.docproc.impl.HandledProcessingException
- handleRequest(Request, ResponseHandler) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandler
- handleResponse(Response) - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- hasExpired() - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- hasExpired() - Method in interface com.yahoo.docproc.jdisc.RequestContext
-
Returns whether this request has timed out
- hashCode() - Method in class com.yahoo.docproc.DocumentProcessor.Progress
- hashCode() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- hashCode() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- hasVariable(String) - Method in class com.yahoo.docproc.Processing
-
Returns true if this variable is present, even if it is null
I
- indocument() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping
- indocument(String) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- inprocessor() - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping
- inprocessor(String) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Fieldmapping.Builder
- internalNoThrottledSource - Static variable in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- isAcceptingNewProcessings() - Method in class com.yahoo.docproc.impl.DocprocService
-
Returns true if this service currently accepts new incoming processings via process(...). Default is true.
- isInService() - Method in class com.yahoo.docproc.impl.DocprocService
-
Returns true if this is currently processing incoming processings (in service), or false if they are just queued up (out of service).
- isProcessable() - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- isProcessable() - Method in interface com.yahoo.docproc.jdisc.RequestContext
- iterateNested(FieldPath, int, FieldPathIteratorHandler) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- iterator() - Method in class com.yahoo.docproc.CallStack
-
Returns a modifiable ListIterator over all the remaining elements of this stack, starting by the next element
- iterator() - Method in class com.yahoo.docproc.proxy.ProxyDocument
L
- later(long) - Static method in class com.yahoo.docproc.DocumentProcessor.Progress
- LATER - Static variable in class com.yahoo.docproc.DocumentProcessor.Progress
-
Returned by a processor when it should be called again later for the same processing
M
- maxqueuetimems() - Method in class com.yahoo.config.docproc.DocprocConfig
- maxqueuetimems(int) - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- MbusRequestContext - Class in com.yahoo.docproc.jdisc.messagebus
- MbusRequestContext(MbusRequest, ResponseHandler, ComponentRegistry<DocprocService>, ComponentRegistry<AbstractConcreteDocumentFactory>, ContainerDocumentConfig) - Constructor for class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
N
- name() - Element in annotation interface com.yahoo.docproc.Accesses.Field
-
The name of the document field
- name() - Element in annotation interface com.yahoo.docproc.Accesses.Field.Tree
-
The name of the tree
- NO_TIMEOUT - Static variable in class com.yahoo.docproc.Processing
- NullMetric - Class in com.yahoo.docproc.jdisc.metric
- NullMetric() - Constructor for class com.yahoo.docproc.jdisc.metric.NullMetric
- numthreads() - Method in class com.yahoo.config.docproc.DocprocConfig
- numthreads(int) - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
O
- of(DocumentOperation) - Static method in class com.yahoo.docproc.Processing
-
Create a Processing from the given document operation
- onSerialize(Serializer) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- optionallyUpgrade(Field, FieldValue) - Method in class com.yahoo.docproc.AbstractConcreteDocumentFactory
-
If the FieldValue is a StructuredFieldValue it will upgrade to the concrete type
P
- peek() - Method in class com.yahoo.docproc.CallStack
-
Returns the next element without removing it, or null if there are no more elements
- PERMANENT_FAILURE - Static variable in class com.yahoo.docproc.DocumentProcessor.Progress
-
Returned by a processor when processing has permanently failed, so that the document processing service should disable itself until reconfigured or restarted.
- pop() - Method in class com.yahoo.docproc.CallStack
-
Returns and removes the next element, or null if there are no more elements
- printXml(XmlStream) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- process(Processing) - Method in class com.yahoo.docproc.DocumentProcessor
-
Processes a processing, which can contain zero or more document bases.
- process(Processing) - Method in class com.yahoo.docproc.impl.DocprocExecutor
-
Processes a given Processing through the CallStack of this executor.
- process(Processing) - Method in class com.yahoo.docproc.impl.DocprocService
-
Asynchronously process the given Processing using the processing chain of this service
- process(Processing) - Method in class com.yahoo.docproc.SimpleDocumentProcessor
-
Simple process() that follows the official guidelines for looping over
DocumentOperation
s, and then calls the appropriate, overloaded process() depending on the type of base. - process(Processing, ProcessingEndpoint) - Method in class com.yahoo.docproc.impl.DocprocService
-
Asynchronously process the given Processing using the processing chain of this service, and call the specified ProcessingEndpoint when done.
- process(DocumentOperation) - Method in class com.yahoo.docproc.impl.DocprocService
-
Asynchronously process the given document operation using the processing chain of this service.
- process(DocumentOperation, ProcessingEndpoint) - Method in class com.yahoo.docproc.impl.DocprocService
-
Asynchronously process the given document put or document update using the processing chain of this service, and call the specified ProcessingEndpoint when done.
- process(DocumentPut) - Method in class com.yahoo.docproc.SimpleDocumentProcessor
-
Override this to process DocumentPuts.
- process(DocumentRemove) - Method in class com.yahoo.docproc.SimpleDocumentProcessor
-
Override this to process DocumentRemoves.
- process(DocumentUpdate) - Method in class com.yahoo.docproc.SimpleDocumentProcessor
-
Override this to process DocumentUpdates.
- processDocumentOperations(List<DocumentOperation>) - Method in class com.yahoo.docproc.impl.DocprocService
-
Asynchronously process the given document operations as one unit using the processing chain of this service.
- processDocumentOperations(List<DocumentOperation>, ProcessingEndpoint) - Method in class com.yahoo.docproc.impl.DocprocService
-
Asynchronously process the given document operations as one unit using the processing chain of this service, and call the specified ProcessingEndpoint when done.
- Processing - Class in com.yahoo.docproc
-
A document processing.
- Processing() - Constructor for class com.yahoo.docproc.Processing
-
Create a Processing with no documents.
- Processing(String, DocumentOperation, CallStack) - Constructor for class com.yahoo.docproc.Processing
-
Create a processing with one document.
- ProcessingAccess - Class in com.yahoo.docproc.impl
-
Bridge to access protected (originally package private) methods in
Processing
. - ProcessingAccess() - Constructor for class com.yahoo.docproc.impl.ProcessingAccess
- processingDone(Processing) - Method in interface com.yahoo.docproc.impl.ProcessingEndpoint
- processingDone(List<Processing>) - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- processingDone(List<Processing>) - Method in interface com.yahoo.docproc.jdisc.RequestContext
- ProcessingEndpoint - Interface in com.yahoo.docproc.impl
- processingFailed(RequestContext.ErrorCode, String) - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- processingFailed(RequestContext.ErrorCode, String) - Method in interface com.yahoo.docproc.jdisc.RequestContext
- processingFailed(Processing, Exception) - Method in interface com.yahoo.docproc.impl.ProcessingEndpoint
- processingFailed(Exception) - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- processingFailed(Exception) - Method in interface com.yahoo.docproc.jdisc.RequestContext
- processUntilDone(Processing) - Method in class com.yahoo.docproc.impl.DocprocExecutor
-
Processes a given Processing through the CallStack of this executor.
- produceExtraFields(ApplicationStatusHandler) - Method in class com.yahoo.docproc.jdisc.observability.DocprocsStatusExtension
- produces() - Element in annotation interface com.yahoo.docproc.Accesses.Field.Tree
-
The annotation types that this docproc writes in this tree
- Progress(String) - Constructor for class com.yahoo.docproc.DocumentProcessor.Progress
- Progress(String, String) - Constructor for class com.yahoo.docproc.DocumentProcessor.Progress
- ProxyDocument - Class in com.yahoo.docproc.proxy
-
This is a facade to a Document, with two purposes: Getters and setters for field data may take into account a schema map of field names.
- ProxyDocument(DocumentProcessor, Document, Map<String, String>) - Constructor for class com.yahoo.docproc.proxy.ProxyDocument
- ProxyDocumentUpdate - Class in com.yahoo.docproc.proxy
-
Schema mapped facade to a DocumentUpdate
- ProxyDocumentUpdate(DocumentUpdate, Map<String, String>) - Constructor for class com.yahoo.docproc.proxy.ProxyDocumentUpdate
R
- remove(Call) - Method in class com.yahoo.docproc.CallStack
-
Removes the given call.
- removeFieldValue(Field) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- removeFieldValue(String) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- removeVariable(String) - Method in class com.yahoo.docproc.Processing
- RequestContext - Interface in com.yahoo.docproc.jdisc
- RequestContext.ErrorCode - Enum Class in com.yahoo.docproc.jdisc
- run() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingTask
S
- schemaMap - Static variable in class com.yahoo.docproc.impl.DocprocService
- SchemaMap - Class in com.yahoo.docproc.proxy
-
Can be used to map field names from input doc into names used in a docproc that was written with generic field names.
- SchemaMap() - Constructor for class com.yahoo.docproc.proxy.SchemaMap
- SchemamappingConfig - Class in com.yahoo.config.docproc
-
This class represents the root node of schemamapping Copyright Yahoo.
- SchemamappingConfig(SchemamappingConfig.Builder) - Constructor for class com.yahoo.config.docproc.SchemamappingConfig
- SchemamappingConfig.Builder - Class in com.yahoo.config.docproc
- SchemamappingConfig.Fieldmapping - Class in com.yahoo.config.docproc
-
This class represents schemamapping.fieldmapping[]
- SchemamappingConfig.Fieldmapping.Builder - Class in com.yahoo.config.docproc
- SchemamappingConfig.Producer - Interface in com.yahoo.config.docproc
- serialize(Field, FieldWriter) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- serialize(DocumentUpdateWriter) - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- serialize(DocumentWriter) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- serialize(OutputStream) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- set(String, Number, Metric.Context) - Method in class com.yahoo.docproc.jdisc.metric.NullMetric
- setAcceptingNewProcessings(boolean) - Method in class com.yahoo.docproc.impl.DocprocService
-
Sets whether this service should accept new incoming processings via process(...).
- setApplyOnRestart(boolean) - Method in class com.yahoo.config.docproc.DocprocConfig.Builder
- setApplyOnRestart(boolean) - Method in class com.yahoo.config.docproc.SchemamappingConfig.Builder
- setApplyOnRestart(boolean) - Method in class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig.Builder
- setCallStack(CallStack) - Method in class com.yahoo.docproc.impl.DocprocService
-
Sets a new processing stack for this service.
- setCallStack(CallStack) - Method in class com.yahoo.docproc.impl.ProcessingAccess
- setCallStack(CallStack) - Method in class com.yahoo.docproc.Processing
- setChainsModel(ChainsModel) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- setContainerDocumentConfig(ContainerDocumentConfig) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- setDataType(DataType) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- setDocumentTypeManager(DocumentTypeManager) - Method in class com.yahoo.docproc.impl.DocprocService
- setDocumentTypeManager(DocumentTypeManager) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- setEndpoint(ProcessingEndpoint) - Method in class com.yahoo.docproc.impl.ProcessingAccess
- setEndpoint(ProcessingEndpoint) - Method in class com.yahoo.docproc.Processing
- setExpiresAt(Instant) - Method in class com.yahoo.docproc.Processing
- setFieldMap(Map<Pair<String, String>, String>) - Method in class com.yahoo.docproc.DocumentProcessor
-
Sets the schema map for field names
- setFieldValue(Field, FieldValue) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- setFieldValue(String, FieldValue) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- setId(DocumentId) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- setInService(boolean) - Method in class com.yahoo.docproc.impl.DocprocService
-
Sets whether this should currently perform any processing.
- setLastModified(Long) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- setMaxNumThreads(int) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- setMetric(Metric) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- setName(String) - Method in class com.yahoo.docproc.CallStack
-
Sets the name of this stack
- setSchemaMap(SchemaMap) - Method in class com.yahoo.docproc.jdisc.DocumentProcessingHandlerParameters
- setServiceName(String) - Method in class com.yahoo.docproc.Processing
-
Sets the name of the service processing this.
- setVariable(String, Object) - Method in class com.yahoo.docproc.Processing
-
Sets a context variable.
- SimpleDocumentProcessor - Class in com.yahoo.docproc
-
Simple layer on top of
DocumentProcessor
, in order to make docproc development more user friendly and to the point. - SimpleDocumentProcessor() - Constructor for class com.yahoo.docproc.SimpleDocumentProcessor
- size() - Method in class com.yahoo.docproc.CallStack
-
Returns the number of remaining elements in this stack
- size() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- skip() - Method in class com.yahoo.docproc.jdisc.messagebus.MbusRequestContext
- skip() - Method in interface com.yahoo.docproc.jdisc.RequestContext
- SplitterJoinerDocumentProcessorConfig - Class in com.yahoo.config.docproc
-
This class represents the root node of splitter-joiner-document-processor Copyright Yahoo.
- SplitterJoinerDocumentProcessorConfig(SplitterJoinerDocumentProcessorConfig.Builder) - Constructor for class com.yahoo.config.docproc.SplitterJoinerDocumentProcessorConfig
- SplitterJoinerDocumentProcessorConfig.Builder - Class in com.yahoo.config.docproc
- SplitterJoinerDocumentProcessorConfig.Producer - Interface in com.yahoo.config.docproc
- structTypes() - Method in class com.yahoo.docproc.AbstractConcreteDocumentFactory
T
- timeLeft() - Method in class com.yahoo.docproc.Processing
- toJson() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- toString() - Method in class com.yahoo.docproc.Call
- toString() - Method in class com.yahoo.docproc.CallStack
- toString() - Method in class com.yahoo.docproc.DocumentProcessor.Progress
- toString() - Method in class com.yahoo.docproc.DocumentProcessor
- toString() - Method in class com.yahoo.docproc.jdisc.DocumentProcessingTask
- toString() - Method in class com.yahoo.docproc.Processing
- toString() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- toString() - Method in class com.yahoo.docproc.proxy.ProxyDocumentUpdate
- toXml() - Method in class com.yahoo.docproc.proxy.ProxyDocument
- toXML(String) - Method in class com.yahoo.docproc.proxy.ProxyDocument
- TransientFailureException - Exception in com.yahoo.docproc.impl
-
Exception to be thrown by a document processor on transient failures.
- TransientFailureException(String) - Constructor for exception com.yahoo.docproc.impl.TransientFailureException
V
- value() - Element in annotation interface com.yahoo.docproc.Accesses
- valueOf(String) - Static method in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.yahoo.docproc.jdisc.RequestContext.ErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withReason(String) - Method in class com.yahoo.docproc.DocumentProcessor.Progress
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form