A B C D E G H I L M O P R S T U V W X

A

API - Class in io.pdfdata

This is the entry point to the pdfdata-java library.

API() - Constructor for class io.pdfdata.API

Creates a PDFDATA.io API instance tied to the environment-sourced API endpoint, and using an API key discovered by obtaining the first non-null value, in order, of: the environment variable PDFDATA_APIKEY the system property PDFDATA_APIKEY If an API key cannot be obtained from these sources, then this constructor will throw an IllegalStateException.

API(String) - Constructor for class io.pdfdata.API

Creates a PDFDATA.io API instance with the given API key and tied to the environment-sourced API endpoint.

API(URL) - Constructor for class io.pdfdata.API

Creates a PDFDATA.io API instance tied to the specified API endpoint, and using an API key sourced from the environment as described here.

API(String, URL) - Constructor for class io.pdfdata.API

Creates a PDFDATA.io API instance with the given API key and tied to the specified API endpoint.

API_ENDPOINT - Static variable in class io.pdfdata.API

A URL indicating the default API endpoint that API instances will use unless otherwise configured via API.API(URL) or API.API(String, URL).

APIException - Exception in io.pdfdata

Attachment - Class in io.pdfdata.model

Entity representing a binary attachment to a PDF document, produced by the Attachments op.

Attachment() - Constructor for class io.pdfdata.model.Attachment

Attachments - Class in io.pdfdata.model.ops

Attachments() - Constructor for class io.pdfdata.model.ops.Attachments

Attachments.Result - Class in io.pdfdata.model.ops

B

BitmapResource - Class in io.pdfdata.model

BitmapResource() - Constructor for class io.pdfdata.model.BitmapResource

Bounds - Class in io.pdfdata.model

A rectangular region, represented by its bottom-left (Bounds.lx() and Bounds.by()) and top-right (Bounds.rx() and Bounds.ty()) coordinates.

Bounds(double, double, double, double) - Constructor for class io.pdfdata.model.Bounds

by() - Method in class io.pdfdata.model.Bounds

byID(String) - Method in class io.pdfdata.DocumentsRequest

byID(String) - Method in class io.pdfdata.ProcsRequest

Retrieves a Proc given its ID.

byID(String) - Method in class io.pdfdata.ResourcesRequest

Retrieves a Resource's binary data from the PDFDATA.io API, given its ID, available via ResourcefulEntity.getResourceID().

byURL(URL) - Method in class io.pdfdata.ResourcesRequest

Retrieves a Resource's binary data from the PDFDATA.io API, given its URL.

C

configure() - Method in class io.pdfdata.ProcsRequest

Initializes and returns a builder to configure and start a new Proc.

D

DEFAULT_API_ENDPOINT - Static variable in class io.pdfdata.API

The URL of the default PDFDATA.io API endpoint, as a String.

DEFAULT_LAYOUT - Static variable in class io.pdfdata.model.ops.Text

Dimensions - Class in io.pdfdata.model

Entity conveying the width and height of a region, but not its position (contrast Bounds).

Dimensions(int, int) - Constructor for class io.pdfdata.model.Dimensions

Document - Class in io.pdfdata.model

Entity representing a PDF document.

Document() - Constructor for class io.pdfdata.model.Document

documents() - Method in class io.pdfdata.API

Returns an API facility for working with source PDF Documents.

DocumentsRequest - Class in io.pdfdata

API request facility enabling the uploading of source PDF documents in anticipation of applying Operations to them via new Procs, and the retrieval of metadata related to PDFDATA.io's (temporary) storage of those documents.

E

equals(Object) - Method in class io.pdfdata.model.Bounds

equals(Object) - Method in class io.pdfdata.model.Dimensions

equals(Object) - Method in class io.pdfdata.model.Document

equals(Object) - Method in class io.pdfdata.model.Operation

equals(Object) - Method in class io.pdfdata.model.ops.PageTemplates

equals(Object) - Method in class io.pdfdata.model.ops.Text

equals(Object) - Method in class io.pdfdata.model.TemplateMatch

G

get() - Method in class io.pdfdata.InfoRequest

get() - Method in class io.pdfdata.model.Resource

Retrieves this resource's data from the PDFDATA.io API.

getAPIKey() - Method in class io.pdfdata.API

getAPIVersion() - Method in class io.pdfdata.model.Info

getBounds() - Method in class io.pdfdata.model.Attachment

getBounds() - Method in class io.pdfdata.model.Image

Returns a representation of the on-page bounding box within which the embedded bitmap is rendered.

getBuild() - Method in class io.pdfdata.model.Info

getConnectTimeout() - Method in class io.pdfdata.API

getCreated() - Method in class io.pdfdata.model.Document

getCreated() - Method in class io.pdfdata.model.Proc

getDescription() - Method in class io.pdfdata.model.Attachment

getDimensions() - Method in class io.pdfdata.model.BitmapResource

Returns the dimensions of a bitmap image's raster, in contrast to the bounds within which an embedded PDF image is rendered on a page, provided by Image.getBounds().

getDimensions() - Method in class io.pdfdata.model.Page

getDocIDs() - Method in class io.pdfdata.model.Proc

Returns the set of IDs of Documents included in this proc, only if the proc's status is Proc.Status.PENDING or Proc.Status.REFUSED.

getDocuments() - Method in class io.pdfdata.model.Proc

Returns the documents included in this proc (which carry the results of the Operations applied to them by the proc via ProcessedDocument.getResults()), only if the proc's status is Proc.Status.COMPLETE.

getEndpoint() - Method in class io.pdfdata.API

getErrorResponse() - Method in exception io.pdfdata.APIException

getExpires() - Method in class io.pdfdata.model.Document

getFilename() - Method in class io.pdfdata.model.Document

getHeight() - Method in class io.pdfdata.model.Dimensions

getID() - Method in class io.pdfdata.model.Document

getID() - Method in class io.pdfdata.model.Proc

getLayout() - Method in class io.pdfdata.model.ops.Text

getLocation() - Method in class io.pdfdata.model.Attachment

getMessage() - Method in class io.pdfdata.model.Info

getMimetype() - Method in class io.pdfdata.model.Resource

Returns the MIME type associated with this resource's data.

getOperationName() - Method in class io.pdfdata.model.Operation

getOperations() - Method in class io.pdfdata.model.Proc

getPageCount() - Method in class io.pdfdata.model.Document

getPagenum() - Method in class io.pdfdata.model.Attachment

getPageNumber() - Method in class io.pdfdata.model.Page

getPageNumber() - Method in class io.pdfdata.model.TemplateMatch

getReadTimeout() - Method in class io.pdfdata.API

getRegions() - Method in class io.pdfdata.model.TemplateMatch

Returns the map of region names (as defined in the submitted PageTemplates.Template configuration) to their values as extracted from the page of the source PDF.

getRequestHeaders() - Method in exception io.pdfdata.APIException

getRequestMethod() - Method in exception io.pdfdata.APIException

getRequestParams() - Method in exception io.pdfdata.APIException

getResource() - Method in class io.pdfdata.model.Image

Returns the BitmapResource provides the raster data for this Image and also describes its characteristics beyond those properties provided by generic Resources.

getResource() - Method in class io.pdfdata.model.ResourcefulEntity

Returns this entity's Resource, which provides metadata related to the binary resource data itself (as distinct from this entity's data), as well as a convenience method for easily retrieving said data.

getResourceID() - Method in class io.pdfdata.model.ResourcefulEntity

Returns the resource ID conveyed by the entity's resource property in a successfully-completed Proc response.

getResponseStatus() - Method in exception io.pdfdata.APIException

getResults() - Method in class io.pdfdata.model.ProcessedDocument

Returns the results of applying the operations configured at proc-creation time to this document.

getSourceTags() - Method in class io.pdfdata.model.Proc

getStatus() - Method in class io.pdfdata.model.Proc

getTags() - Method in class io.pdfdata.model.Document

getTemplateName() - Method in class io.pdfdata.model.TemplateMatch

getTemplates() - Method in class io.pdfdata.model.ops.PageTemplates

getTitle() - Method in class io.pdfdata.model.Attachment

getUrl() - Method in exception io.pdfdata.APIException

getUrl() - Method in class io.pdfdata.model.Resource

Returns the API URL by which this resource's data may be retrieved.

getWidth() - Method in class io.pdfdata.model.Dimensions

H

hashCode() - Method in class io.pdfdata.model.Bounds

hashCode() - Method in class io.pdfdata.model.Dimensions

hashCode() - Method in class io.pdfdata.model.Document

hashCode() - Method in class io.pdfdata.model.Operation

hashCode() - Method in class io.pdfdata.model.ops.PageTemplates

hashCode() - Method in class io.pdfdata.model.ops.Text

hashCode() - Method in class io.pdfdata.model.TemplateMatch

I

Image - Class in io.pdfdata.model

Entity representing a bitmap image embedded in a PDF document, produced by the Images op.

Image() - Constructor for class io.pdfdata.model.Image

Images - Class in io.pdfdata.model.ops

Images() - Constructor for class io.pdfdata.model.ops.Images

Images.Page - Class in io.pdfdata.model.ops

Images.Result - Class in io.pdfdata.model.ops

info() - Method in class io.pdfdata.API

Returns an API facility corresponding to the PDFDATA.io API's root informational resource.

Info - Class in io.pdfdata.model

Entity representing the response provided to requests to the PDFDATA.io API's root resource.

Info() - Constructor for class io.pdfdata.model.Info

InfoRequest - Class in io.pdfdata

API request facility corresponding to the PDFDATA.io API's root informational resource.

InfoRequest(API) - Constructor for class io.pdfdata.InfoRequest

io.pdfdata - package io.pdfdata

This package contains API, the primary entry point for all of PDFDATA.io access, and a variety of supporting classes representing different resources available through the API.

io.pdfdata.model - package io.pdfdata.model

This package contains entity classes representing responses produced by the PDFDATA.io API's resources:

io.pdfdata.model.ops - package io.pdfdata.model.ops

This package contains classes modeling each of the PDF content- and data-extraction Operations offered by PDFDATA.io.

L

list() - Method in class io.pdfdata.DocumentsRequest

list(Instant) - Method in class io.pdfdata.DocumentsRequest

lx() - Method in class io.pdfdata.model.Bounds

M

Metadata - Class in io.pdfdata.model.ops

Metadata() - Constructor for class io.pdfdata.model.ops.Metadata

Metadata.Result - Class in io.pdfdata.model.ops

PDF document metadata is an entirely free-form set of key-value pairs.

O

Operation - Class in io.pdfdata.model

Base class representing an operation.

Operation(String) - Constructor for class io.pdfdata.model.Operation

Operation.Result - Class in io.pdfdata.model

Base class representing the result of an Operation applied to a Document within a Proc.

P

Page - Class in io.pdfdata.model

Entity representing a page within a source PDF Document.

Page() - Constructor for class io.pdfdata.model.Page

PageTemplates - Class in io.pdfdata.model.ops

PageTemplates() - Constructor for class io.pdfdata.model.ops.PageTemplates

PageTemplates.Region - Class in io.pdfdata.model.ops

PageTemplates.Result - Class in io.pdfdata.model.ops

PageTemplates.Template - Class in io.pdfdata.model.ops

parseDate(String) - Static method in class io.pdfdata.API

Parses a String in the format used by the PDFDATA.io API (the ISO 8601 string format that corresponds to the standard JavaScript `Date` format).

Proc - Class in io.pdfdata.model

Entity representing a proc, a process running within the PDFDATA.io API that applies Operations to source PDF Documents to extract content and data from them.

Proc() - Constructor for class io.pdfdata.model.Proc

Proc.Status - Enum in io.pdfdata.model

ProcessedDocument - Class in io.pdfdata.model

Entity representing a PDF document as conveyed as part of a Proc response.

ProcessedDocument() - Constructor for class io.pdfdata.model.ProcessedDocument

procs() - Method in class io.pdfdata.API

Returns an API facility for starting new and retrieving existing Procs, which apply content and data extraction Operations to source PDF Documents.

ProcsRequest - Class in io.pdfdata

API request facility enabling the creation of new Procs, and the retrieval of existing Procs.

ProcsRequest.ProcCreationBuilder - Class in io.pdfdata

R

registerResource(Operation.Result) - Method in class io.pdfdata.model.Image

Resource - Class in io.pdfdata.model

Base class for binary data resources produced by some Operations.

Resource() - Constructor for class io.pdfdata.model.Resource

ResourcefulEntity - Class in io.pdfdata.model

Base class for entities that refer to a binary Resource via a resource property in the API response.

ResourcefulEntity() - Constructor for class io.pdfdata.model.ResourcefulEntity

resources() - Method in class io.pdfdata.API

Returns an API facility for retrieving binary data Resources, which are produced by some content and data extraction Operations.

ResourcesRequest - Class in io.pdfdata

API request facility providing access to the binary data contents of PDFDATA.io Resources.

rx() - Method in class io.pdfdata.model.Bounds

S

setConnectTimeout(int) - Method in class io.pdfdata.API

setReadTimeout(int) - Method in class io.pdfdata.API

T

TemplateMatch - Class in io.pdfdata.model

Entity representing a match of a template to a page from a source PDF document, produced by the PageTemplates operation.

TemplateMatch() - Constructor for class io.pdfdata.model.TemplateMatch

Text - Class in io.pdfdata.model.ops

Text() - Constructor for class io.pdfdata.model.ops.Text

Text(Text.Layout) - Constructor for class io.pdfdata.model.ops.Text

Text.Layout - Enum in io.pdfdata.model.ops

Text.Page - Class in io.pdfdata.model.ops

Text.Result - Class in io.pdfdata.model.ops

ty() - Method in class io.pdfdata.model.Bounds

U

upload(File...) - Method in class io.pdfdata.DocumentsRequest

upload(Collection<File>) - Method in class io.pdfdata.DocumentsRequest

upload(Collection<String>, Collection<File>) - Method in class io.pdfdata.DocumentsRequest

V

VERSION - Static variable in class io.pdfdata.API

W

withTemplate(String, PageTemplates.Template) - Method in class io.pdfdata.model.ops.PageTemplates

X

XMPMetadata - Class in io.pdfdata.model.ops

XMPMetadata() - Constructor for class io.pdfdata.model.ops.XMPMetadata

XMPMetadata.Result - Class in io.pdfdata.model.ops

A B C D E G H I L M O P R S T U V W X