Index (Annot8 API 0.5.0 API)

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

A

add(Map<String, Object>) - Method in interface io.annot8.api.properties.MutableProperties: Add all properties from the given map, overwriting values where they already exist
AlreadyExistsException - Exception in io.annot8.api.exceptions: Exception indicating that an attempt has been made to createContent something that already exists, i.e.
AlreadyExistsException(String) - Constructor for exception io.annot8.api.exceptions.AlreadyExistsException: Create an exception with the given message
AlreadyExistsException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.AlreadyExistsException: Create an exception with the given message and a root cause
and(Filter<T>) - Method in interface io.annot8.api.filters.Filter: Combine this filter with another using logical AND
AndFilter<T> - Class in io.annot8.api.filters: Logical AND of filters
AndFilter(Filter<T>...) - Constructor for class io.annot8.api.filters.AndFilter
Annot8Component - Interface in io.annot8.api.components: Base interface from which all other Annot8 components extend.
Annot8ComponentDescriptor<T extends Annot8Component,S extends Settings> - Interface in io.annot8.api.components: Descriptor for an Annot8 component
Annot8Exception - Exception in io.annot8.api.exceptions: Base class for all Annot8 exceptions
Annot8Exception(String) - Constructor for exception io.annot8.api.exceptions.Annot8Exception: Create an exception with the given message
Annot8Exception(String, Throwable) - Constructor for exception io.annot8.api.exceptions.Annot8Exception: Create an exception with the given message and a root cause
Annot8RuntimeException - Exception in io.annot8.api.exceptions: Base class for all Annot8 runtime exceptions
Annot8RuntimeException(String) - Constructor for exception io.annot8.api.exceptions.Annot8RuntimeException: Create an exception with the given message
Annot8RuntimeException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.Annot8RuntimeException: Create an exception with the given message and a root cause
Annotation - Interface in io.annot8.api.annotations: Base annotation interface from which all other annotations extend.
Annotation.Builder - Interface in io.annot8.api.annotations: Builder interface to createContent (immutable) Annotation classes
AnnotationCapability - Interface in io.annot8.api.capabilities: Describes an annotation that is created, processed or deleted
AnnotationReference - Interface in io.annot8.api.references: A reference to an annotation.
AnnotationStore - Interface in io.annot8.api.stores: Base annotations interface from which all other annotation stores extend.

B

BadConfigurationException - Exception in io.annot8.api.exceptions: Exception indicating that an unacceptable configuration has been provided to a component, or required configuration information is missing.
BadConfigurationException(String) - Constructor for exception io.annot8.api.exceptions.BadConfigurationException: Create an exception with the given message
BadConfigurationException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.BadConfigurationException: Create an exception with the given message and a root cause
Bounds - Interface in io.annot8.api.bounds: Base bounds interface from which all other bounds extend.
build() - Method in interface io.annot8.api.helpers.builders.WithBuild: Save content of the builder into an object
build() - Method in interface io.annot8.api.pipelines.Pipeline.Builder
build() - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Build the pipeline descriptor described by this builder

C

capabilities() - Method in interface io.annot8.api.components.Annot8ComponentDescriptor: Get the capabilities of the component, as configured with the current settings
Capabilities - Interface in io.annot8.api.capabilities: Interface for capturing the capabilities of an Annot8 component
Capability - Interface in io.annot8.api.capabilities: Marker interface to indicate that something represents a capability
close() - Method in interface io.annot8.api.components.Annot8Component
ComponentDescription - Annotation Type in io.annot8.api.components.annotations: Human readable component description
ComponentName - Annotation Type in io.annot8.api.components.annotations: Human readable component name, where it differs from the class name
ComponentTags - Annotation Type in io.annot8.api.components.annotations: Human readable tags that can be used to group or classify a component
containsAnnotation(Annotation) - Method in interface io.annot8.api.annotations.Group: Check if the annotation is included in the group.
containsRole(String) - Method in interface io.annot8.api.annotations.Group: Check if role is included in the group
Content<D> - Interface in io.annot8.api.data: Base content interface from which all content implementations extend.
Content.Builder<A extends Content<D>,D> - Interface in io.annot8.api.data: Builder interface to createContent (immutable) Content classes
ContentCapability - Interface in io.annot8.api.capabilities: Describes content that is created, processed or deleted
Context - Interface in io.annot8.api.context: A context defines additional information and resources for the environment in which the components are running.
copy(Annotation) - Method in interface io.annot8.api.stores.AnnotationStore: Clone an existing annotation to createContent a new annotation
copy(Group) - Method in interface io.annot8.api.stores.GroupStore: Clone an existing group to createContent a new group
create() - Method in interface io.annot8.api.data.ItemFactory: Create a new item
create() - Method in interface io.annot8.api.stores.AnnotationStore: Get a builder to createContent a new annotation
create() - Method in interface io.annot8.api.stores.GroupStore: Create a new group
create(Context) - Method in interface io.annot8.api.components.Annot8ComponentDescriptor: Create an instance of the component, with the current settings and using the provided context
create(Item) - Method in interface io.annot8.api.data.ItemFactory: Create a new item with a parent
createChild() - Method in interface io.annot8.api.data.Item: Create a child item of this item, which will be processed independently
createContent(Class<C>) - Method in interface io.annot8.api.data.Item: Create a new content builder to generate content.
creates() - Method in interface io.annot8.api.capabilities.Capabilities: Describes the things (e.g.
creates(Class<T>) - Method in interface io.annot8.api.capabilities.Capabilities: Helper method for filtering Capabilities.creates() to a specific type of Capability

D

defaultValue() - Method in annotation type io.annot8.api.settings.Description: Default value of this parameter
delete(Annotation) - Method in interface io.annot8.api.stores.AnnotationStore: Delete an annotation from the store
delete(Group) - Method in interface io.annot8.api.stores.GroupStore: Delete a group from the store
delete(Collection<Annotation>) - Method in interface io.annot8.api.stores.AnnotationStore: Delete a collection of annotations from the store
delete(Collection<Group>) - Method in interface io.annot8.api.stores.GroupStore: Delete a collection of groups from the store
deleteAll() - Method in interface io.annot8.api.stores.AnnotationStore: Delete all annotations from the store
deleteAll() - Method in interface io.annot8.api.stores.GroupStore: Delete all groups from the store
deletes() - Method in interface io.annot8.api.capabilities.Capabilities: Describes the things (e.g.
deletes(Class<T>) - Method in interface io.annot8.api.capabilities.Capabilities: Helper method for filtering Capabilities.deletes() to a specific type of Capability
Description - Annotation Type in io.annot8.api.settings: Describes a parameter within a settings class.
discard() - Method in interface io.annot8.api.data.Item: Stop processing this item any further.
done() - Static method in interface io.annot8.api.components.responses.SourceResponse: Source is now out of items
DONE - io.annot8.api.components.responses.SourceResponse.Status: Indicates that the source has been exhausted, and will never return any new items.

E

edit(Annotation) - Method in interface io.annot8.api.stores.AnnotationStore: Edit an annotation (saving will replace the old version)
edit(Group) - Method in interface io.annot8.api.stores.GroupStore: Edit an existing group, saving will replace it
empty() - Static method in interface io.annot8.api.components.responses.SourceResponse: The Source is currently empty
EMPTY - io.annot8.api.components.responses.SourceResponse.Status: Indicates that the source is temporarily empty, but that it may have new items in the future.
equals(Properties, Properties) - Static method in interface io.annot8.api.properties.Properties
equals(Object) - Method in class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
equals(Object) - Method in class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder

F

filter(Filter<Annotation>) - Method in interface io.annot8.api.stores.AnnotationStore: Filter annotations to match the test.
filter(Filter<Group>) - Method in interface io.annot8.api.stores.GroupStore: Filter annotations to match the test.
filter(Filter<Content<?>>) - Method in interface io.annot8.api.data.Item: Filter content to match the test.
filter(Filter<T>) - Method in interface io.annot8.api.helpers.WithFilter: Filter to many matching elements
Filter<T> - Interface in io.annot8.api.filters: Filter to test to elements against.
find(Filter<T>) - Method in interface io.annot8.api.helpers.WithFilter: Find a single matching element
from(A) - Method in interface io.annot8.api.helpers.builders.WithFromBuilder: Add the informaton from the provided param
from(PipelineDescriptor) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
from(PipelineDescriptor) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add sources and processors from an existing pipeline descriptor to the one being built

G

get(String) - Method in interface io.annot8.api.properties.Properties: Get the proprety value
get(String, Class<T>) - Method in interface io.annot8.api.properties.Properties: Get the property value of specified class
getAll() - Method in interface io.annot8.api.properties.Properties: Get the properties as a map
getAll() - Method in interface io.annot8.api.stores.AnnotationStore: Get all annotations currently held in this store
getAll() - Method in interface io.annot8.api.stores.GroupStore: Get all groups
getAll(Class<T>) - Method in interface io.annot8.api.properties.Properties: Get all properties which have a value instance of class
getAnnotationId() - Method in interface io.annot8.api.references.AnnotationReference: The annotation's id
getAnnotations() - Method in interface io.annot8.api.annotations.Group: The roles with the associated annotations in this group
getAnnotations() - Method in interface io.annot8.api.data.Content: The annotation store for this content
getAnnotations(String) - Method in interface io.annot8.api.annotations.Group: All the annotations in this group with the specified role
getAnnotationsForContent(Content) - Method in interface io.annot8.api.annotations.Group: Return all the annotations in this group for the specified content.
getAnnotationsForContentAndRole(Content, String) - Method in interface io.annot8.api.annotations.Group: Return all the annotations in this group for the specified content and role.
getBounds() - Method in interface io.annot8.api.annotations.Annotation: Get the Bounds associated with this annotation
getBounds() - Method in interface io.annot8.api.capabilities.AnnotationCapability: The bounds of the annotation
getBounds(Class<B>) - Method in interface io.annot8.api.annotations.Annotation: Get the Bounds associated with this annotation casting it to the bounds provided (if it is of that type / subtype).
getBuilder() - Method in interface io.annot8.api.stores.AnnotationStore: Get a new annotation builder
getBuilder() - Method in interface io.annot8.api.stores.GroupStore: Create a new group builder
getByBounds(Class<B>) - Method in interface io.annot8.api.stores.AnnotationStore: Get all annotations of a given bounds currently held in this store
getByBoundsAndType(Class<B>, String) - Method in interface io.annot8.api.stores.AnnotationStore: Get all annotations of a given bounds and type currently held in this store
getById(String) - Method in interface io.annot8.api.stores.AnnotationStore: Get the annotation with the given ID, if it is currently held in this store
getById(String) - Method in interface io.annot8.api.stores.GroupStore: Get the group with the given ID, if it is currently held in this store
getByType(String) - Method in interface io.annot8.api.stores.AnnotationStore: Get all annotations of a given type currently held in this store
getByType(String) - Method in interface io.annot8.api.stores.GroupStore: Get all groups of a given type currently held in this store
getContent() - Method in interface io.annot8.api.stores.AnnotationStore: Get the content which this store holds annotations for.
getContent(String) - Method in interface io.annot8.api.data.Item: The content object for the specified id
getContentClass() - Method in interface io.annot8.api.data.Content: The top level content interface this object implements
getContentId() - Method in interface io.annot8.api.annotations.Annotation: Get the id of the Content to which this annotation refers
getContentId() - Method in interface io.annot8.api.references.AnnotationReference: The id of the content to which this annotation belongs.
getContents() - Method in interface io.annot8.api.data.Item: All content objects contained within this item
getContents(Class<T>) - Method in interface io.annot8.api.data.Item: All content objects of the specified class contained within this item
getContext() - Method in interface io.annot8.api.pipelines.Pipeline
getData() - Method in interface io.annot8.api.data.Content: The data associated with this content object
getData(C) - Method in interface io.annot8.api.bounds.Bounds: Get the subset of data which is covered by these bounds, returning the data in the native format of the Content.
getData(C, Class<R>) - Method in interface io.annot8.api.bounds.Bounds: Get the subset of data which is covered by these bounds.
getDataClass() - Method in interface io.annot8.api.data.Content: The class of the data stored in this Content object
getDescription() - Method in interface io.annot8.api.helpers.WithDescription: Get the description
getDescription() - Method in interface io.annot8.api.pipelines.Pipeline
getExceptions() - Method in interface io.annot8.api.components.responses.ProcessorResponse: Return any exceptions associated with this response
getExceptions() - Method in class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
getExceptions() - Method in interface io.annot8.api.components.responses.SourceResponse: Return any exceptions associated with this response
getExceptions() - Method in class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder
getFilter() - Method in class io.annot8.api.filters.NotFilter: Get all the sub filter of this operation.
getFilters() - Method in class io.annot8.api.filters.AndFilter: Get all the sub filters of this operation.
getFilters() - Method in class io.annot8.api.filters.OrFilter: Get all the sub filters of this operation.
getGroupId() - Method in interface io.annot8.api.references.GroupReference: Get the id of the group which is referenced
getGroups() - Method in interface io.annot8.api.helpers.WithGroups: Get the group store
getId() - Method in interface io.annot8.api.helpers.WithId: Get the ID
getInstance() - Static method in class io.annot8.api.pipelines.NoOpOrderer
getInstance() - Static method in class io.annot8.api.settings.NoSettings: Get the instance
getItem() - Method in interface io.annot8.api.data.Content: Get the item which this content relates to.
getItem() - Method in interface io.annot8.api.stores.GroupStore: Get the item to which the groups relate.
getName() - Method in interface io.annot8.api.components.Annot8ComponentDescriptor: Get the name of this component
getName() - Method in interface io.annot8.api.helpers.WithName: Get the name
getName() - Method in interface io.annot8.api.pipelines.Pipeline
getObjectOrDefault(String, Object) - Method in interface io.annot8.api.properties.Properties: Get the value or use a default if missing
getOrDefault(String, T) - Method in interface io.annot8.api.properties.Properties: Get a specific class at the key, or use the default
getParent() - Method in interface io.annot8.api.data.Item: Get id of parent
getProcessors() - Method in interface io.annot8.api.pipelines.Pipeline
getProcessors() - Method in interface io.annot8.api.pipelines.PipelineDescriptor: Return an ordered list of ProcessorDescriptors describing the processers that will process data in the pipeline
getProperties() - Method in interface io.annot8.api.helpers.WithMutableProperties: Get the properties
getProperties() - Method in interface io.annot8.api.helpers.WithProperties: Get the properties
getReferences() - Method in interface io.annot8.api.annotations.Group: The associated annotations references in this group
getResource(Class<R>) - Method in interface io.annot8.api.context.Context: Get a single resource which matches.
getResources() - Method in interface io.annot8.api.context.Context: Get all the resources
getResources(Class<R>) - Method in interface io.annot8.api.context.Context: Get all the resources of that class.
getRole(Annotation) - Method in interface io.annot8.api.annotations.Group: Get the role of a specific annotation in this group
getRoles() - Method in interface io.annot8.api.annotations.Group: Return all the roles currently associated with annotations in this group
getSettings() - Method in interface io.annot8.api.components.Annot8ComponentDescriptor: Get the settings for this component
getSources() - Method in interface io.annot8.api.pipelines.Pipeline
getSources() - Method in interface io.annot8.api.pipelines.PipelineDescriptor: Return an ordered list of SourceDescriptors describing the sources that will feed data into the pipeline
getStatus() - Method in interface io.annot8.api.components.responses.ProcessorResponse: Return the status associated with this response
getStatus() - Method in class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
getStatus() - Method in interface io.annot8.api.components.responses.SourceResponse: Return the status associated with this response
getStatus() - Method in class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder
getType() - Method in interface io.annot8.api.capabilities.AnnotationCapability: The type of annotation
getType() - Method in interface io.annot8.api.capabilities.ContentCapability: The type of content
getType() - Method in interface io.annot8.api.capabilities.GroupCapability: The type of group
getType() - Method in interface io.annot8.api.helpers.WithType: Get the type
Group - Interface in io.annot8.api.annotations: Base annotation interface from which all other annotations extend.
Group.Builder - Interface in io.annot8.api.annotations: Builder interface to createContent (immutable) Group classes
GroupCapability - Interface in io.annot8.api.capabilities: Describes a group that is created, processed or deleted
GroupReference - Interface in io.annot8.api.references: A reference to a group.
GroupStore - Interface in io.annot8.api.stores: Base groups interface from which all other group stores extend.

H

has(String) - Method in interface io.annot8.api.properties.Properties: Check if a key exists
has(String, Class<?>) - Method in interface io.annot8.api.properties.Properties: Check if key existing and its value is of a specific class
hasExceptions() - Method in interface io.annot8.api.components.responses.ProcessorResponse: Are exceptions associated with response?
hasExceptions() - Method in interface io.annot8.api.components.responses.SourceResponse: Does this response has exceptions associated with it?
hasExceptions() - Method in class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder
hashCode() - Method in class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
hashCode() - Method in class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder
hashCode(Properties) - Static method in interface io.annot8.api.properties.Properties
hasParent() - Method in interface io.annot8.api.data.Item: Does this item have a parent?

I

ImmutableProperties - Interface in io.annot8.api.properties: Base immutable properties interface from which all other immutable properties extend.
ImmutableProperties.Builder - Interface in io.annot8.api.properties: Builder interface to createContent (immutable) properties classes
IncompleteException - Exception in io.annot8.api.exceptions: Exception indicating that a builder has been asked to createContent a new object without having been given all the required information
IncompleteException(String) - Constructor for exception io.annot8.api.exceptions.IncompleteException: Create an exception with the given message
IncompleteException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.IncompleteException: Create an exception with the given message and a root cause
InvalidBoundsException - Exception in io.annot8.api.exceptions: Runtime exception indicating that an attempt to either createContent or use an invalid Bounds object has been performed.
InvalidBoundsException(String) - Constructor for exception io.annot8.api.exceptions.InvalidBoundsException: Create an exception with the given message *
InvalidBoundsException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.InvalidBoundsException: Create an exception with the given message and a root cause
io.annot8.api - module io.annot8.api: This module contains the api interfaces for use within Annot8.
io.annot8.api.annotations - package io.annot8.api.annotations: This package contains the api interfaces for annotations and groups of annotations.
io.annot8.api.bounds - package io.annot8.api.bounds: This package contains the api interface for bounds.
io.annot8.api.capabilities - package io.annot8.api.capabilities: Package containing classes for describing the capabilities of a component, for example what it creates, processes and deletes.
io.annot8.api.components - package io.annot8.api.components: This package contains the api interface for components.
io.annot8.api.components.annotations - package io.annot8.api.components.annotations
io.annot8.api.components.responses - package io.annot8.api.components.responses: This package contains the response objects returned by some components.
io.annot8.api.context - package io.annot8.api.context: Context is used to pass additional resources and information to a component.
io.annot8.api.data - package io.annot8.api.data: This package contains the api data objects used by Annot8
io.annot8.api.exceptions - package io.annot8.api.exceptions: This package contains the exceptions used by Annot8
io.annot8.api.filters - package io.annot8.api.filters
io.annot8.api.helpers - package io.annot8.api.helpers: This package contains helper interfaces used internally by the Annot8 api module.
io.annot8.api.helpers.builders - package io.annot8.api.helpers.builders: This package contains helper interfaces used internally by builders within the Annot8 api module
io.annot8.api.pipelines - package io.annot8.api.pipelines
io.annot8.api.properties - package io.annot8.api.properties: This package contains the api interface for properties.
io.annot8.api.references - package io.annot8.api.references
io.annot8.api.settings - package io.annot8.api.settings: This package contains the api interface and annotations for the settings objects.
io.annot8.api.stores - package io.annot8.api.stores: This package contains the api interfaces for store objects
isDiscarded() - Method in interface io.annot8.api.data.Item: If this item is to be discarded at the end of current processing
isValid(C) - Method in interface io.annot8.api.bounds.Bounds: Are these bounds valid for the provided content?
Item - Interface in io.annot8.api.data: Item interface used by components.
ITEM_ERROR - io.annot8.api.components.responses.ProcessorResponse.Status: Indicates that an error happened whilst processing this item, but that it should be possible to process other items.
itemError() - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create an ITEM_ERROR response
itemError(Exception...) - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create an ITEM_ERROR response with one or more exception
itemError(Collection<Exception>) - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create an ITEM_ERROR response with a collection of exceptions
ItemFactory - Interface in io.annot8.api.data: Factory to createContent new items.

K

keys() - Method in interface io.annot8.api.properties.Properties: Get all keys

L

listKeys(Class<T>) - Method in interface io.annot8.api.properties.Properties: Get all keys which have the value an instance of class

M

MutableProperties - Interface in io.annot8.api.properties: Base mutable properties interface from which all other mutable properties extend.

N

negate() - Method in interface io.annot8.api.filters.Filter: Negate this filter.
newId() - Method in interface io.annot8.api.helpers.builders.WithNewIdBuilder: Assign a new id to the built object
NoOpOrderer - Class in io.annot8.api.pipelines
NoSettings - Class in io.annot8.api.settings: An empty Settings class.
NotFilter<T> - Class in io.annot8.api.filters: Logical NOT of filter
NotFilter(Filter<T>) - Constructor for class io.annot8.api.filters.NotFilter

O

ok() - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create an OK response with no new items
ok() - Static method in interface io.annot8.api.components.responses.SourceResponse: Create source read items normally
OK - io.annot8.api.components.responses.ProcessorResponse.Status: Indicates that the processor has worked successfully
OK - io.annot8.api.components.responses.SourceResponse.Status: Indicates that the source found new items, and that the pipeline may ask the source for new items again as soon as it is ready.
or(Filter<T>) - Method in interface io.annot8.api.filters.Filter: Combine this filter with another using logical OR
orderProcessors(Collection<ProcessorDescriptor>) - Method in class io.annot8.api.pipelines.NoOpOrderer
orderProcessors(Collection<ProcessorDescriptor>) - Method in interface io.annot8.api.pipelines.PipelineOrderer
orderSources(Collection<SourceDescriptor>) - Method in class io.annot8.api.pipelines.NoOpOrderer
orderSources(Collection<SourceDescriptor>) - Method in interface io.annot8.api.pipelines.PipelineOrderer
OrFilter<T> - Class in io.annot8.api.filters: Logical OR of filters
OrFilter(Filter<T>...) - Constructor for class io.annot8.api.filters.OrFilter

P

Pipeline - Interface in io.annot8.api.pipelines
Pipeline.Builder - Interface in io.annot8.api.pipelines
PipelineDescriptor - Interface in io.annot8.api.pipelines: Describes a pipeline, which is a collection of ordered sources and processors.
PipelineDescriptor.Builder - Interface in io.annot8.api.pipelines: Builder interface for building new pipeline descriptors
PipelineOrderer - Interface in io.annot8.api.pipelines
PipelineRunner - Interface in io.annot8.api.pipelines
process(Item) - Method in interface io.annot8.api.components.Processor: Process the given item
process(Item) - Method in interface io.annot8.api.pipelines.Pipeline
processes() - Method in interface io.annot8.api.capabilities.Capabilities: Describes the things (e.g.
processes(Class<T>) - Method in interface io.annot8.api.capabilities.Capabilities: Helper method for filtering Capabilities.processes() to a specific type of Capability
processingError() - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create a PROCESSOR_ERROR response
processingError(Exception...) - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create an PROCESSOR_ERROR response with one or more exception
processingError(Collection<Exception>) - Static method in interface io.annot8.api.components.responses.ProcessorResponse: Create an PROCESSOR_ERROR response with a collection of exceptions
ProcessingException - Exception in io.annot8.api.exceptions: Generic exception thrown if there is an error during processing of a document.
ProcessingException(String) - Constructor for exception io.annot8.api.exceptions.ProcessingException: Create an exception with the given message
ProcessingException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.ProcessingException: Create an exception with the given message and a root cause
Processor - Interface in io.annot8.api.components: Base processor interface from which all processors extend.
PROCESSOR_ERROR - io.annot8.api.components.responses.ProcessorResponse.Status: Indicates that an error happened whilst processing this item, and that it will prevent other items from being processed.
ProcessorDescriptor<T extends Processor,S extends Settings> - Interface in io.annot8.api.components: Helper interface for using Annot8ComponentDescriptor with Processor interfaces
ProcessorResponse - Interface in io.annot8.api.components.responses: Class to hold the response from a processor.
ProcessorResponse.ProcessorResponseBuilder - Class in io.annot8.api.components.responses
ProcessorResponse.Status - Enum in io.annot8.api.components.responses: Response status returned by the processor
ProcessorResponseBuilder(ProcessorResponse.Status) - Constructor for class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
ProcessorResponseBuilder(ProcessorResponse.Status, Collection<Exception>) - Constructor for class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
Properties - Interface in io.annot8.api.properties: Base properties interface from which all other properties objects/interfaces extend.

R

read(ItemFactory) - Method in interface io.annot8.api.components.Source: Read from the data source and return new items if found
read(ItemFactory) - Method in interface io.annot8.api.pipelines.Pipeline
remove(String) - Method in interface io.annot8.api.properties.MutableProperties: Remove the property for the specified key, and return it's object (if it exists)
remove(Collection<String>) - Method in interface io.annot8.api.properties.MutableProperties: Remove all properties that match the given keys
removeAll() - Method in interface io.annot8.api.properties.MutableProperties: Return a map of all properties
removeContent(Content<?>) - Method in interface io.annot8.api.data.Item: Remove the specified content object from this item
removeContent(String) - Method in interface io.annot8.api.data.Item: Remove the specified content object from this item
Resource - Interface in io.annot8.api.components: A resource is an instance use across one or more components.

S

sameAnnotation(Annotation) - Method in interface io.annot8.api.annotations.Annotation: Do two instances represent the same underlying annotations?
sameGroup(Group) - Method in interface io.annot8.api.annotations.Group: Do two instances represent the same underlying group?
save() - Method in interface io.annot8.api.helpers.builders.WithSave: Save content of the builder into an object
set(String, Object) - Method in interface io.annot8.api.properties.MutableProperties: Set the property value for the specified key
set(Map<String, Object>) - Method in interface io.annot8.api.properties.MutableProperties: Set the current properties to be equal to the map
setName(String) - Method in interface io.annot8.api.components.Annot8ComponentDescriptor: Set the name of this component
setSettings(S) - Method in interface io.annot8.api.components.Annot8ComponentDescriptor: Set the settings for this component
Settings - Interface in io.annot8.api.settings: Base settings interface from which all other settings extend.
SettingsClass - Annotation Type in io.annot8.api.components.annotations: Indicates the settings class used by a component.
Source - Interface in io.annot8.api.components: Base processor interface from which all sources extend.
SOURCE_ERROR - io.annot8.api.components.responses.SourceResponse.Status: Indicates that an error occurred with the source.
SourceDescriptor<T extends Source,S extends Settings> - Interface in io.annot8.api.components: Helper interface for using Annot8ComponentDescriptor with Source interfaces
sourceError() - Static method in interface io.annot8.api.components.responses.SourceResponse: There was an error reading from the Source
sourceError(Exception...) - Static method in interface io.annot8.api.components.responses.SourceResponse: There was an error reading from the Source with one or more exception
sourceError(Collection<Exception>) - Static method in interface io.annot8.api.components.responses.SourceResponse: There was an error reading from the Source with a collection of exceptions
SourceResponse - Interface in io.annot8.api.components.responses: Class to hold the response from a source.
SourceResponse.SourceResponseBuilder - Class in io.annot8.api.components.responses
SourceResponse.Status - Enum in io.annot8.api.components.responses: Response status returned by the source
SourceResponseBuilder(SourceResponse.Status) - Constructor for class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder
SourceResponseBuilder(SourceResponse.Status, Collection<Exception>) - Constructor for class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder
stop() - Method in interface io.annot8.api.pipelines.PipelineRunner

T

test(T) - Method in class io.annot8.api.filters.AndFilter
test(T) - Method in interface io.annot8.api.filters.Filter: Predicate test
test(T) - Method in class io.annot8.api.filters.NotFilter
test(T) - Method in class io.annot8.api.filters.OrFilter
toAnnotation() - Method in interface io.annot8.api.references.AnnotationReference: Convert the reference to an annotations.
toAnnotations(Stream<AnnotationReference>) - Static method in interface io.annot8.api.references.AnnotationReference: Convert a stream of annotation references to annotations
toGroup() - Method in interface io.annot8.api.references.GroupReference: Convert a reference to a group instance.
toGroups(Stream<GroupReference>) - Static method in interface io.annot8.api.references.GroupReference: Convert a stream of group references to groups
toString() - Method in class io.annot8.api.components.responses.ProcessorResponse.ProcessorResponseBuilder
toString() - Method in class io.annot8.api.components.responses.SourceResponse.SourceResponseBuilder

U

UnsupportedContentException - Exception in io.annot8.api.exceptions: Exception indicating that the content type is not supported
UnsupportedContentException(String) - Constructor for exception io.annot8.api.exceptions.UnsupportedContentException: Create an exception with the given message
UnsupportedContentException(String, Throwable) - Constructor for exception io.annot8.api.exceptions.UnsupportedContentException: Create an exception with the given message and a root cause

V

validate() - Method in class io.annot8.api.settings.NoSettings
validate() - Method in interface io.annot8.api.settings.Settings: Check that the settings are sufficiently complete to allow them to be used.
value() - Method in annotation type io.annot8.api.components.annotations.ComponentDescription
value() - Method in annotation type io.annot8.api.components.annotations.ComponentName
value() - Method in annotation type io.annot8.api.components.annotations.ComponentTags
value() - Method in annotation type io.annot8.api.components.annotations.SettingsClass
value() - Method in annotation type io.annot8.api.settings.Description: A description of this parameter
valueOf(String) - Static method in enum io.annot8.api.components.responses.ProcessorResponse.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.annot8.api.components.responses.SourceResponse.Status: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.annot8.api.components.responses.ProcessorResponse.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.annot8.api.components.responses.SourceResponse.Status: Returns an array containing the constants of this enum type, in the order they are declared.

W

withAnnotation(String, Annotation) - Method in interface io.annot8.api.annotations.Group.Builder: Add an annotation to this group with the specified role.
withBounds(Bounds) - Method in interface io.annot8.api.annotations.Annotation.Builder: Set the Bounds associated with this annotation
WithBuild<A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder has a build method.
withContext(Context) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
withData(D) - Method in interface io.annot8.api.data.Content.Builder: Set the data for this content object
withData(Supplier<D>) - Method in interface io.annot8.api.data.Content.Builder: Set the data for this content object, accessed via a supplier
withDescription(String) - Method in interface io.annot8.api.data.Content.Builder: Set the description of this content object
withDescription(String) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
withDescription(String) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Set a description of the pipeline
WithDescription - Interface in io.annot8.api.helpers: Helper interface to indicate that a class has a human readable description
WithFilter<T> - Interface in io.annot8.api.helpers: General interface for filtering elements to find matches.
WithFromBuilder<E,A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder can createContent an object based off an existing object of the same type
WithGroups - Interface in io.annot8.api.helpers: Helper interface to indicate that a class supports GroupStore
withId(String) - Method in interface io.annot8.api.helpers.builders.WithIdBuilder: Set the id
WithId - Interface in io.annot8.api.helpers: Helper interface to indicate that a class has an ID
WithIdBuilder<A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder should assign a provided ID to an object
WithMutableProperties - Interface in io.annot8.api.helpers: Helper interface to indicate that a class supports MutableProperties
withName(String) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
withName(String) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Set the name of the pipeline
WithName - Interface in io.annot8.api.helpers: Helper interface to indicate that a class has an name
WithNewIdBuilder<A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder should assign a new ID to an object
withOrderer(PipelineOrderer) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Set an orderer to order components
withoutProperty(String) - Method in interface io.annot8.api.helpers.builders.WithPropertiesBuilder: Remove a property
withoutProperty(String, Object) - Method in interface io.annot8.api.helpers.builders.WithPropertiesBuilder: Remove a property with matching key and value
withProcessor(Processor) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
withProcessor(ProcessorDescriptor) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add a processor to the pipeline that is being built
withProcessors(ProcessorDescriptor...) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add multiple processors to the pipeline that is being built, in the order provided
withProcessors(Collection<ProcessorDescriptor>) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add multiple processors to the pipeline that is being built, in the order provided
withProperties(Properties) - Method in interface io.annot8.api.helpers.builders.WithPropertiesBuilder: Add in existing properties
WithProperties - Interface in io.annot8.api.helpers: Helper interface to indicate that a class supports ImmutableProperties
WithPropertiesBuilder<A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder should processor adding properties to an object
withProperty(String, Object) - Method in interface io.annot8.api.helpers.builders.WithPropertiesBuilder: Add a property
withPropertyIfPresent(String, Optional<?>) - Method in interface io.annot8.api.helpers.builders.WithPropertiesBuilder: Add a property, if it is present (don't add it otherwise)
withResource(Resource) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
WithSave<A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder has a save method.
withSource(Source) - Method in interface io.annot8.api.pipelines.Pipeline.Builder
withSource(SourceDescriptor) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add a source to the pipeline that is being built
withSources(SourceDescriptor...) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add multiple sources to the pipeline that is being built, in the order provided
withSources(Collection<SourceDescriptor>) - Method in interface io.annot8.api.pipelines.PipelineDescriptor.Builder: Add multiple sources to the pipeline that is being built, in the order provided
withType(String) - Method in interface io.annot8.api.helpers.builders.WithTypeBuilder: Assign a type to the builder
WithType - Interface in io.annot8.api.helpers: Helper interface to indicate that a class has a type
WithTypeBuilder<A> - Interface in io.annot8.api.helpers.builders: Helper interface to indicate that a builder should processor setting a type on an object

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