Index (Apache Tika core 3.2.2 API)

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

ABOUT - Static variable in interface org.apache.tika.metadata.XMP: Unordered text strings of advisories.
ABOUT - Static variable in interface org.apache.tika.metadata.XMPPDF: Unordered text strings of about.
ABS_PEAK_AUDIO_FILE_PATH - Static variable in interface org.apache.tika.metadata.XMPDM: "The absolute path to the file's peak audio file.
AbstractConfig - Class in org.apache.tika.pipes.fetcher.config
AbstractConfig() - Constructor for class org.apache.tika.pipes.fetcher.config.AbstractConfig
AbstractEmbeddedDocumentBytesHandler - Class in org.apache.tika.extractor
AbstractEmbeddedDocumentBytesHandler() - Constructor for class org.apache.tika.extractor.AbstractEmbeddedDocumentBytesHandler
AbstractEmitter - Class in org.apache.tika.pipes.emitter
AbstractEmitter() - Constructor for class org.apache.tika.pipes.emitter.AbstractEmitter
AbstractEncodingDetectorParser - Class in org.apache.tika.parser: Abstract base class for parsers that use the AutoDetectReader and need to use the EncodingDetector configured by TikaConfig
AbstractEncodingDetectorParser() - Constructor for class org.apache.tika.parser.AbstractEncodingDetectorParser
AbstractEncodingDetectorParser(EncodingDetector) - Constructor for class org.apache.tika.parser.AbstractEncodingDetectorParser
AbstractExternalProcessParser - Class in org.apache.tika.parser: Abstract base class for parsers that call external processes.
AbstractExternalProcessParser() - Constructor for class org.apache.tika.parser.AbstractExternalProcessParser
AbstractFetcher - Class in org.apache.tika.pipes.fetcher
AbstractFetcher() - Constructor for class org.apache.tika.pipes.fetcher.AbstractFetcher
AbstractFetcher(String) - Constructor for class org.apache.tika.pipes.fetcher.AbstractFetcher
AbstractMultipleParser - Class in org.apache.tika.parser.multiple: Abstract base class for parser wrappers which may / will process a given stream multiple times, merging the results of the various parsers used.
AbstractMultipleParser(MediaTypeRegistry, Collection<? extends Parser>, Map<String, Param>) - Constructor for class org.apache.tika.parser.multiple.AbstractMultipleParser
AbstractMultipleParser(MediaTypeRegistry, AbstractMultipleParser.MetadataPolicy, Collection<? extends Parser>) - Constructor for class org.apache.tika.parser.multiple.AbstractMultipleParser
AbstractMultipleParser(MediaTypeRegistry, AbstractMultipleParser.MetadataPolicy, Parser...) - Constructor for class org.apache.tika.parser.multiple.AbstractMultipleParser
AbstractMultipleParser.MetadataPolicy - Enum in org.apache.tika.parser.multiple: The various strategies for handling metadata emitted by multiple parsers.
AbstractParser - Class in org.apache.tika.parser: Deprecated.
for removal in 4.x
AbstractParser() - Constructor for class org.apache.tika.parser.AbstractParser: Deprecated.
AbstractRecursiveParserWrapperHandler - Class in org.apache.tika.sax: This is a special handler to be used only with the RecursiveParserWrapper.
AbstractRecursiveParserWrapperHandler(ContentHandlerFactory) - Constructor for class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
AbstractRecursiveParserWrapperHandler(ContentHandlerFactory, int) - Constructor for class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
accept(PipesResult.STATUS) - Method in class org.apache.tika.pipes.PipesReporterBase: Implementations must call this for the includes/excludes filters to work!
ACCEPT_ALL - Static variable in interface org.apache.tika.extractor.EmbeddedBytesSelector
AcceptAll() - Constructor for class org.apache.tika.extractor.EmbeddedBytesSelector.AcceptAll
ACCESSED - Static variable in interface org.apache.tika.metadata.FileSystem
AccessPermissionException - Exception in org.apache.tika.exception: Exception to be thrown when a document does not allow content extraction.
AccessPermissionException() - Constructor for exception org.apache.tika.exception.AccessPermissionException
AccessPermissionException(String) - Constructor for exception org.apache.tika.exception.AccessPermissionException
AccessPermissionException(String, Throwable) - Constructor for exception org.apache.tika.exception.AccessPermissionException
AccessPermissionException(Throwable) - Constructor for exception org.apache.tika.exception.AccessPermissionException
AccessPermissions - Interface in org.apache.tika.metadata: Until we can find a common standard, we'll use these options.
ACKNOWLEDGEMENT - Static variable in interface org.apache.tika.metadata.ClimateForcast
ACRONYM_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
ACTION_TRIGGER - Static variable in interface org.apache.tika.metadata.PDF: This specifies where an action or destination would be found/triggered in the document: on document open, before close, etc.
ACTION_TRIGGERS - Static variable in interface org.apache.tika.metadata.PDF: This is a list of all action or destination triggers contained within a given PDF.
ACTION_TYPES - Static variable in interface org.apache.tika.metadata.PDF
add(int, Metadata, InputStream) - Method in class org.apache.tika.extractor.AbstractEmbeddedDocumentBytesHandler
add(int, Metadata, InputStream) - Method in class org.apache.tika.extractor.BasicEmbeddedDocumentBytesHandler
add(int, Metadata, InputStream) - Method in interface org.apache.tika.extractor.EmbeddedDocumentBytesHandler
add(int, Metadata, InputStream) - Method in class org.apache.tika.pipes.extractor.EmittingEmbeddedDocumentBytesHandler
add(String, String) - Method in class org.apache.tika.metadata.Metadata: Add a metadata name/value mapping.
add(String, String[]) - Method in class org.apache.tika.metadata.Metadata: Add a metadata name/value mapping.
add(String, String, Map<String, String[]>) - Method in interface org.apache.tika.metadata.writefilter.MetadataWriteFilter: Based on the field and value, this filter modifies the field and/or the value to something that should be added to the Metadata object.
add(String, String, Map<String, String[]>) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilter
add(Property, int) - Method in class org.apache.tika.metadata.Metadata: Adds the integer value of the identified metadata property.
add(Property, String) - Method in class org.apache.tika.metadata.Metadata: Add a metadata property/value mapping.
add(Property, Calendar) - Method in class org.apache.tika.metadata.Metadata: Adds the date value of the identified metadata property.
add(RenderResult) - Method in class org.apache.tika.renderer.PageBasedRenderResults
add(RenderResult) - Method in class org.apache.tika.renderer.RenderResults
addAlias(MediaType, MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry
addCloseableResource(Closeable) - Method in class org.apache.tika.io.TikaInputStream
addData(byte[], int, int) - Method in class org.apache.tika.detect.TextStatistics
addException(Exception) - Method in class org.apache.tika.parser.ParseRecord
addingService(ServiceReference) - Method in class org.apache.tika.config.TikaActivator
ADDITIONAL_MODEL_INFO - Static variable in interface org.apache.tika.metadata.IPTC: Information about the ethnicity and other facets of the model(s) in a model-released image.
addMetadata(Metadata) - Method in class org.apache.tika.parser.ParseRecord
addPattern(MimeType, String) - Method in class org.apache.tika.mime.MimeTypes: Adds a file name pattern for the given media type.
addPattern(MimeType, String, boolean) - Method in class org.apache.tika.mime.MimeTypes: Adds a file name pattern for the given media type.
addPipesReporter(PipesReporter) - Method in class org.apache.tika.pipes.CompositePipesReporter
addPrefix(String, String) - Method in class org.apache.tika.sax.xpath.XPathParser
addResource(Closeable) - Method in class org.apache.tika.io.TemporaryResources: Adds a new resource to the set of tracked resources that will all be closed when the TemporaryResources.close() method is called.
addSuperType(MediaType, MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry
addText(char[], int, int) - Method in class org.apache.tika.language.detect.LanguageDetector: Add statistics about this text for the current document.
addText(CharSequence) - Method in class org.apache.tika.language.detect.LanguageDetector: Add to the statistics being accumulated for the current document.
addType(MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry
addWarning(String) - Method in class org.apache.tika.parser.ParseRecord
advance(int) - Method in class org.apache.tika.sax.SecureContentHandler: Records the given number of output characters (or more accurately UTF-16 code units).
ADVISORY - Static variable in interface org.apache.tika.metadata.XMP: Unordered text strings of advisories.
afterRead(int) - Method in class org.apache.tika.io.TikaInputStream
ALBUM - Static variable in interface org.apache.tika.metadata.XMPDM: "The name of the album."
ALBUM_ARTIST - Static variable in interface org.apache.tika.metadata.XMPDM: "The name of the album artist or group for compilation albums."
ALIAS_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
ALIAS_TYPE_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
allowedPolicies - Static variable in class org.apache.tika.parser.multiple.FallbackParser: The different Metadata Policies we support (all)
allowedPolicies - Static variable in class org.apache.tika.parser.multiple.SupplementingParser: The different Metadata Policies we support (not discard)
ALT - org.apache.tika.metadata.Property.PropertyType: An ordered array with some sort of criteria
ALT_TAPE_NAME - Static variable in interface org.apache.tika.metadata.XMPDM: "An alternative tape name, set via the project window or timecode dialog in Premiere.
ALTERNATE_FORMAT_CHUNK - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
ALTITUDE - Static variable in interface org.apache.tika.metadata.Geographic: The WGS84 Altitude of the Point
ALTITUDE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
ALWAYS_ADD_FIELDS - Static variable in class org.apache.tika.metadata.writefilter.StandardWriteFilter
ALWAYS_SET_FIELDS - Static variable in class org.apache.tika.metadata.writefilter.StandardWriteFilter
ANNOTATION_SUBTYPES - Static variable in interface org.apache.tika.metadata.PDF
ANNOTATION_TYPES - Static variable in interface org.apache.tika.metadata.PDF
AnnotationUtils - Class in org.apache.tika.utils: This class contains utilities for dealing with tika annotations
AnnotationUtils() - Constructor for class org.apache.tika.utils.AnnotationUtils
APP_VERSION - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
application(String) - Static method in class org.apache.tika.mime.MediaType
APPLICATION - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
APPLICATION_XML - Static variable in class org.apache.tika.mime.MediaType
APPLICATION_ZIP - Static variable in class org.apache.tika.mime.MediaType
ARCHITECTURE_BITS - Static variable in interface org.apache.tika.metadata.MachineMetadata
ARTIST - Static variable in interface org.apache.tika.metadata.XMPDM: "The name of the artist or artists."
ARTWORK_OR_OBJECT - Static variable in interface org.apache.tika.metadata.IPTC: A set of metadata about artwork or an object in the item
ARTWORK_OR_OBJECT_DETAIL_COPYRIGHT_NOTICE - Static variable in interface org.apache.tika.metadata.IPTC: Contains any necessary copyright notice for claiming the intellectual property for artwork or an object in the image and should identify the current owner of the copyright of this work with associated intellectual property rights.
ARTWORK_OR_OBJECT_DETAIL_CREATOR - Static variable in interface org.apache.tika.metadata.IPTC: Contains the name of the artist who has created artwork or an object in the image.
ARTWORK_OR_OBJECT_DETAIL_DATE_CREATED - Static variable in interface org.apache.tika.metadata.IPTC: Designates the date and optionally the time the artwork or object in the image was created.
ARTWORK_OR_OBJECT_DETAIL_SOURCE - Static variable in interface org.apache.tika.metadata.IPTC: The organisation or body holding and registering the artwork or object in the image for inventory purposes.
ARTWORK_OR_OBJECT_DETAIL_SOURCE_INVENTORY_NUMBER - Static variable in interface org.apache.tika.metadata.IPTC: The inventory number issued by the organisation or body holding and registering the artwork or object in the image.
ARTWORK_OR_OBJECT_DETAIL_TITLE - Static variable in interface org.apache.tika.metadata.IPTC: A reference for the artwork or object in the image.
asInputSource() - Method in class org.apache.tika.detect.AutoDetectReader
ASSEMBLE_DOCUMENT - Static variable in interface org.apache.tika.metadata.AccessPermissions: Can the user insert/rotate/delete pages.
assignFieldParams(Object, Map<String, Param>) - Static method in class org.apache.tika.utils.AnnotationUtils: Assigns the param values to bean
assignValue(Object, Object) - Method in class org.apache.tika.config.ParamField: Sets given value to the annotated field of bean
ASSOCIATED_FILE_RELATIONSHIP - Static variable in interface org.apache.tika.metadata.PDF
AsyncConfig - Class in org.apache.tika.pipes.async
AsyncConfig() - Constructor for class org.apache.tika.pipes.async.AsyncConfig
AsyncEmitter - Class in org.apache.tika.pipes.async: Worker thread that takes EmitData off the queue, batches it and tries to emit it as a batch
AsyncEmitter(AsyncConfig, ArrayBlockingQueue<EmitData>, EmitterManager) - Constructor for class org.apache.tika.pipes.async.AsyncEmitter
AsyncProcessor - Class in org.apache.tika.pipes.async: This is the main class for handling async requests.
AsyncProcessor(Path) - Constructor for class org.apache.tika.pipes.async.AsyncProcessor
AsyncProcessor(Path, PipesIterator) - Constructor for class org.apache.tika.pipes.async.AsyncProcessor
AsyncStatus - Class in org.apache.tika.pipes.async
AsyncStatus() - Constructor for class org.apache.tika.pipes.async.AsyncStatus
AsyncStatus.ASYNC_STATUS - Enum in org.apache.tika.pipes.async
ATTACH_CONTENT_ID - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_CONTENT_LOCATION - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_DISPLAY_NAME - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_EXTENSION - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_FILE_NAME - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_LANGUAGE - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_LONG_FILE_NAME - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_LONG_PATH_NAME - Static variable in interface org.apache.tika.metadata.MAPI
ATTACH_MIME - Static variable in interface org.apache.tika.metadata.MAPI
attachExternalParsers(List<ExternalParser>, TikaConfig) - Static method in class org.apache.tika.parser.external.ExternalParsersFactory
attachExternalParsers(TikaConfig) - Static method in class org.apache.tika.parser.external.ExternalParsersFactory
ATTACHMENT - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
AttributeMatcher - Class in org.apache.tika.sax.xpath: Final evaluation state of a .
AttributeMatcher() - Constructor for class org.apache.tika.sax.xpath.AttributeMatcher
audio(String) - Static method in class org.apache.tika.mime.MediaType
AUDIO_CHANNEL_TYPE - Static variable in interface org.apache.tika.metadata.XMPDM: "The audio channel type."
AUDIO_COMPRESSOR - Static variable in interface org.apache.tika.metadata.XMPDM: "The audio compression used.
AUDIO_MOD_DATE - Static variable in interface org.apache.tika.metadata.XMPDM: "The date and time when the audio was last modified."
AUDIO_SAMPLE_RATE - Static variable in interface org.apache.tika.metadata.XMPDM: "The audio sample rate.
AUDIO_SAMPLE_TYPE - Static variable in interface org.apache.tika.metadata.XMPDM: "The audio sample type."
AUTHOR - Static variable in interface org.apache.tika.metadata.Office: Name of the principal author(s) of a document
AUTHORS_POSITION - Static variable in interface org.apache.tika.metadata.Photoshop
AutoDetectParser - Class in org.apache.tika.parser
AutoDetectParser() - Constructor for class org.apache.tika.parser.AutoDetectParser: Creates an auto-detecting parser instance using the default Tika configuration.
AutoDetectParser(TikaConfig) - Constructor for class org.apache.tika.parser.AutoDetectParser
AutoDetectParser(Detector) - Constructor for class org.apache.tika.parser.AutoDetectParser
AutoDetectParser(Detector, Parser...) - Constructor for class org.apache.tika.parser.AutoDetectParser
AutoDetectParser(Parser...) - Constructor for class org.apache.tika.parser.AutoDetectParser: Creates an auto-detecting parser instance using the specified set of parser.
AutoDetectParserConfig - Class in org.apache.tika.parser: This config object can be used to tune how conservative we want to be when parsing data that is extremely compressible and resembles a ZIP bomb.
AutoDetectParserConfig() - Constructor for class org.apache.tika.parser.AutoDetectParserConfig
AutoDetectParserConfig(Long, Long, Long, Integer, Integer) - Constructor for class org.apache.tika.parser.AutoDetectParserConfig: Creates a SecureContentHandlerConfig using the passed in parameters.
AutoDetectParserFactory - Class in org.apache.tika.parser: Factory for an AutoDetectParser
AutoDetectParserFactory(Map<String, String>) - Constructor for class org.apache.tika.parser.AutoDetectParserFactory
AutoDetectReader - Class in org.apache.tika.detect: An input stream reader that automatically detects the character encoding to be used for converting bytes to characters.
AutoDetectReader(InputStream) - Constructor for class org.apache.tika.detect.AutoDetectReader
AutoDetectReader(InputStream, Metadata) - Constructor for class org.apache.tika.detect.AutoDetectReader
AutoDetectReader(InputStream, Metadata, ServiceLoader) - Constructor for class org.apache.tika.detect.AutoDetectReader
AutoDetectReader(InputStream, Metadata, EncodingDetector) - Constructor for class org.apache.tika.detect.AutoDetectReader
available() - Method in class org.apache.tika.io.BoundedInputStream
available() - Method in class org.apache.tika.io.LookaheadInputStream




B

BAG - org.apache.tika.metadata.Property.PropertyType

An un-ordered array

BasicContentHandlerFactory - Class in org.apache.tika.sax

Basic factory for creating common types of ContentHandlers

BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE, int) - Constructor for class org.apache.tika.sax.BasicContentHandlerFactory

Create a BasicContentHandlerFactory with BasicContentHandlerFactory.throwOnWriteLimitReached is true

BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE, int, boolean, ParseContext) - Constructor for class org.apache.tika.sax.BasicContentHandlerFactory
 
BasicContentHandlerFactory.HANDLER_TYPE - Enum in org.apache.tika.sax

Common handler types for content.

BasicEmbeddedBytesSelector - Class in org.apache.tika.extractor
 
BasicEmbeddedBytesSelector(Set<String>, Set<String>, Set<String>, Set<String>) - Constructor for class org.apache.tika.extractor.BasicEmbeddedBytesSelector
 
BasicEmbeddedDocumentBytesHandler - Class in org.apache.tika.extractor

For now, this is an in-memory EmbeddedDocumentBytesHandler that stores
 all the bytes in memory.

BasicEmbeddedDocumentBytesHandler(EmbeddedDocumentBytesConfig) - Constructor for class org.apache.tika.extractor.BasicEmbeddedDocumentBytesHandler
 
BIG - Static variable in class org.apache.tika.metadata.MachineMetadata.Endian
 
BITS_PER_SAMPLE - Static variable in interface org.apache.tika.metadata.TIFF

"Number of bits per component in each channel."

BODY - org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE
 
BODY_TYPES_PROCESSED - Static variable in interface org.apache.tika.metadata.MAPI
 
BodyContentHandler - Class in org.apache.tika.sax

Content handler decorator that only passes everything inside
 the XHTML <body/> tag to the underlying handler.

BodyContentHandler() - Constructor for class org.apache.tika.sax.BodyContentHandler

Creates a content handler that writes XHTML body character events to
 an internal string buffer.

BodyContentHandler(int) - Constructor for class org.apache.tika.sax.BodyContentHandler

Creates a content handler that writes XHTML body character events to
 an internal string buffer.

BodyContentHandler(Writer) - Constructor for class org.apache.tika.sax.BodyContentHandler

Creates a content handler that writes XHTML body character events to
 the given writer.

BodyContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.BodyContentHandler

Creates a content handler that passes all XHTML body events to the
 given underlying content handler.

BOOLEAN - org.apache.tika.metadata.Property.ValueType
 
BoundedInputStream - Class in org.apache.tika.io

Very slight modification of Commons' BoundedInputStream
 so that we can figure out if this hit the bound or not.

BoundedInputStream(long, InputStream) - Constructor for class org.apache.tika.io.BoundedInputStream
 
BufferUnderrunException() - Constructor for exception org.apache.tika.io.EndianUtils.BufferUnderrunException
 
build() - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
build() - Method in class org.apache.tika.fork.ParserFactoryFactory
 
build() - Method in class org.apache.tika.parser.AutoDetectParserFactory
 
build() - Method in interface org.apache.tika.parser.DigestingParser.DigesterFactory
 
build() - Method in class org.apache.tika.parser.ParserFactory
 
build() - Method in class org.apache.tika.sax.StandardReference.StandardReferenceBuilder
 
build(Path) - Static method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
BUILD - Static variable in interface org.apache.tika.metadata.QuattroPro

Build.

build2() - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder

Initialize the MimeTypes with this builder instance

buildComposite(String, Class<P>, String, Class<T>, InputStream) - Static method in class org.apache.tika.config.ConfigBase

Use this to build a list of components for a composite item (e.g.

buildComposite(String, Class<P>, String, Class<T>, Element) - Static method in class org.apache.tika.config.ConfigBase
 
buildDOM(InputStream) - Static method in class org.apache.tika.utils.XMLReaderUtils

Builds a Document with a DocumentBuilder from the pool

buildDOM(InputStream, ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

This checks context for a user specified DocumentBuilder.

buildDOM(Reader, ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

This checks context for a user specified DocumentBuilder.

buildDOM(String) - Static method in class org.apache.tika.utils.XMLReaderUtils

Builds a Document with a DocumentBuilder from the pool

buildDOM(Path) - Static method in class org.apache.tika.utils.XMLReaderUtils

Builds a Document with a DocumentBuilder from the pool

Builder() - Constructor for class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
buildSingle(String, Class<T>, InputStream) - Static method in class org.apache.tika.config.ConfigBase

Use this to build a single class, where the user specifies the instance class, e.g.

buildSingle(String, Class<T>, Element, T) - Static method in class org.apache.tika.config.ConfigBase

Use this to build a single class, where the user specifies the instance class, e.g.





C

call() - Method in class org.apache.tika.pipes.async.AsyncEmitter
 
call() - Method in class org.apache.tika.pipes.pipesiterator.CallablePipesIterator
 
call() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
CALL - org.apache.tika.pipes.PipesServer.STATUS
 
CallablePipesIterator - Class in org.apache.tika.pipes.pipesiterator

This is a simple wrapper around PipesIterator
 that allows it to be called in its own thread.

CallablePipesIterator(PipesIterator, ArrayBlockingQueue<FetchEmitTuple>) - Constructor for class org.apache.tika.pipes.pipesiterator.CallablePipesIterator

This sets timeoutMillis to -1, meaning that
 this will block forever trying to add fetchemittuples to the queue.

CallablePipesIterator(PipesIterator, ArrayBlockingQueue<FetchEmitTuple>, long) - Constructor for class org.apache.tika.pipes.pipesiterator.CallablePipesIterator

This sets the number of PipesIterator.COMPLETED_SEMAPHORE to 1.

CallablePipesIterator(PipesIterator, ArrayBlockingQueue<FetchEmitTuple>, long, int) - Constructor for class org.apache.tika.pipes.pipesiterator.CallablePipesIterator
 
CAN_MODIFY - Static variable in interface org.apache.tika.metadata.AccessPermissions

Can any modifications be made to the document

CAN_MODIFY_ANNOTATIONS - Static variable in interface org.apache.tika.metadata.AccessPermissions

Can the user modify annotations

CAN_PRINT - Static variable in interface org.apache.tika.metadata.AccessPermissions

Can the user print the document

CAN_PRINT_FAITHFUL - Static variable in interface org.apache.tika.metadata.AccessPermissions

Can the user print an image-degraded version of the document.

CAPTION_WRITER - Static variable in interface org.apache.tika.metadata.Photoshop
 
CaptureGroupMetadataFilter - Class in org.apache.tika.metadata.filter

This filter runs a regex against the first value in the "sourceField".

CaptureGroupMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
cast(InputStream) - Static method in class org.apache.tika.io.TikaInputStream

Returns the given stream casts to a TikaInputStream, or
 null if the stream is not a TikaInputStream.

CATEGORY - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated. 

CATEGORY - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

A categorization of the content of this package.

CATEGORY - Static variable in interface org.apache.tika.metadata.Photoshop
 
CERTIFICATE - Static variable in interface org.apache.tika.metadata.XMPRights

A Web URL for a rights management certificate.

ChannelTypePropertyConverter() - Constructor for class org.apache.tika.metadata.XMPDM.ChannelTypePropertyConverter

Deprecated.
 
CHARACTER_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Characters in the document

CHARACTER_COUNT_WITH_SPACES - Static variable in interface org.apache.tika.metadata.Office

The number of Characters in the document, including spaces

characters - Variable in class org.apache.tika.mime.MimeTypesReader
 
characters(char[], int, int) - Method in class org.apache.tika.mime.MimeTypesReader
 
characters(char[], int, int) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
characters(char[], int, int) - Method in class org.apache.tika.sax.DIFContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.ExpandedTitleContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.LinkContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.PhoneExtractingContentHandler

The characters method is called whenever a Parser wants to pass raw...

characters(char[], int, int) - Method in class org.apache.tika.sax.SafeContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.SecureContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.StandardsExtractingContentHandler

The characters method is called whenever a Parser wants to pass raw
 characters to the ContentHandler.

characters(char[], int, int) - Method in class org.apache.tika.sax.TeeContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.TextContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.ToTextContentHandler

Writes the given characters to the given character stream.

characters(char[], int, int) - Method in class org.apache.tika.sax.ToXMLContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.WriteOutContentHandler

Writes the given characters to the given character stream.

characters(char[], int, int) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
characters(char[], int, int) - Method in class org.apache.tika.sax.xpath.MatchingContentHandler
 
characters(String) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
CHARACTERS_PER_PAGE - Static variable in interface org.apache.tika.metadata.PDF
 
CharsetUtils - Class in org.apache.tika.utils
 
CharsetUtils() - Constructor for class org.apache.tika.utils.CharsetUtils
 
check(String[], int...) - Static method in class org.apache.tika.embedder.ExternalEmbedder

Checks to see if the command can be run.

check(String[], int...) - Static method in class org.apache.tika.parser.external.ExternalParser
 
check(String, int...) - Static method in class org.apache.tika.embedder.ExternalEmbedder

Checks to see if the command can be run.

check(String, int...) - Static method in class org.apache.tika.parser.external.ExternalParser

Checks to see if the command can be run.

CHECK_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
checkActive() - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
checkHasFile() - Static method in class org.apache.tika.detect.FileCommandDetector
 
checkHasFile(String) - Static method in class org.apache.tika.detect.FileCommandDetector
 
checkInitialization(InitializableProblemHandler) - Method in interface org.apache.tika.config.Initializable
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.parser.external2.ExternalParser
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.parser.RegexCaptureParser
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.pipes.CompositePipesReporter
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.pipes.pipesiterator.filelist.FileListPipesIterator
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.pipes.PipesReporterBase
 
checkInitialization(InitializableProblemHandler) - Method in class org.apache.tika.renderer.CompositeRenderer
 
ChildMatcher - Class in org.apache.tika.sax.xpath

Intermediate evaluation state of a .../*... XPath expression.

ChildMatcher(Matcher) - Constructor for class org.apache.tika.sax.xpath.ChildMatcher
 
CITY - Static variable in interface org.apache.tika.metadata.IPTC

Name of the city the content is focussing on -- either the place shown
 in visual media or referenced by text or audio media.

CITY - Static variable in interface org.apache.tika.metadata.Photoshop
 
clean(String) - Static method in class org.apache.tika.sax.CleanPhoneText
 
clean(String) - Static method in class org.apache.tika.utils.CharsetUtils

Handle various common charset name errors, and return something
 that will be considered valid (and is normalized)

CleanPhoneText - Class in org.apache.tika.sax

Class to help de-obfuscate phone numbers in text.

CleanPhoneText() - Constructor for class org.apache.tika.sax.CleanPhoneText
 
cleanSubstitutions - Static variable in class org.apache.tika.sax.CleanPhoneText
 
ClearByAttachmentTypeMetadataFilter - Class in org.apache.tika.metadata.filter

This class clears the entire metadata object if the
 attachment type matches one of the types.

ClearByAttachmentTypeMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.ClearByAttachmentTypeMetadataFilter
 
ClearByAttachmentTypeMetadataFilter(Set<String>) - Constructor for class org.apache.tika.metadata.filter.ClearByAttachmentTypeMetadataFilter
 
ClearByMimeMetadataFilter - Class in org.apache.tika.metadata.filter

This class clears the entire metadata object if the
 mime matches the mime filter.

ClearByMimeMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.ClearByMimeMetadataFilter
 
ClearByMimeMetadataFilter(Set<String>) - Constructor for class org.apache.tika.metadata.filter.ClearByMimeMetadataFilter
 
CLIENT_UNAVAILABLE_WITHIN_MS - org.apache.tika.pipes.PipesResult.STATUS
 
CLIENT_UNAVAILABLE_WITHIN_MS - Static variable in class org.apache.tika.pipes.PipesResult
 
ClimateForcast - Interface in org.apache.tika.metadata

Met keys from NCAR CCSM files in the Climate Forecast Convention.

cloneMetadata(Metadata) - Static method in class org.apache.tika.utils.ParserUtils

Does a deep clone of a Metadata object.

close() - Method in class org.apache.tika.extractor.BasicEmbeddedDocumentBytesHandler
 
close() - Method in class org.apache.tika.fork.ForkParser
 
close() - Method in class org.apache.tika.io.LookaheadInputStream
 
close() - Method in class org.apache.tika.io.TemporaryResources

Closes all tracked resources.

close() - Method in class org.apache.tika.io.TikaInputStream
 
close() - Method in class org.apache.tika.language.detect.LanguageWriter

Ignored.

close() - Method in class org.apache.tika.parser.ParsingReader

Closes the read end of the pipe.

close() - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
close() - Method in class org.apache.tika.pipes.CompositePipesReporter

Tries to close all resources.

close() - Method in class org.apache.tika.pipes.extractor.EmittingEmbeddedDocumentBytesHandler
 
close() - Method in class org.apache.tika.pipes.PipesClient
 
close() - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
close() - Method in class org.apache.tika.pipes.PipesParser
 
close() - Method in class org.apache.tika.pipes.PipesReporter

No-op implementation.

close() - Method in class org.apache.tika.renderer.RenderResult
 
close() - Method in class org.apache.tika.renderer.RenderResults
 
close() - Method in class org.apache.tika.utils.RereadableInputStream

Closes the input stream and removes the temporary file if one was
 created.

CLOSED_CHOICE - org.apache.tika.metadata.Property.ValueType
 
COLOR_MODE - Static variable in interface org.apache.tika.metadata.Photoshop
 
COLUMN_COUNT - Static variable in interface org.apache.tika.metadata.Database
 
COLUMN_NAME - Static variable in interface org.apache.tika.metadata.Database
 
COMMAND_LINE - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
COMMAND_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
COMMENT - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
COMMENT_PERSONS - Static variable in interface org.apache.tika.metadata.Office
 
COMMENT_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
COMMENTS - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
COMMENTS - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
COMPANY - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
compareClassName(Object, Object) - Static method in class org.apache.tika.utils.CompareUtils

Compare two classes by class names.

compareTo(Property) - Method in class org.apache.tika.metadata.Property
 
compareTo(MediaType) - Method in class org.apache.tika.mime.MediaType
 
compareTo(MimeType) - Method in class org.apache.tika.mime.MimeType
 
CompareUtils - Class in org.apache.tika.utils
 
CompareUtils() - Constructor for class org.apache.tika.utils.CompareUtils
 
COMPILATION - Static variable in interface org.apache.tika.metadata.XMPDM

"An album created by various artists."

COMPLETED - org.apache.tika.pipes.async.AsyncStatus.ASYNC_STATUS
 
COMPLETED - org.apache.tika.pipes.pipesiterator.TotalCountResult.STATUS
 
COMPLETED_SEMAPHORE - Static variable in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
COMPOSER - Static variable in interface org.apache.tika.metadata.XMPDM

"The composer's name."

composite(Property, Property[]) - Static method in class org.apache.tika.metadata.Property

Constructs a new composite property from the given primary and array of secondary properties.

COMPOSITE - org.apache.tika.metadata.Property.PropertyType

Multiple child properties

CompositeDetector - Class in org.apache.tika.detect

Content type detector that combines multiple different detection mechanisms.

CompositeDetector(List<Detector>) - Constructor for class org.apache.tika.detect.CompositeDetector
 
CompositeDetector(Detector...) - Constructor for class org.apache.tika.detect.CompositeDetector
 
CompositeDetector(MediaTypeRegistry, List<Detector>) - Constructor for class org.apache.tika.detect.CompositeDetector
 
CompositeDetector(MediaTypeRegistry, List<Detector>, Collection<Class<? extends Detector>>) - Constructor for class org.apache.tika.detect.CompositeDetector
 
CompositeDigester - Class in org.apache.tika.parser.digest
 
CompositeDigester(DigestingParser.Digester...) - Constructor for class org.apache.tika.parser.digest.CompositeDigester
 
CompositeEncodingDetector - Class in org.apache.tika.detect
 
CompositeEncodingDetector(List<EncodingDetector>) - Constructor for class org.apache.tika.detect.CompositeEncodingDetector
 
CompositeEncodingDetector(List<EncodingDetector>, Collection<Class<? extends EncodingDetector>>) - Constructor for class org.apache.tika.detect.CompositeEncodingDetector
 
CompositeExternalParser - Class in org.apache.tika.parser.external

A Composite Parser that wraps up all the available External Parsers,
 and provides an easy way to access them.

CompositeExternalParser() - Constructor for class org.apache.tika.parser.external.CompositeExternalParser
 
CompositeExternalParser(MediaTypeRegistry) - Constructor for class org.apache.tika.parser.external.CompositeExternalParser
 
CompositeMatcher - Class in org.apache.tika.sax.xpath

Composite XPath evaluation state.

CompositeMatcher(Matcher, Matcher) - Constructor for class org.apache.tika.sax.xpath.CompositeMatcher
 
CompositeMetadataFilter - Class in org.apache.tika.metadata.filter
 
CompositeMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.CompositeMetadataFilter
 
CompositeMetadataFilter(List<MetadataFilter>) - Constructor for class org.apache.tika.metadata.filter.CompositeMetadataFilter
 
CompositeMetadataListFilter - Class in org.apache.tika.metadata.listfilter
 
CompositeMetadataListFilter() - Constructor for class org.apache.tika.metadata.listfilter.CompositeMetadataListFilter
 
CompositeMetadataListFilter(List<MetadataListFilter>) - Constructor for class org.apache.tika.metadata.listfilter.CompositeMetadataListFilter
 
CompositeParser - Class in org.apache.tika.parser

Composite parser that delegates parsing tasks to a component parser
 based on the declared content type of the incoming document.

CompositeParser() - Constructor for class org.apache.tika.parser.CompositeParser
 
CompositeParser(MediaTypeRegistry, List<Parser>) - Constructor for class org.apache.tika.parser.CompositeParser
 
CompositeParser(MediaTypeRegistry, List<Parser>, Collection<Class<? extends Parser>>) - Constructor for class org.apache.tika.parser.CompositeParser
 
CompositeParser(MediaTypeRegistry, Parser...) - Constructor for class org.apache.tika.parser.CompositeParser
 
CompositePipesReporter - Class in org.apache.tika.pipes
 
CompositePipesReporter() - Constructor for class org.apache.tika.pipes.CompositePipesReporter
 
CompositeRenderer - Class in org.apache.tika.renderer
 
CompositeRenderer(List<Renderer>) - Constructor for class org.apache.tika.renderer.CompositeRenderer
 
CompositeRenderer(ServiceLoader) - Constructor for class org.apache.tika.renderer.CompositeRenderer
 
CONCATENATE - org.apache.tika.pipes.HandlerConfig.PARSE_MODE
 
ConcurrentUtils - Class in org.apache.tika.utils

Utility Class for Concurrency in Tika

ConcurrentUtils() - Constructor for class org.apache.tika.utils.ConcurrentUtils
 
ConfigBase - Class in org.apache.tika.config
 
ConfigBase() - Constructor for class org.apache.tika.config.ConfigBase
 
ConfigurableThreadPoolExecutor - Interface in org.apache.tika.concurrent

Allows Thread Pool to be Configurable.

configure(String, InputStream) - Method in class org.apache.tika.config.ConfigBase

Use this to configure a subclass of ConfigBase, a single known object.

consume(String) - Method in interface org.apache.tika.parser.external.ExternalParser.LineConsumer

Consume a line

CONTACT - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
CONTACT_INFO_ADDRESS - Static variable in interface org.apache.tika.metadata.IPTC

The contact information address part.

CONTACT_INFO_CITY - Static variable in interface org.apache.tika.metadata.IPTC

The contact information city part.

CONTACT_INFO_COUNTRY - Static variable in interface org.apache.tika.metadata.IPTC

The contact information country part.

CONTACT_INFO_EMAIL - Static variable in interface org.apache.tika.metadata.IPTC

The contact information email address part.

CONTACT_INFO_PHONE - Static variable in interface org.apache.tika.metadata.IPTC

The contact information phone number part.

CONTACT_INFO_POSTAL_CODE - Static variable in interface org.apache.tika.metadata.IPTC

The contact information part denoting the local postal code.

CONTACT_INFO_STATE_PROVINCE - Static variable in interface org.apache.tika.metadata.IPTC

The contact information part denoting regional information such as state or province.

CONTACT_INFO_WEB_URL - Static variable in interface org.apache.tika.metadata.IPTC

The contact information web address part.

CONTAINER_EXCEPTION - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
ContainerExtractor - Interface in org.apache.tika.extractor

Tika container extractor interface.

CONTAINS_DAMAGED_FONT - Static variable in interface org.apache.tika.metadata.PDF

Contains at least one damaged font for at least one character

CONTAINS_ENCAPSULATED_HTML - Static variable in interface org.apache.tika.metadata.RTFMetadata
 
CONTAINS_NON_EMBEDDED_FONT - Static variable in interface org.apache.tika.metadata.PDF

Contains at least one font that is not embedded

CONTENT_DISPOSITION - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_ENCODING - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_LANGUAGE - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_LENGTH - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_LOCATION - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_MD5 - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_STATUS - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

The status of the content.

CONTENT_TYPE - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
CONTENT_TYPE_HINT - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This is currently used to identify Content-Type that may be
 included within a document, such as in html documents
 (e.g.

CONTENT_TYPE_PARSER_OVERRIDE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This is used by parsers to override detection of embedded resources
 with the override detector.

CONTENT_TYPE_USER_OVERRIDE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This is used by users to override detection with the override detector.

ContentHandlerDecorator - Class in org.apache.tika.sax

Decorator base class for the ContentHandler interface.

ContentHandlerDecorator() - Constructor for class org.apache.tika.sax.ContentHandlerDecorator

Creates a decorator that by default forwards incoming SAX events to
 a dummy content handler that simply ignores all the events.

ContentHandlerDecorator(ContentHandler) - Constructor for class org.apache.tika.sax.ContentHandlerDecorator

Creates a decorator for the given SAX event handler.

ContentHandlerDecoratorFactory - Interface in org.apache.tika.sax
 
ContentHandlerFactory - Interface in org.apache.tika.sax

Interface to allow easier injection of code for getting a new ContentHandler

context - Variable in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
CONTRIBUTOR - Static variable in interface org.apache.tika.metadata.DublinCore

An entity responsible for making contributions to the content of the
 resource.

CONTRIBUTOR - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
CONTRIBUTOR - Static variable in interface org.apache.tika.metadata.XMPDC

An entity responsible for making contributions to the content of the
 resource.

CONTROLLED_VOCABULARY_TERM - Static variable in interface org.apache.tika.metadata.IPTC

A term to describe the content of the image by a value from a Controlled
 Vocabulary.

CONVENTIONS - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
CONVERSATION_INDEX - Static variable in interface org.apache.tika.metadata.MAPI
 
CONVERSATION_TOPIC - Static variable in interface org.apache.tika.metadata.MAPI
 
convert(Object) - Static method in class org.apache.tika.metadata.XMPDM.ChannelTypePropertyConverter

Deprecated.
How a standalone converter might work

convertAndSet(Metadata, Object) - Static method in class org.apache.tika.metadata.XMPDM.ChannelTypePropertyConverter

Deprecated.
How convert+set might work

COPYRIGHT - Static variable in interface org.apache.tika.metadata.XMPDM

"The copyright information."

COPYRIGHT_NOTICE - Static variable in interface org.apache.tika.metadata.IPTC

Contains any necessary copyright notice for claiming the intellectual
 property for this item and should identify the current owner of the
 copyright for the item.

COPYRIGHT_OWNER - Static variable in interface org.apache.tika.metadata.IPTC

Owner or owners of the copyright in the licensed image.

COPYRIGHT_OWNER_ID - Static variable in interface org.apache.tika.metadata.IPTC

The ID of the owner or owners of the copyright in the licensed image.

COPYRIGHT_OWNER_ID_WRONG_CASE - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated.
use IPTC.COPYRIGHT_OWNER_ID


COPYRIGHT_OWNER_NAME - Static variable in interface org.apache.tika.metadata.IPTC

The name of the owner or owners of the copyright in the licensed image.

CorruptedFileException - Exception in org.apache.tika.exception

This exception should be thrown when the parse absolutely, positively has to stop.

CorruptedFileException(String) - Constructor for exception org.apache.tika.exception.CorruptedFileException
 
CorruptedFileException(String, Throwable) - Constructor for exception org.apache.tika.exception.CorruptedFileException
 
count() - Method in class org.apache.tika.detect.TextStatistics

Returns the total number of bytes seen so far.

count(int) - Method in class org.apache.tika.detect.TextStatistics

Returns the number of occurrences of the given byte.

countControl() - Method in class org.apache.tika.detect.TextStatistics

Counts control characters (i.e.

countEightBit() - Method in class org.apache.tika.detect.TextStatistics

Counts eight bit characters, i.e. bytes with their highest bit set.

COUNTRY - Static variable in interface org.apache.tika.metadata.IPTC

Full name of the country the content is focussing on -- either the
 country shown in visual media or referenced in text or audio media.

COUNTRY - Static variable in interface org.apache.tika.metadata.Photoshop
 
COUNTRY_CODE - Static variable in interface org.apache.tika.metadata.IPTC

Code of the country the content is focussing on -- either the country
 shown in visual media or referenced in text or audio media.

countSafeAscii() - Method in class org.apache.tika.detect.TextStatistics

Counts "safe" (i.e. seven-bit non-control) ASCII characters.

COVERAGE - Static variable in interface org.apache.tika.metadata.DublinCore

The extent or scope of the content of the resource.

COVERAGE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
COVERAGE - Static variable in interface org.apache.tika.metadata.XMPDC

The extent or scope of the content of the resource.

CRASHED - org.apache.tika.pipes.async.AsyncStatus.ASYNC_STATUS
 
create() - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates an empty instance; same as calling new MimeTypes().

create() - Static method in class org.apache.tika.parser.external.ExternalParsersFactory
 
create(InputStream) - Static method in class org.apache.tika.mime.MimeTypesFactory
 
create(InputStream...) - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates and returns a MimeTypes instance from the specified input stream.

create(String) - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates and returns a MimeTypes instance from the specified file path,
 as interpreted by the class loader in getResource().

create(String, String) - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates and returns a MimeTypes instance.

create(String, String, ClassLoader) - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates and returns a MimeTypes instance.

create(String, ServiceLoader) - Static method in class org.apache.tika.parser.external.ExternalParsersFactory
 
create(URL) - Static method in class org.apache.tika.mime.MimeTypesFactory
 
create(URL...) - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates and returns a MimeTypes instance from the resource
 at the location specified by the URL.

create(URL...) - Static method in class org.apache.tika.parser.external.ExternalParsersFactory
 
create(ServiceLoader) - Static method in class org.apache.tika.parser.external.ExternalParsersFactory
 
create(Document) - Static method in class org.apache.tika.mime.MimeTypesFactory

Creates and returns a MimeTypes instance from the specified document.

CREATE_DATE - Static variable in interface org.apache.tika.metadata.XMP

The date and time the resource was created.

CREATED - Static variable in interface org.apache.tika.metadata.DublinCore

Date of creation of the resource.

CREATED - Static variable in interface org.apache.tika.metadata.FileSystem
 
CREATED - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
CREATED - Static variable in interface org.apache.tika.metadata.XMPDC

Date of creation of the resource.

createTempFile() - Method in class org.apache.tika.io.TemporaryResources
 
createTempFile(String) - Method in class org.apache.tika.io.TemporaryResources

Creates a temporary file that will automatically be deleted when
 the TemporaryResources.close() method is called, returning its path.

createTempFile(Metadata) - Method in class org.apache.tika.io.TemporaryResources

Creates a temporary file that will automatically be deleted when
 the TemporaryResources.close() method is called, returning its path.

createTemporaryFile() - Method in class org.apache.tika.io.TemporaryResources

Creates and returns a temporary file that will automatically be
 deleted when the TemporaryResources.close() method is called.

CREATION_DATE - Static variable in interface org.apache.tika.metadata.Office

When was the document created?

CreativeCommons - Interface in org.apache.tika.metadata

A collection of Creative Commons properties names.

CREATOR - Static variable in interface org.apache.tika.metadata.DublinCore

An entity primarily responsible for making the content of the resource.

CREATOR - Static variable in interface org.apache.tika.metadata.IPTC

Contains the name of the person who created the content of this item, a
 photographer for photos, a graphic artist for graphics, or a writer for
 textual news, but in cases where the photographer should not be
 identified the name of a company or organisation may be appropriate.

CREATOR - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
CREATOR - Static variable in interface org.apache.tika.metadata.XMPDC

An entity primarily responsible for making the content of the resource.

CREATOR_TOOL - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
CREATOR_TOOL - Static variable in interface org.apache.tika.metadata.XMP

The name of the first known tool used to create the resource.

CREATORS_CONTACT_INFO - Static variable in interface org.apache.tika.metadata.IPTC

The creator's contact information provides all necessary information to
 get in contact with the creator of this item and comprises a set of
 sub-properties for proper addressing.

CREATORS_JOB_TITLE - Static variable in interface org.apache.tika.metadata.IPTC

Contains the job title of the person who created the content of this
 item.

CREDIT - Static variable in interface org.apache.tika.metadata.Photoshop
 
CREDIT_LINE - Static variable in interface org.apache.tika.metadata.IPTC

The credit to person(s) and/or organisation(s) required by the supplier
 of the item to be used when published.

CryptoParser - Class in org.apache.tika.parser

Decrypts the incoming document stream and delegates further parsing to
 another parser instance.

CryptoParser(String, Provider, Set<MediaType>) - Constructor for class org.apache.tika.parser.CryptoParser
 
CryptoParser(String, Set<MediaType>) - Constructor for class org.apache.tika.parser.CryptoParser
 
CURRENT - org.apache.tika.config.TikaConfigSerializer.Mode

Current config, roughly as loaded

CUSTOM_MIMES_SYS_PROP - Static variable in class org.apache.tika.mime.MimeTypesFactory

System property to set a path to an additional external custom mimetypes
 XML file to be loaded.





D

Database - Interface in org.apache.tika.metadata
 
DATE - org.apache.tika.metadata.Property.ValueType
 
DATE - Static variable in interface org.apache.tika.metadata.DublinCore

A date associated with an event in the life cycle of the resource.

DATE - Static variable in interface org.apache.tika.metadata.XMPDC

A date associated with an event in the life cycle of the resource.

DATE_CREATED - Static variable in interface org.apache.tika.metadata.IPTC

Designates the date and optionally the time the intellectual content was
 created rather than the date of the creation of the physical
 representation.

DATE_CREATED - Static variable in interface org.apache.tika.metadata.Photoshop
 
DateNormalizingMetadataFilter - Class in org.apache.tika.metadata.filter

Some dates in some file formats do not have a timezone.

DateNormalizingMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.DateNormalizingMetadataFilter
 
DateUtils - Class in org.apache.tika.utils

Date related utility methods and constants

DateUtils() - Constructor for class org.apache.tika.utils.DateUtils
 
decode(char[]) - Static method in class org.apache.tika.mime.HexCoDec

Decode an array of hex chars

decode(char[], int, int) - Static method in class org.apache.tika.mime.HexCoDec

Decode an array of hex chars.

decode(String) - Static method in class org.apache.tika.mime.HexCoDec

Decode a hex string

decorate(ContentHandler, Metadata, ParseContext) - Method in interface org.apache.tika.sax.ContentHandlerDecoratorFactory
 
decrementEmbeddedDepth() - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler

This is called by RecursiveMetadataContentHandlerProxy as it
 cannot call endEmbeddedDocument().

DEFAULT - Static variable in interface org.apache.tika.config.InitializableProblemHandler
 
DEFAULT - Static variable in class org.apache.tika.config.ParamField
 
DEFAULT - Static variable in class org.apache.tika.parser.AutoDetectParserConfig
 
DEFAULT_HANDLER_CONFIG - Static variable in class org.apache.tika.pipes.HandlerConfig
 
DEFAULT_MAX_EMBEDDED_BYTES_FOR_EXTRACTION - Static variable in class org.apache.tika.extractor.RUnpackExtractorFactory
 
DEFAULT_MAX_ENTITY_EXPANSIONS - Static variable in class org.apache.tika.utils.XMLReaderUtils
 
DEFAULT_MAX_FIELD_SIZE - Static variable in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_MAX_FOR_EMIT_BATCH - Static variable in class org.apache.tika.pipes.PipesConfigBase

default size to send back to the PipesClient for batch
 emitting.

DEFAULT_MAX_JSON_STRING_FIELD_LENGTH - Static variable in class org.apache.tika.config.TikaConfig
 
DEFAULT_MAX_KEY_SIZE - Static variable in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
DEFAULT_MAX_VALUES_PER_FIELD - Static variable in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
DEFAULT_MAX_WAIT_MS - Static variable in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
DEFAULT_NUM_CLIENTS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_NUM_REUSES - Static variable in class org.apache.tika.utils.XMLReaderUtils
 
DEFAULT_ON_PARSE_EXCEPTION - Static variable in class org.apache.tika.pipes.FetchEmitTuple
 
DEFAULT_POOL_SIZE - Static variable in class org.apache.tika.utils.XMLReaderUtils

Default size for the pool of SAX Parsers
 and the pool of DOM builders

DEFAULT_QUEUE_SIZE - Static variable in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_STALE_FETCHER_DELAY_SECONDS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_STALE_FETCHER_TIMEOUT_SECONDS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_STARTUP_TIMEOUT_MILLIS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_TIMEOUT_MILLIS - Static variable in class org.apache.tika.pipes.PipesConfigBase
 
DEFAULT_TIMEOUT_MS - Static variable in class org.apache.tika.parser.external2.ExternalParser
 
DEFAULT_TOTAL_ESTIMATED_BYTES - Static variable in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
DefaultDetector - Class in org.apache.tika.detect

A composite detector based on all the Detector implementations
 available through the service provider mechanism.

DefaultDetector() - Constructor for class org.apache.tika.detect.DefaultDetector
 
DefaultDetector(ClassLoader) - Constructor for class org.apache.tika.detect.DefaultDetector
 
DefaultDetector(MimeTypes) - Constructor for class org.apache.tika.detect.DefaultDetector
 
DefaultDetector(MimeTypes, ClassLoader) - Constructor for class org.apache.tika.detect.DefaultDetector
 
DefaultDetector(MimeTypes, ServiceLoader) - Constructor for class org.apache.tika.detect.DefaultDetector
 
DefaultDetector(MimeTypes, ServiceLoader, Collection<Class<? extends Detector>>) - Constructor for class org.apache.tika.detect.DefaultDetector
 
DefaultEmbeddedStreamTranslator - Class in org.apache.tika.extractor

Loads EmbeddedStreamTranslators via service loading.

DefaultEmbeddedStreamTranslator() - Constructor for class org.apache.tika.extractor.DefaultEmbeddedStreamTranslator
 
DefaultEncodingDetector - Class in org.apache.tika.detect

A composite encoding detector based on all the EncodingDetector implementations
 available through the service provider mechanism.

DefaultEncodingDetector() - Constructor for class org.apache.tika.detect.DefaultEncodingDetector
 
DefaultEncodingDetector(ServiceLoader) - Constructor for class org.apache.tika.detect.DefaultEncodingDetector
 
DefaultEncodingDetector(ServiceLoader, Collection<Class<? extends EncodingDetector>>) - Constructor for class org.apache.tika.detect.DefaultEncodingDetector
 
DefaultMetadataFilter - Class in org.apache.tika.metadata.filter
 
DefaultMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.DefaultMetadataFilter
 
DefaultMetadataFilter(List<MetadataFilter>) - Constructor for class org.apache.tika.metadata.filter.DefaultMetadataFilter
 
DefaultMetadataFilter(ServiceLoader) - Constructor for class org.apache.tika.metadata.filter.DefaultMetadataFilter
 
DefaultParser - Class in org.apache.tika.parser

A composite parser based on all the Parser implementations
 available through the
 service provider mechanism.

DefaultParser() - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(ClassLoader) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(MediaTypeRegistry) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(MediaTypeRegistry, ClassLoader) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(MediaTypeRegistry, ServiceLoader) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(MediaTypeRegistry, ServiceLoader, Collection<Class<? extends Parser>>) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(MediaTypeRegistry, ServiceLoader, Collection<Class<? extends Parser>>, EncodingDetector, Renderer) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultParser(MediaTypeRegistry, ServiceLoader, EncodingDetector, Renderer) - Constructor for class org.apache.tika.parser.DefaultParser
 
DefaultProbDetector - Class in org.apache.tika.detect

A version of DefaultDetector for probabilistic mime
 detectors, which use statistical techniques to blend the
 results of differing underlying detectors when attempting
 to detect the type of a given file.

DefaultProbDetector() - Constructor for class org.apache.tika.detect.DefaultProbDetector
 
DefaultProbDetector(ClassLoader) - Constructor for class org.apache.tika.detect.DefaultProbDetector
 
DefaultProbDetector(MimeTypes) - Constructor for class org.apache.tika.detect.DefaultProbDetector
 
DefaultProbDetector(ProbabilisticMimeDetectionSelector, ClassLoader) - Constructor for class org.apache.tika.detect.DefaultProbDetector
 
DefaultProbDetector(ProbabilisticMimeDetectionSelector, ServiceLoader) - Constructor for class org.apache.tika.detect.DefaultProbDetector
 
DefaultTranslator - Class in org.apache.tika.language.translate

A translator which picks the first available Translator
 implementations available through the
 service provider mechanism.

DefaultTranslator() - Constructor for class org.apache.tika.language.translate.DefaultTranslator
 
DefaultTranslator(ServiceLoader) - Constructor for class org.apache.tika.language.translate.DefaultTranslator
 
DelegatingParser - Class in org.apache.tika.parser

Base class for parser implementations that want to delegate parts of the
 task of parsing an input document to another parser.

DelegatingParser() - Constructor for class org.apache.tika.parser.DelegatingParser
 
DERIVED_FROM_DOCUMENTID - Static variable in interface org.apache.tika.metadata.XMPMM

Document id for the document that this document
 was derived from

DERIVED_FROM_INSTANCEID - Static variable in interface org.apache.tika.metadata.XMPMM

Instance id for the document instance that this
 document was derived from

descend(String, String) - Method in class org.apache.tika.sax.xpath.ChildMatcher
 
descend(String, String) - Method in class org.apache.tika.sax.xpath.CompositeMatcher
 
descend(String, String) - Method in class org.apache.tika.sax.xpath.Matcher

Returns the XPath evaluation state that results from descending
 to a child element with the given name.

descend(String, String) - Method in class org.apache.tika.sax.xpath.NamedElementMatcher
 
descend(String, String) - Method in class org.apache.tika.sax.xpath.SubtreeMatcher
 
DESCRIPTION - Static variable in interface org.apache.tika.metadata.DublinCore

An account of the content of the resource.

DESCRIPTION - Static variable in interface org.apache.tika.metadata.IPTC

A textual description, including captions, of the item's content,
 particularly used where the object is not text.

DESCRIPTION - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
DESCRIPTION - Static variable in interface org.apache.tika.metadata.XMPDC

An account of the content of the resource.

DESCRIPTION_WRITER - Static variable in interface org.apache.tika.metadata.IPTC

Identifier or the name of the person involved in writing, editing or
 correcting the description of the content.

DESCRIPTOR_NODE_ID - Static variable in interface org.apache.tika.metadata.PST
 
detect() - Method in class org.apache.tika.language.detect.LanguageDetector
 
detect(byte[]) - Method in class org.apache.tika.Tika

Detects the media type of the given document.

detect(byte[], String) - Method in class org.apache.tika.Tika

Detects the media type of the given document.

detect(File) - Method in class org.apache.tika.Tika

Detects the media type of the given file.

detect(InputStream) - Method in class org.apache.tika.Tika

Detects the media type of the given document.

detect(InputStream, String) - Method in class org.apache.tika.Tika

Detects the media type of the given document.

detect(InputStream, Metadata) - Method in class org.apache.tika.detect.CompositeDetector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.detect.CompositeEncodingDetector
 
detect(InputStream, Metadata) - Method in interface org.apache.tika.detect.Detector

Detects the content type of the given input document.

detect(InputStream, Metadata) - Method in class org.apache.tika.detect.EmptyDetector
 
detect(InputStream, Metadata) - Method in interface org.apache.tika.detect.EncodingDetector

Detects the character encoding of the given text document, or
 null if the encoding of the document can not be detected.

detect(InputStream, Metadata) - Method in class org.apache.tika.detect.FileCommandDetector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.detect.MagicDetector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.detect.NameDetector

Detects the content type of an input document based on the document
 name given in the input metadata.

detect(InputStream, Metadata) - Method in class org.apache.tika.detect.NonDetectingEncodingDetector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.detect.OverrideDetector

Deprecated.
 
detect(InputStream, Metadata) - Method in class org.apache.tika.detect.TextDetector

Looks at the beginning of the document input stream to determine
 whether the document is text or not.

detect(InputStream, Metadata) - Method in class org.apache.tika.detect.TrainedModelDetector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.detect.TypeDetector

Detects the content type of an input document based on a type hint
 given in the input metadata.

detect(InputStream, Metadata) - Method in class org.apache.tika.detect.ZeroSizeFileDetector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.mime.MimeTypes

Automatically detects the MIME type of a document based on magic
 markers in the stream prefix and any given metadata hints.

detect(InputStream, Metadata) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector
 
detect(InputStream, Metadata) - Method in class org.apache.tika.Tika

Detects the media type of the given document.

detect(CharSequence) - Method in class org.apache.tika.language.detect.LanguageDetector
 
detect(String) - Method in class org.apache.tika.Tika

Detects the media type of a document with the given file name.

detect(URL) - Method in class org.apache.tika.Tika

Detects the media type of the resource at the given URL.

detect(Path) - Method in class org.apache.tika.Tika

Detects the media type of the file at the given path.

detectAll() - Method in class org.apache.tika.language.detect.LanguageDetector

Detect languages based on previously submitted text (via addText calls).

detectAll(String) - Method in class org.apache.tika.language.detect.LanguageDetector

Utility wrapper that detects the language of a given chunk of text.

DETECTED - org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY
 
DETECTED_ENCODING - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

When an EncodingDetector detects an encoding, the encoding should be stored in this field.

Detector - Interface in org.apache.tika.detect

Content type detector.

DIFContentHandler - Class in org.apache.tika.sax
 
DIFContentHandler(ContentHandler, Metadata) - Constructor for class org.apache.tika.sax.DIFContentHandler
 
digest(InputStream, Metadata, ParseContext) - Method in class org.apache.tika.parser.digest.CompositeDigester
 
digest(InputStream, Metadata, ParseContext) - Method in class org.apache.tika.parser.digest.InputStreamDigester
 
digest(InputStream, Metadata, ParseContext) - Method in interface org.apache.tika.parser.DigestingParser.Digester

Digests an InputStream and sets the appropriate value(s) in the metadata.

DigestingParser - Class in org.apache.tika.parser
 
DigestingParser(Parser, DigestingParser.Digester, boolean) - Constructor for class org.apache.tika.parser.DigestingParser

Creates a decorator for the given parser.

DigestingParser.Digester - Interface in org.apache.tika.parser

Interface for digester.

DigestingParser.DigesterFactory - Interface in org.apache.tika.parser

This is used in AutoDetectParserConfig to (optionally)
 wrap the parser in a digesting parser.

DigestingParser.Encoder - Interface in org.apache.tika.parser

Encodes byte array from a MessageDigest to String

DIGITAL_IMAGE_GUID - Static variable in interface org.apache.tika.metadata.IPTC

Globally unique identifier for the item.

DIGITAL_SOURCE_FILE_TYPE - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated. 

DIGITAL_SOURCE_TYPE - Static variable in interface org.apache.tika.metadata.IPTC

The type of the source of this digital image

DISC_NUMBER - Static variable in interface org.apache.tika.metadata.XMPDM

"The disc number for part of an album set."

DISCARD_ALL - org.apache.tika.parser.multiple.AbstractMultipleParser.MetadataPolicy

Before moving onto another parser, throw away
 all previously seen metadata

dispose() - Method in class org.apache.tika.io.TemporaryResources

Calls the TemporaryResources.close() method and wraps the potential
 IOException into a TikaException for convenience
 when used within Tika.

DOC_INFO_CREATED - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_CREATOR - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_CREATOR_TOOL - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_KEY_WORDS - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_MODIFICATION_DATE - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_PRODUCER - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_SUBJECT - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_TITLE - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_INFO_TRAPPED - Static variable in interface org.apache.tika.metadata.PDF
 
DOC_SECURITY - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
DOC_SECURITY_STRING - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
DOCUMENTID - Static variable in interface org.apache.tika.metadata.XMPMM

The common identifier for all versions and renditions of a resource.

DocumentSelector - Interface in org.apache.tika.extractor

Interface for different document selection strategies for purposes like
 embedded document extraction by a ContainerExtractor instance.

DublinCore - Interface in org.apache.tika.metadata

A collection of Dublin Core metadata names.

DURATION - Static variable in interface org.apache.tika.metadata.XMPDM

"The duration of the media file."





E

element(String, String) - Method in class org.apache.tika.sax.XHTMLContentHandler

Emits an XHTML element with the given text content.

ElementMappingContentHandler - Class in org.apache.tika.sax

Content handler decorator that maps element QNames using
 a Map.

ElementMappingContentHandler(ContentHandler, Map<QName, ElementMappingContentHandler.TargetElement>) - Constructor for class org.apache.tika.sax.ElementMappingContentHandler
 
ElementMappingContentHandler.TargetElement - Class in org.apache.tika.sax
 
ElementMatcher - Class in org.apache.tika.sax.xpath

Final evaluation state of an XPath expression that targets an element.

ElementMatcher() - Constructor for class org.apache.tika.sax.xpath.ElementMatcher
 
EMB_APP_VERSION - Static variable in interface org.apache.tika.metadata.RTFMetadata

if an application and version is given as part of the
 embedded object, this is the literal string

EMB_CLASS - Static variable in interface org.apache.tika.metadata.RTFMetadata
 
EMB_ITEM - Static variable in interface org.apache.tika.metadata.RTFMetadata
 
EMB_TOPIC - Static variable in interface org.apache.tika.metadata.RTFMetadata
 
embed(Metadata, InputStream, OutputStream, ParseContext) - Method in interface org.apache.tika.embedder.Embedder

Embeds related document metadata from the given metadata object into the
 given output stream.

embed(Metadata, InputStream, OutputStream, ParseContext) - Method in class org.apache.tika.embedder.ExternalEmbedder

Executes the configured external command and passes the given document
 stream as a simple XHTML document to the given SAX content handler.

EMBEDDED_BYTES_EXCEPTION - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EMBEDDED_DEPTH - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EMBEDDED_EXCEPTION - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EMBEDDED_FILE_ANNOTATION_TYPE - Static variable in interface org.apache.tika.metadata.PDF

If the file came from an annotation and there was a type

EMBEDDED_FILE_DESCRIPTION - Static variable in interface org.apache.tika.metadata.PDF
 
EMBEDDED_FILE_SUBTYPE - Static variable in interface org.apache.tika.metadata.PDF

literal string from the PDEmbeddedFile#getSubtype(), should be what the PDF
     alleges is the embedded file's mime type

EMBEDDED_ID - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This is a 1-index counter for embedded files, used by the RecursiveParserWrapper

EMBEDDED_ID_PATH - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This tracks the embedded file paths based on the embedded file's
 TikaCoreProperties.EMBEDDED_ID.

EMBEDDED_PARSER - Static variable in class org.apache.tika.utils.ParserUtils
 
EMBEDDED_RELATIONSHIP_ID - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EMBEDDED_RESOURCE_LIMIT_REACHED - Static variable in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
 
EMBEDDED_RESOURCE_PATH - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This tracks the embedded file paths based on the name of embedded files
 where available.

EMBEDDED_RESOURCE_TYPE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Embedded resource type property

EMBEDDED_RESOURCE_TYPE_KEY - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EMBEDDED_STORAGE_CLASS_ID - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EMBEDDED_WARNING - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
EmbeddedBytesSelector - Interface in org.apache.tika.extractor
 
EmbeddedBytesSelector.AcceptAll - Class in org.apache.tika.extractor
 
EmbeddedContentHandler - Class in org.apache.tika.sax

Content handler decorator that prevents the EmbeddedContentHandler.startDocument()
 and EmbeddedContentHandler.endDocument() events from reaching the decorated handler.

EmbeddedContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.EmbeddedContentHandler

Created a decorator that prevents the given handler from
 receiving EmbeddedContentHandler.startDocument() and EmbeddedContentHandler.endDocument()
 events.

EmbeddedDocumentBytesConfig - Class in org.apache.tika.pipes.extractor
 
EmbeddedDocumentBytesConfig() - Constructor for class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig

Create an EmbeddedDocumentBytesConfig with
 EmbeddedDocumentBytesConfig.extractEmbeddedDocumentBytes
 set to true

EmbeddedDocumentBytesConfig(boolean) - Constructor for class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY - Enum in org.apache.tika.pipes.extractor
 
EmbeddedDocumentBytesHandler - Interface in org.apache.tika.extractor
 
EmbeddedDocumentByteStoreExtractorFactory - Interface in org.apache.tika.extractor

This factory creates EmbeddedDocumentExtractors that require an
 EmbeddedDocumentBytesHandler in the
 ParseContext should extend this.

EmbeddedDocumentExtractor - Interface in org.apache.tika.extractor
 
EmbeddedDocumentExtractorFactory - Interface in org.apache.tika.extractor
 
EmbeddedDocumentUtil - Class in org.apache.tika.extractor

Utility class to handle common issues with embedded documents.

EmbeddedDocumentUtil(ParseContext) - Constructor for class org.apache.tika.extractor.EmbeddedDocumentUtil
 
EmbeddedResourceHandler - Interface in org.apache.tika.extractor

Tika container extractor callback interface.

EmbeddedStreamTranslator - Interface in org.apache.tika.extractor

Interface for different filtering of embedded streams.

Embedder - Interface in org.apache.tika.embedder

Tika embedder interface

emit(String, InputStream, Metadata, ParseContext) - Method in interface org.apache.tika.pipes.emitter.StreamEmitter
 
emit(String, List<Metadata>, ParseContext) - Method in interface org.apache.tika.pipes.emitter.Emitter
 
emit(String, List<Metadata>, ParseContext) - Method in class org.apache.tika.pipes.emitter.EmptyEmitter
 
emit(List<? extends EmitData>) - Method in class org.apache.tika.pipes.emitter.AbstractEmitter

The default behavior is to call Emitter.emit(String, List, ParseContext) on each item.

emit(List<? extends EmitData>) - Method in interface org.apache.tika.pipes.emitter.Emitter
 
emit(List<? extends EmitData>) - Method in class org.apache.tika.pipes.emitter.EmptyEmitter
 
EMIT - org.apache.tika.pipes.FetchEmitTuple.ON_PARSE_EXCEPTION
 
EMIT_EXCEPTION - org.apache.tika.pipes.PipesResult.STATUS
 
EMIT_EXCEPTION - org.apache.tika.pipes.PipesServer.STATUS
 
EMIT_SUCCESS - org.apache.tika.pipes.PipesResult.STATUS
 
EMIT_SUCCESS - org.apache.tika.pipes.PipesServer.STATUS
 
EMIT_SUCCESS - Static variable in class org.apache.tika.pipes.PipesResult
 
EMIT_SUCCESS_PARSE_EXCEPTION - org.apache.tika.pipes.PipesResult.STATUS
 
EMIT_SUCCESS_PARSE_EXCEPTION - org.apache.tika.pipes.PipesServer.STATUS
 
EmitData - Class in org.apache.tika.pipes.emitter
 
EmitData(EmitKey, List<Metadata>) - Constructor for class org.apache.tika.pipes.emitter.EmitData
 
EmitData(EmitKey, List<Metadata>, String) - Constructor for class org.apache.tika.pipes.emitter.EmitData
 
EmitData(EmitKey, List<Metadata>, String, ParseContext) - Constructor for class org.apache.tika.pipes.emitter.EmitData
 
EmitKey - Class in org.apache.tika.pipes.emitter
 
EmitKey() - Constructor for class org.apache.tika.pipes.emitter.EmitKey
 
EmitKey(String, String) - Constructor for class org.apache.tika.pipes.emitter.EmitKey
 
Emitter - Interface in org.apache.tika.pipes.emitter
 
EMITTER_NOT_FOUND - org.apache.tika.pipes.PipesServer.STATUS
 
EmitterManager - Class in org.apache.tika.pipes.emitter

Utility class that will apply the appropriate fetcher
 to the fetcherString based on the prefix.

EmitterManager(List<Emitter>) - Constructor for class org.apache.tika.pipes.emitter.EmitterManager
 
EmittingEmbeddedDocumentBytesHandler - Class in org.apache.tika.pipes.extractor
 
EmittingEmbeddedDocumentBytesHandler(FetchEmitTuple, EmitterManager) - Constructor for class org.apache.tika.pipes.extractor.EmittingEmbeddedDocumentBytesHandler
 
EMPTY - Static variable in class org.apache.tika.mime.MediaType
 
EMPTY - Static variable in class org.apache.tika.utils.StringUtils

The empty String "".

EMPTY_OUTPUT - org.apache.tika.pipes.PipesResult.STATUS
 
EMPTY_OUTPUT - org.apache.tika.pipes.PipesServer.STATUS
 
EMPTY_OUTPUT - Static variable in class org.apache.tika.pipes.PipesResult
 
EmptyDetector - Class in org.apache.tika.detect

Dummy detector that returns application/octet-stream for all documents.

EmptyDetector() - Constructor for class org.apache.tika.detect.EmptyDetector
 
EmptyEmitter - Class in org.apache.tika.pipes.emitter
 
EmptyEmitter() - Constructor for class org.apache.tika.pipes.emitter.EmptyEmitter
 
EmptyFetcher - Class in org.apache.tika.pipes.fetcher
 
EmptyFetcher() - Constructor for class org.apache.tika.pipes.fetcher.EmptyFetcher
 
EmptyParser - Class in org.apache.tika.parser

Dummy parser that always produces an empty XHTML document without even
 attempting to parse the given document stream.

EmptyParser() - Constructor for class org.apache.tika.parser.EmptyParser
 
EmptyTranslator - Class in org.apache.tika.language.translate

Dummy translator that always declines to give any text.

EmptyTranslator() - Constructor for class org.apache.tika.language.translate.EmptyTranslator
 
encode(byte[]) - Static method in class org.apache.tika.mime.HexCoDec

Hex encode an array of bytes

encode(byte[]) - Method in interface org.apache.tika.parser.DigestingParser.Encoder
 
encode(byte[], int, int) - Static method in class org.apache.tika.mime.HexCoDec

Hex encode an array of bytes

ENCODING_DETECTOR - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This should be the simple class name for the EncodingDetectors whose detected encoding
 was used in the parse.

EncodingDetector - Interface in org.apache.tika.detect

Character encoding detector.

ENCRYPTED - Static variable in interface org.apache.tika.metadata.WordPerfect

Is encrypted?.

EncryptedDocumentException - Exception in org.apache.tika.exception
 
EncryptedDocumentException() - Constructor for exception org.apache.tika.exception.EncryptedDocumentException
 
EncryptedDocumentException(String) - Constructor for exception org.apache.tika.exception.EncryptedDocumentException
 
EncryptedDocumentException(String, Throwable) - Constructor for exception org.apache.tika.exception.EncryptedDocumentException
 
EncryptedDocumentException(Throwable) - Constructor for exception org.apache.tika.exception.EncryptedDocumentException
 
endDescription() - Method in class org.apache.tika.sax.XMPContentHandler
 
endDocument() - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
endDocument() - Method in class org.apache.tika.sax.DIFContentHandler
 
endDocument() - Method in class org.apache.tika.sax.EmbeddedContentHandler

Ignored.

endDocument() - Method in class org.apache.tika.sax.EndDocumentShieldingContentHandler
 
endDocument() - Method in class org.apache.tika.sax.PhoneExtractingContentHandler

This method is called whenever the Parser is done parsing the file.

endDocument() - Method in class org.apache.tika.sax.SafeContentHandler
 
endDocument() - Method in class org.apache.tika.sax.StandardsExtractingContentHandler

This method is called whenever the Parser is done parsing the file.

endDocument() - Method in class org.apache.tika.sax.TeeContentHandler
 
endDocument() - Method in class org.apache.tika.sax.TextContentHandler
 
endDocument() - Method in class org.apache.tika.sax.ToTextContentHandler

Flushes the character stream so that no characters are forgotten
 in internal buffers.

endDocument() - Method in class org.apache.tika.sax.XHTMLContentHandler

Ends the XHTML document by writing the following footer and
 clearing the namespace mappings:

endDocument() - Method in class org.apache.tika.sax.XMPContentHandler

Ends the XMP document by writing the following footer and
 clearing the namespace mappings:

endDocument(ContentHandler, Metadata) - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler

This is called after the full parse has completed.

endDocument(ContentHandler, Metadata) - Method in class org.apache.tika.sax.RecursiveParserWrapperHandler
 
EndDocumentShieldingContentHandler - Class in org.apache.tika.sax

A wrapper around a ContentHandler which will ignore normal
 SAX calls to EndDocumentShieldingContentHandler.endDocument(), and only fire them later.

EndDocumentShieldingContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.EndDocumentShieldingContentHandler

Creates a decorator for the given SAX event handler.

endElement(String) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.mime.MimeTypesReader
 
endElement(String, String, String) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
endElement(String, String, String) - Method in class org.apache.tika.sax.DIFContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.ElementMappingContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.ExpandedTitleContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.LinkContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.SafeContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.SecureContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.TeeContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.ToHTMLContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.ToTextContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.ToXMLContentHandler
 
endElement(String, String, String) - Method in class org.apache.tika.sax.XHTMLContentHandler

Ends the given element.

endElement(String, String, String) - Method in class org.apache.tika.sax.xpath.MatchingContentHandler
 
endEmbeddedDocument(ContentHandler, Metadata) - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler

This is called after parsing each embedded document.

endEmbeddedDocument(ContentHandler, Metadata) - Method in class org.apache.tika.sax.RecursiveParserWrapperHandler

This is called after parsing an embedded document.

ENDIAN - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
EndianUtils - Class in org.apache.tika.io

General Endian Related Utilties.

EndianUtils() - Constructor for class org.apache.tika.io.EndianUtils
 
EndianUtils.BufferUnderrunException - Exception in org.apache.tika.io
 
ENDLINE - Static variable in class org.apache.tika.sax.XHTMLContentHandler

The elements that get appended with the XHTMLContentHandler.NL character.

endPrefixMapping(String) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
endPrefixMapping(String) - Method in class org.apache.tika.sax.TeeContentHandler
 
ENGINEER - Static variable in interface org.apache.tika.metadata.XMPDM

"The engineer's name."

enqueue() - Method in class org.apache.tika.pipes.pipesiterator.filelist.FileListPipesIterator
 
enqueue() - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
enqueue() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
ensureStreamReReadable(InputStream, TemporaryResources, Metadata) - Static method in class org.apache.tika.utils.ParserUtils

Ensures that the Stream will be able to be re-read, by buffering to
 a temporary file if required.

EOF_OFFSETS - Static variable in interface org.apache.tika.metadata.PDF

Number of %%EOF as extracted by the StartXRefScanner.

Epub - Interface in org.apache.tika.metadata

EPub properties collection.

EPUB_PREFIX - Static variable in interface org.apache.tika.metadata.Epub
 
equals(Object) - Method in class org.apache.tika.metadata.Metadata
 
equals(Object) - Method in class org.apache.tika.metadata.Property
 
equals(Object) - Method in class org.apache.tika.mime.MediaType
 
equals(Object) - Method in class org.apache.tika.mime.MimeType
 
equals(Object) - Method in class org.apache.tika.parser.ParseContext
 
equals(Object) - Method in class org.apache.tika.pipes.emitter.EmitKey
 
equals(Object) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
equals(Object) - Method in class org.apache.tika.pipes.FetchEmitTuple
 
equals(Object) - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
equals(Object) - Method in class org.apache.tika.pipes.HandlerConfig
 
equals(Object) - Method in class org.apache.tika.renderer.PageRangeRequest
 
equals(String, String) - Static method in class org.apache.tika.language.detect.LanguageNames
 
EQUIPMENT_MAKE - Static variable in interface org.apache.tika.metadata.TIFF

"Manufacturer of the recording equipment."

EQUIPMENT_MODEL - Static variable in interface org.apache.tika.metadata.TIFF

"Model name or number of the recording equipment."

error(String) - Method in class org.apache.tika.pipes.CompositePipesReporter
 
error(String) - Method in class org.apache.tika.pipes.LoggingPipesReporter
 
error(String) - Method in class org.apache.tika.pipes.PipesReporter

This is called if the process has crashed.

error(Throwable) - Method in class org.apache.tika.pipes.CompositePipesReporter
 
error(Throwable) - Method in class org.apache.tika.pipes.LoggingPipesReporter
 
error(Throwable) - Method in class org.apache.tika.pipes.PipesReporter

This is called if the process has crashed.

error(SAXParseException) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
ERROR_CODES_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
ErrorParser - Class in org.apache.tika.parser

Dummy parser that always throws a TikaException without even
 attempting to parse the given document stream.

ErrorParser() - Constructor for class org.apache.tika.parser.ErrorParser
 
escapeCommandLine(String) - Static method in class org.apache.tika.utils.ProcessUtils

This should correctly put double-quotes around an argument if
 ProcessBuilder doesn't seem to work (as it doesn't
 on paths with spaces on Windows)

EVENT - Static variable in interface org.apache.tika.metadata.IPTC

Names or describes the specific event the content relates to.

EXCEPTION - org.apache.tika.pipes.pipesiterator.TotalCountResult.STATUS
 
EXCEPTION - org.apache.tika.renderer.RenderResult.STATUS
 
ExceptionUtils - Class in org.apache.tika.utils
 
ExceptionUtils() - Constructor for class org.apache.tika.utils.ExceptionUtils
 
ExcludeFieldMetadataFilter - Class in org.apache.tika.metadata.filter
 
ExcludeFieldMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.ExcludeFieldMetadataFilter
 
ExcludeFieldMetadataFilter(Set<String>) - Constructor for class org.apache.tika.metadata.filter.ExcludeFieldMetadataFilter
 
execute(ProcessBuilder, long, int, int) - Static method in class org.apache.tika.utils.ProcessUtils

This writes stdout and stderr to the FileProcessResult.

execute(ProcessBuilder, long, Path, int) - Static method in class org.apache.tika.utils.ProcessUtils

This redirects stdout to stdoutRedirect path.

execute(ParseContext, Runnable) - Static method in class org.apache.tika.utils.ConcurrentUtils

Execute a runnable using an ExecutorService from the ParseContext if possible.

EXIF_PAGE_COUNT - Static variable in interface org.apache.tika.metadata.TIFF
 
EXISTING - org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY
 
EXIT_VALUE - Static variable in interface org.apache.tika.metadata.ExternalProcess

Exit value of the sub process

ExpandedTitleContentHandler - Class in org.apache.tika.sax

Content handler decorator which wraps a TransformerHandler in order to
 allow the TITLE tag to render as <title></title>
 rather than <title/> which is accomplished
 by calling the ContentHandler.characters(char[], int, int) method
 with a length of 1 but a zero length char array.

ExpandedTitleContentHandler() - Constructor for class org.apache.tika.sax.ExpandedTitleContentHandler
 
ExpandedTitleContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.ExpandedTitleContentHandler
 
EXPERIMENT_ID - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
EXPOSURE_TIME - Static variable in interface org.apache.tika.metadata.TIFF

"Exposure time in seconds."

extension_neg(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
extension_trust(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
EXTERNAL_PARSERS_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
externalBoolean(String) - Static method in class org.apache.tika.metadata.Property
 
externalBooleanSeq(String) - Static method in class org.apache.tika.metadata.Property
 
externalClosedChoise(String, String...) - Static method in class org.apache.tika.metadata.Property
 
externalDate(String) - Static method in class org.apache.tika.metadata.Property
 
ExternalEmbedder - Class in org.apache.tika.embedder

Embedder that uses an external program (like sed or exiftool) to embed text
 content and metadata into a given document.

ExternalEmbedder() - Constructor for class org.apache.tika.embedder.ExternalEmbedder
 
externalInteger(String) - Static method in class org.apache.tika.metadata.Property
 
externalOpenChoise(String, String...) - Static method in class org.apache.tika.metadata.Property
 
ExternalParser - Class in org.apache.tika.parser.external

Parser that uses an external program (like catdoc or pdf2txt) to extract
 text content and metadata from a given document.

ExternalParser - Class in org.apache.tika.parser.external2

This is a next generation external parser that uses some of the more
 recent additions to Tika.

ExternalParser() - Constructor for class org.apache.tika.parser.external.ExternalParser
 
ExternalParser() - Constructor for class org.apache.tika.parser.external2.ExternalParser
 
ExternalParser.LineConsumer - Interface in org.apache.tika.parser.external

Consumer contract

ExternalParsersConfigReader - Class in org.apache.tika.parser.external

Builds up ExternalParser instances based on XML file(s)
 which define what to run, for what, and how to process
 any output metadata.

ExternalParsersConfigReader() - Constructor for class org.apache.tika.parser.external.ExternalParsersConfigReader
 
ExternalParsersConfigReaderMetKeys - Interface in org.apache.tika.parser.external

Met Keys used by the ExternalParsersConfigReader.

ExternalParsersFactory - Class in org.apache.tika.parser.external

Creates instances of ExternalParser based on XML
 configuration files.

ExternalParsersFactory() - Constructor for class org.apache.tika.parser.external.ExternalParsersFactory
 
ExternalProcess - Interface in org.apache.tika.metadata
 
externalReal(String) - Static method in class org.apache.tika.metadata.Property
 
externalRealSeq(String) - Static method in class org.apache.tika.metadata.Property
 
externalText(String) - Static method in class org.apache.tika.metadata.Property
 
externalTextBag(String) - Static method in class org.apache.tika.metadata.Property
 
extract(TikaInputStream, ContainerExtractor, EmbeddedResourceHandler) - Method in interface org.apache.tika.extractor.ContainerExtractor

Processes a container file, and extracts all the embedded
 resources from within it.

extract(TikaInputStream, ContainerExtractor, EmbeddedResourceHandler) - Method in class org.apache.tika.extractor.ParserContainerExtractor
 
EXTRACT_CONTENT - Static variable in interface org.apache.tika.metadata.AccessPermissions

Should content be extracted, generally.

EXTRACT_FOR_ACCESSIBILITY - Static variable in interface org.apache.tika.metadata.AccessPermissions

Should content be extracted for the purposes
 of accessibility.

extractLinks(String) - Static method in class org.apache.tika.utils.RegexUtils

Extract urls from plain text.

extractPhoneNumbers(String) - Static method in class org.apache.tika.sax.CleanPhoneText
 
extractRootElement(byte[]) - Method in class org.apache.tika.detect.XmlRootExtractor
 
extractRootElement(InputStream) - Method in class org.apache.tika.detect.XmlRootExtractor
 
extractStandardReferences(String, double) - Static method in class org.apache.tika.sax.StandardsText

Extracts the standard references found within the given text.





F

F_NUMBER - Static variable in interface org.apache.tika.metadata.TIFF

"F-Number."

FAIL - Static variable in class org.apache.tika.sax.xpath.Matcher

State of a failed XPath evaluation, where nothing is matched.

FAILED_TO_START - org.apache.tika.pipes.PipesServer.STATUS
 
FailedToStartClientException - Exception in org.apache.tika.pipes

This should be catastrophic

FailedToStartClientException(Throwable) - Constructor for exception org.apache.tika.pipes.FailedToStartClientException
 
FallbackParser - Class in org.apache.tika.parser.multiple

Tries multiple parsers in turn, until one succeeds.

FallbackParser(MediaTypeRegistry, Collection<? extends Parser>, Map<String, Param>) - Constructor for class org.apache.tika.parser.multiple.FallbackParser
 
FallbackParser(MediaTypeRegistry, AbstractMultipleParser.MetadataPolicy, Collection<? extends Parser>) - Constructor for class org.apache.tika.parser.multiple.FallbackParser
 
FallbackParser(MediaTypeRegistry, AbstractMultipleParser.MetadataPolicy, Parser...) - Constructor for class org.apache.tika.parser.multiple.FallbackParser
 
fatalError(SAXParseException) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
fetch(String, long, long, Metadata) - Method in interface org.apache.tika.pipes.fetcher.RangeFetcher
 
fetch(String, long, long, Metadata, ParseContext) - Method in interface org.apache.tika.pipes.fetcher.RangeFetcher
 
fetch(String, Metadata, ParseContext) - Method in class org.apache.tika.pipes.fetcher.EmptyFetcher
 
fetch(String, Metadata, ParseContext) - Method in interface org.apache.tika.pipes.fetcher.Fetcher
 
fetch(String, Metadata, ParseContext) - Method in class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher
 
fetch(String, Metadata, ParseContext) - Method in class org.apache.tika.pipes.fetcher.url.UrlFetcher
 
FETCH_EXCEPTION - org.apache.tika.pipes.PipesResult.STATUS
 
FETCH_EXCEPTION - org.apache.tika.pipes.PipesServer.STATUS
 
FetchEmitTuple - Class in org.apache.tika.pipes
 
FetchEmitTuple(String, FetchKey, EmitKey) - Constructor for class org.apache.tika.pipes.FetchEmitTuple
 
FetchEmitTuple(String, FetchKey, EmitKey, Metadata) - Constructor for class org.apache.tika.pipes.FetchEmitTuple
 
FetchEmitTuple(String, FetchKey, EmitKey, Metadata, ParseContext) - Constructor for class org.apache.tika.pipes.FetchEmitTuple
 
FetchEmitTuple(String, FetchKey, EmitKey, Metadata, ParseContext, FetchEmitTuple.ON_PARSE_EXCEPTION) - Constructor for class org.apache.tika.pipes.FetchEmitTuple
 
FetchEmitTuple.ON_PARSE_EXCEPTION - Enum in org.apache.tika.pipes
 
Fetcher - Interface in org.apache.tika.pipes.fetcher

Interface for an object that will fetch an InputStream given
 a fetch string.

FETCHER_INITIALIZATION_EXCEPTION - org.apache.tika.pipes.PipesResult.STATUS
 
FETCHER_INITIALIZATION_EXCEPTION - org.apache.tika.pipes.PipesServer.STATUS
 
FETCHER_NOT_FOUND - org.apache.tika.pipes.PipesServer.STATUS
 
FetcherConfigContainer - Class in org.apache.tika.pipes.fetcher.config
 
FetcherConfigContainer() - Constructor for class org.apache.tika.pipes.fetcher.config.FetcherConfigContainer
 
FetcherManager - Class in org.apache.tika.pipes.fetcher

Utility class to hold multiple fetchers.

FetcherManager(List<Fetcher>) - Constructor for class org.apache.tika.pipes.fetcher.FetcherManager
 
FetcherStringException - Exception in org.apache.tika.pipes.fetcher

If something goes wrong in parsing the fetcher string

FetcherStringException(String) - Constructor for exception org.apache.tika.pipes.fetcher.FetcherStringException
 
FetchKey - Class in org.apache.tika.pipes.fetcher

Pair of fetcherName (which fetcher to call) and the key
 to send to that fetcher to retrieve a specific file.

FetchKey() - Constructor for class org.apache.tika.pipes.fetcher.FetchKey
 
FetchKey(String, String) - Constructor for class org.apache.tika.pipes.fetcher.FetchKey
 
FetchKey(String, String, long, long) - Constructor for class org.apache.tika.pipes.fetcher.FetchKey
 
Field - Annotation Type in org.apache.tika.config

Field annotation is a contract for binding Param value from
 Tika Configuration to an object.

FieldNameMappingFilter - Class in org.apache.tika.metadata.filter
 
FieldNameMappingFilter() - Constructor for class org.apache.tika.metadata.filter.FieldNameMappingFilter
 
FILE_DATA_RATE - Static variable in interface org.apache.tika.metadata.XMPDM

"The file data rate in megabytes per second.

FILE_ID - Static variable in interface org.apache.tika.metadata.WordPerfect

File identifier.

FILE_MIME - Static variable in class org.apache.tika.detect.FileCommandDetector
 
FILE_SIZE - Static variable in interface org.apache.tika.metadata.WordPerfect

File size as defined in document header.

FILE_TYPE - Static variable in interface org.apache.tika.metadata.WordPerfect

File type.

FileCommandDetector - Class in org.apache.tika.detect

This runs the linux 'file' command against a file.

FileCommandDetector() - Constructor for class org.apache.tika.detect.FileCommandDetector
 
FileListPipesIterator - Class in org.apache.tika.pipes.pipesiterator.filelist

Reads a list of file names/relative paths from a UTF-8 file.

FileListPipesIterator() - Constructor for class org.apache.tika.pipes.pipesiterator.filelist.FileListPipesIterator
 
FilenameUtils - Class in org.apache.tika.io
 
FilenameUtils() - Constructor for class org.apache.tika.io.FilenameUtils
 
FileProcessResult - Class in org.apache.tika.utils
 
FileProcessResult() - Constructor for class org.apache.tika.utils.FileProcessResult
 
FileSystem - Interface in org.apache.tika.metadata

A collection of metadata elements for file system level metadata

FileSystemFetcher - Class in org.apache.tika.pipes.fetcher.fs
 
FileSystemFetcher() - Constructor for class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher
 
FileSystemFetcher(FileSystemFetcherConfig) - Constructor for class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher
 
FileSystemFetcherConfig - Class in org.apache.tika.pipes.fetcher.fs.config
 
FileSystemFetcherConfig() - Constructor for class org.apache.tika.pipes.fetcher.fs.config.FileSystemFetcherConfig
 
FileSystemPipesIterator - Class in org.apache.tika.pipes.pipesiterator.fs
 
FileSystemPipesIterator() - Constructor for class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
FileSystemPipesIterator(Path) - Constructor for class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
FileTooLongException - Exception in org.apache.tika.exception
 
FileTooLongException(long, long) - Constructor for exception org.apache.tika.exception.FileTooLongException
 
FileTooLongException(String) - Constructor for exception org.apache.tika.exception.FileTooLongException
 
FILL_IN_FORM - Static variable in interface org.apache.tika.metadata.AccessPermissions

Can the user fill in a form

filter(List<Metadata>) - Method in class org.apache.tika.metadata.listfilter.CompositeMetadataListFilter
 
filter(List<Metadata>) - Method in class org.apache.tika.metadata.listfilter.MetadataListFilter
 
filter(List<Metadata>) - Method in class org.apache.tika.metadata.listfilter.NoOpListFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.ClearByAttachmentTypeMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.ClearByMimeMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.CompositeMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.DateNormalizingMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.ExcludeFieldMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.FieldNameMappingFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.GeoPointMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.IncludeFieldMetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.MetadataFilter
 
filter(Metadata) - Method in class org.apache.tika.metadata.filter.NoOpFilter
 
filterExisting(Map<String, String[]>) - Method in interface org.apache.tika.metadata.writefilter.MetadataWriteFilter
 
filterExisting(Map<String, String[]>) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilter
 
FINAL_EMBEDDED_RESOURCE_PATH - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This is calculated in RecursiveParserWrapperHandler.

findDuplicateParsers(ParseContext) - Method in class org.apache.tika.parser.CompositeParser

Utility method that goes through all the component parsers and finds
 all media types for which more than one parser declares support.

findServiceResources(String) - Method in class org.apache.tika.config.ServiceLoader

Returns all the available service resources matching the
 given pattern, such as all instances of tika-mimetypes.xml
 on the classpath, or all org.apache.tika.parser.Parser
 service files.

finished() - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
FIRST_WINS - org.apache.tika.parser.multiple.AbstractMultipleParser.MetadataPolicy

The first parser to output a given key wins,
 merge in non-clashing other keys

FLASH_FIRED - Static variable in interface org.apache.tika.metadata.TIFF

Did the Flash fire when taking this image?

flush() - Method in class org.apache.tika.language.detect.LanguageWriter

Ignored.

FOCAL_LENGTH - Static variable in interface org.apache.tika.metadata.TIFF

"Focal length of the lens, in millimeters."

Font - Interface in org.apache.tika.metadata
 
FONT - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
FONT_NAME - Static variable in interface org.apache.tika.metadata.Font

Basic name of a font used in a file

ForkParser - Class in org.apache.tika.fork
 
ForkParser() - Constructor for class org.apache.tika.fork.ForkParser
 
ForkParser(ClassLoader) - Constructor for class org.apache.tika.fork.ForkParser
 
ForkParser(ClassLoader, Parser) - Constructor for class org.apache.tika.fork.ForkParser
 
ForkParser(Path, ParserFactoryFactory) - Constructor for class org.apache.tika.fork.ForkParser

If you have a directory with, say, tike-app.jar and you want the
 forked process/server to build a parser
 and run it from that -- so that you can keep all of those dependencies out of
 your client code, use this initializer.

ForkParser(Path, ParserFactoryFactory, ClassLoader) - Constructor for class org.apache.tika.fork.ForkParser

EXPERT

ForkProxy - Interface in org.apache.tika.fork
 
ForkResource - Interface in org.apache.tika.fork
 
FORMAT - Static variable in interface org.apache.tika.metadata.DublinCore

Typically, Format may include the media-type or dimensions of the
 resource.

FORMAT - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
FORMAT - Static variable in interface org.apache.tika.metadata.XMPDC

Typically, Format may include the media-type or dimensions of the
 resource.

formatDate(Calendar) - Static method in class org.apache.tika.utils.DateUtils

Returns a ISO 8601 representation of the given date in UTC,
 truncated to the seconds unit.

formatDate(Date) - Static method in class org.apache.tika.utils.DateUtils

Returns a ISO 8601 representation of the given date in UTC,
 truncated to the seconds unit.

formatDateUnknownTimezone(Date) - Static method in class org.apache.tika.utils.DateUtils

Returns a ISO 8601 representation of the given date in UTC,
 truncated to the seconds unit.

forName(String) - Method in class org.apache.tika.mime.MimeTypes

Returns the registered media type with the given name (or alias).

forName(String) - Static method in class org.apache.tika.utils.CharsetUtils

Returns Charset impl, if one exists.

FROM_REPRESENTING_EMAIL - Static variable in interface org.apache.tika.metadata.MAPI
 
FROM_REPRESENTING_NAME - Static variable in interface org.apache.tika.metadata.MAPI
 




G

GENRE - Static variable in interface org.apache.tika.metadata.XMPDM

"The name of the genre."

Geographic - Interface in org.apache.tika.metadata

Geographic schema.

GeoPointMetadataFilter - Class in org.apache.tika.metadata.filter

If Metadata contains a TikaCoreProperties.LATITUDE and
 a TikaCoreProperties.LONGITUDE, this filter concatenates those with a
 comma in the order LATITUDE,LONGITUDE.

GeoPointMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.GeoPointMetadataFilter
 
get(byte[]) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the given array of bytes.

get(byte[], Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the given array of bytes.

get(File) - Static method in class org.apache.tika.io.TikaInputStream

Deprecated.
use TikaInputStream.get(Path). In Tika 2.0, this will be removed
 or modified to throw an IOException.


get(File, Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Deprecated.
use TikaInputStream.get(Path, Metadata). In Tika 2.0,
 this will be removed or modified to throw an IOException.


get(InputStream) - Static method in class org.apache.tika.io.TikaInputStream

Casts or wraps the given stream to a TikaInputStream instance.

get(InputStream, TemporaryResources, Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Casts or wraps the given stream to a TikaInputStream instance.

get(Class<T>) - Method in class org.apache.tika.parser.ParseContext

Returns the object in this context that implements the given interface.

get(Class<T>, T) - Method in class org.apache.tika.parser.ParseContext

Returns the object in this context that implements the given interface,
 or the given default value if such an object is not found.

get(String) - Method in class org.apache.tika.metadata.Metadata

Get the value associated to a metadata name.

get(String) - Static method in class org.apache.tika.metadata.Property

Retrieve the property object that corresponds to the given key

get(URI) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the resource at the given URI.

get(URI, Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the resource at the given URI.

get(URL) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the resource at the given URL.

get(URL, Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the resource at the given URL.

get(Path) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the file at the given path.

get(Path, Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the file at the given path.

get(Path, Metadata, TemporaryResources) - Static method in class org.apache.tika.io.TikaInputStream
 
get(Blob) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the given database BLOB.

get(Blob, Metadata) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from the given database BLOB.

get(InputStreamFactory) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from a Factory which can create
 fresh InputStreams for the same resource multiple times.

get(InputStreamFactory, TemporaryResources) - Static method in class org.apache.tika.io.TikaInputStream

Creates a TikaInputStream from a Factory which can create
 fresh InputStreams for the same resource multiple times.

get(Property) - Method in class org.apache.tika.metadata.Metadata

Returns the value (if any) of the identified metadata property.

getAcronym() - Method in class org.apache.tika.mime.MimeType

Returns an acronym for this mime type.

getAliases(MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry

Returns the set of known aliases of the given canonical media type.

getAllComponentParsers() - Method in class org.apache.tika.parser.CompositeParser

Returns all parsers registered with the Composite Parser,
 including ones which may not currently be active.

getAllComponentParsers() - Method in class org.apache.tika.parser.DefaultParser
 
getAllParsers() - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser
 
getAsyncStatus() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
getAttributesMapping() - Method in class org.apache.tika.sax.ElementMappingContentHandler.TargetElement
 
getAttrValue(String, Attributes) - Static method in class org.apache.tika.utils.XMLReaderUtils
 
getAutoDetectParserConfig() - Method in class org.apache.tika.config.TikaConfig
 
getAutoDetectParserConfig() - Method in class org.apache.tika.parser.AutoDetectParser
 
getBasePath() - Method in class org.apache.tika.pipes.fetcher.fs.config.FileSystemFetcherConfig
 
getBasePath() - Method in class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher
 
getBaseType() - Method in class org.apache.tika.mime.MediaType

Returns the base form of the MediaType, excluding
 any parameters, such as "text/plain" for
 "text/plain; charset=utf-8"

getCapacity() - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
getCause() - Method in exception org.apache.tika.sax.TaggedSAXException

Returns the wrapped exception.

getCharset() - Method in class org.apache.tika.detect.AutoDetectReader
 
getCharset() - Method in class org.apache.tika.detect.NonDetectingEncodingDetector
 
getChildTypes(MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry

Returns the set of known children of the given canonical media type

getChoices() - Method in class org.apache.tika.metadata.Property

Returns the (immutable) set of choices for the values of this property.

getCommand() - Method in class org.apache.tika.embedder.ExternalEmbedder

Gets the command to be run.

getCommand() - Method in class org.apache.tika.parser.external.ExternalParser
 
getCommandAppendOperator() - Method in class org.apache.tika.embedder.ExternalEmbedder

Gets the operator to append rather than replace a value for the command
 line tool, i.e. "+=".

getCommandAssignmentDelimeter() - Method in class org.apache.tika.embedder.ExternalEmbedder

Gets the delimiter for multiple assignments for the command line tool,
 i.e. ", ".

getCommandAssignmentOperator() - Method in class org.apache.tika.embedder.ExternalEmbedder

Gets the assignment operator for the command line tool, i.e. "=".

getCommandMetadataSegments(Metadata) - Method in class org.apache.tika.embedder.ExternalEmbedder

Constructs a collection of command line arguments responsible for setting
 individual metadata fields based on the given metadata.

getConfidence() - Method in class org.apache.tika.language.detect.LanguageResult
 
getConfigClassName() - Method in class org.apache.tika.pipes.fetcher.config.FetcherConfigContainer
 
getContainerStackTrace() - Method in class org.apache.tika.pipes.emitter.EmitData
 
getContentHandler() - Method in class org.apache.tika.extractor.ParentContentHandler
 
getContentHandlerDecoratorFactory() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getContentHandlerFactory() - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
 
getCrashMessage() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
getDate(Property) - Method in class org.apache.tika.metadata.Metadata

Returns the value of the identified Date based metadata property.

getDecorationName() - Method in class org.apache.tika.parser.ParserDecorator
 
getDefaultConfig() - Static method in class org.apache.tika.config.TikaConfig

Provides a default configuration (TikaConfig).

getDefaultDetector(MimeTypes, ServiceLoader) - Static method in class org.apache.tika.config.TikaConfig
 
getDefaultEncodingDetector(ServiceLoader) - Static method in class org.apache.tika.config.TikaConfig
 
getDefaultLanguageDetector() - Static method in class org.apache.tika.language.detect.LanguageDetector
 
getDefaultMimeTypes() - Static method in class org.apache.tika.mime.MimeTypes

Get the default MimeTypes.

getDefaultMimeTypes(ClassLoader) - Static method in class org.apache.tika.mime.MimeTypes

Get the default MimeTypes.

getDefaultRegistry() - Static method in class org.apache.tika.mime.MediaTypeRegistry

Returns the built-in media type registry included in Tika.

getDefaultRenderer(ServiceLoader) - Static method in class org.apache.tika.config.TikaConfig
 
getDefaultTimeZone() - Method in class org.apache.tika.metadata.filter.DateNormalizingMetadataFilter
 
getDelegateParser(ParseContext) - Method in class org.apache.tika.parser.DelegatingParser

Returns the parser instance to which parsing tasks should be delegated.

getDelegatingParser() - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
getDepth() - Method in class org.apache.tika.parser.ParseRecord
 
getDescription() - Method in class org.apache.tika.mime.MimeType

Returns the description of this media type.

getDetector() - Method in class org.apache.tika.config.TikaConfig

Returns the configured detector instance.

getDetector() - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
getDetector() - Method in class org.apache.tika.language.detect.LanguageHandler

Returns the language detector used by this content handler.

getDetector() - Method in class org.apache.tika.language.detect.LanguageWriter

Returns the language detector used by this writer.

getDetector() - Method in class org.apache.tika.parser.AutoDetectParser

Returns the type detector used by this parser to auto-detect the type
 of a document.

getDetector() - Method in class org.apache.tika.Tika

Returns the detector instance used by this facade.

getDetectors() - Method in class org.apache.tika.detect.CompositeDetector

Returns the component detectors.

getDetectors() - Method in class org.apache.tika.detect.CompositeEncodingDetector
 
getDetectors() - Method in class org.apache.tika.detect.DefaultDetector
 
getDetectors() - Method in class org.apache.tika.detect.DefaultProbDetector
 
getDigesterFactory() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getDocument(int) - Method in class org.apache.tika.extractor.BasicEmbeddedDocumentBytesHandler
 
getDocumentBuilder() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the DOM builder specified in this parsing context.

getDocumentBuilder(ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the DOM builder specified in this parsing context.

getDocumentBuilderFactory() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the DOM builder factory specified in this parsing context.

getEmbeddedBytesSelector() - Method in class org.apache.tika.extractor.RUnpackExtractor
 
getEmbeddedDocumentExtractor(ParseContext) - Static method in class org.apache.tika.extractor.EmbeddedDocumentUtil

This offers a uniform way to get an EmbeddedDocumentExtractor from a ParseContext.

getEmbeddedDocumentExtractorFactory() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getEmbeddedIdPrefix() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
getEmitData() - Method in class org.apache.tika.pipes.PipesResult
 
getEmitKey() - Method in class org.apache.tika.pipes.emitter.EmitData
 
getEmitKey() - Method in class org.apache.tika.pipes.emitter.EmitKey
 
getEmitKey() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
getEmitKey(String, int, EmbeddedDocumentBytesConfig, Metadata) - Method in class org.apache.tika.extractor.AbstractEmbeddedDocumentBytesHandler
 
getEmitKeyBase() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
getEmitMaxEstimatedBytes() - Method in class org.apache.tika.pipes.async.AsyncConfig

When the emit queue hits this estimated size (sum of
 estimated extract sizes), emit the batch.

getEmitter() - Method in class org.apache.tika.pipes.emitter.EmitterManager

Convenience method that returns an emitter if only one emitter
 is specified in the tika-config file.

getEmitter() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
getEmitter(String) - Method in class org.apache.tika.pipes.emitter.EmitterManager
 
getEmitterName() - Method in class org.apache.tika.pipes.emitter.EmitKey
 
getEmitterName() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
getEmitWithinMillis() - Method in class org.apache.tika.pipes.async.AsyncConfig
 
getEncodingDetector() - Method in class org.apache.tika.config.TikaConfig

Returns the configured encoding detector instance

getEncodingDetector() - Method in class org.apache.tika.parser.AbstractEncodingDetectorParser
 
getEncodingDetector(ParseContext) - Method in class org.apache.tika.parser.AbstractEncodingDetectorParser

Look for an EncodingDetetor in the ParseContext.

getEstimatedSizeBytes() - Method in class org.apache.tika.pipes.emitter.EmitData
 
getExceptions() - Method in class org.apache.tika.parser.ParseRecord
 
getExclude() - Method in class org.apache.tika.metadata.filter.ExcludeFieldMetadataFilter
 
getExecutorService() - Method in class org.apache.tika.config.TikaConfig
 
getExitValue() - Method in class org.apache.tika.utils.FileProcessResult
 
getExtension() - Method in class org.apache.tika.mime.MimeType

Returns the preferred file extension of this type, or an empty string
 if no extensions are known.

getExtension(TikaInputStream, Metadata) - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
getExtensions() - Method in class org.apache.tika.mime.MimeType

Returns the list of all known file extensions of this media type.

getFallback() - Method in class org.apache.tika.parser.CompositeParser

Returns the fallback parser.

getFetcher() - Method in class org.apache.tika.pipes.fetcher.FetcherManager

Convenience method that returns a fetcher if only one fetcher
 is specified in the tika-config file.

getFetcher(String) - Method in class org.apache.tika.pipes.fetcher.FetcherManager
 
getFetcherName() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
getFetcherName() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
getFetchKey() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
getFetchKey() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
getField() - Method in class org.apache.tika.config.ParamField
 
getFile() - Method in class org.apache.tika.io.TikaInputStream
 
getFileChannel() - Method in class org.apache.tika.io.TikaInputStream
 
getFilesProcessed() - Method in class org.apache.tika.pipes.PipesClient
 
getFilteredStackTrace(Throwable) - Static method in class org.apache.tika.utils.ExceptionUtils

Simple util to get stack trace.

getFilters() - Method in class org.apache.tika.metadata.filter.CompositeMetadataFilter
 
getFilters() - Method in class org.apache.tika.metadata.listfilter.CompositeMetadataListFilter
 
getForkedJvmArgs() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getFrom() - Method in class org.apache.tika.renderer.PageRangeRequest
 
getGeoPointFieldName() - Method in class org.apache.tika.metadata.filter.GeoPointMetadataFilter
 
getHandlerConfig() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
getId() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
getId() - Method in class org.apache.tika.renderer.RenderResult
 
getIdentifier() - Method in class org.apache.tika.sax.StandardReference
 
getIds() - Method in class org.apache.tika.extractor.AbstractEmbeddedDocumentBytesHandler
 
getIds() - Method in interface org.apache.tika.extractor.EmbeddedDocumentBytesHandler
 
getIgnoredLineConsumer() - Method in class org.apache.tika.parser.external.ExternalParser

Gets lines consumer

getInclude() - Method in class org.apache.tika.metadata.filter.IncludeFieldMetadataFilter
 
getIncludeFields() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
getInitializableProblemHandler() - Method in class org.apache.tika.config.ServiceLoader

Returns the handler for problems with initializables

getInputStream() - Method in interface org.apache.tika.io.InputStreamFactory
 
getInputStream() - Method in class org.apache.tika.renderer.RenderResult
 
getInputStreamFactory() - Method in class org.apache.tika.io.TikaInputStream

If the Stream was created from an InputStreamFactory,
 return that, otherwise null.

getInt(Property) - Method in class org.apache.tika.metadata.Metadata

Returns the value of the identified Integer based metadata property.

getIntBE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a BE int value from the beginning of a byte array

getIntBE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a BE int value from a byte array

getIntLE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a LE int value from the beginning of a byte array

getIntLE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a LE int value from a byte array

getIntValues(Property) - Method in class org.apache.tika.metadata.Metadata

Gets the array of ints of the identified "seq" integer metadata property.

getIsTruncated() - Method in class org.apache.tika.utils.StreamGobbler
 
getJavaCommandAsList() - Method in class org.apache.tika.fork.ForkParser

Returns the command used to start the forked server process.

getJavaPath() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getJson() - Method in class org.apache.tika.pipes.fetcher.config.FetcherConfigContainer
 
getLanguage() - Method in class org.apache.tika.language.detect.LanguageHandler

Returns the detected language based on text handled thus far.

getLanguage() - Method in class org.apache.tika.language.detect.LanguageResult

The ISO 639-1 language code (plus optional country code)

getLanguage() - Method in class org.apache.tika.language.detect.LanguageWriter

Returns the detected language based on text written thus far.

getLanguageDetectors() - Static method in class org.apache.tika.language.detect.LanguageDetector
 
getLanguageDetectors(ServiceLoader) - Static method in class org.apache.tika.language.detect.LanguageDetector
 
getLastUpdate() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
getLeafRenderer(MediaType) - Method in class org.apache.tika.renderer.CompositeRenderer
 
getLength() - Method in class org.apache.tika.detect.MagicDetector
 
getLength() - Method in class org.apache.tika.io.TikaInputStream

Returns the length (in bytes) of this stream.

getLines() - Method in class org.apache.tika.utils.StreamGobbler
 
getLinks() - Method in class org.apache.tika.mime.MimeType

Get a list of links to help document this mime type

getLinks() - Method in class org.apache.tika.sax.LinkContentHandler

Returns the list of collected links.

getLoader() - Method in class org.apache.tika.config.ServiceLoader
 
getLoadErrorHandler() - Method in class org.apache.tika.config.ServiceLoader

Returns the load error handler used by this loader.

getLongLE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a LE long value from a byte array

getLongValues(Property) - Method in class org.apache.tika.metadata.Metadata

Gets the array of ints of the identified "seq" integer metadata property.

getMacroLanguage(String) - Static method in class org.apache.tika.language.detect.LanguageNames

If language is a specific variant of a macro language (e.g.

getMainOrganizationAcronym() - Method in class org.apache.tika.sax.StandardReference
 
getMappedTagName() - Method in class org.apache.tika.sax.ElementMappingContentHandler.TargetElement
 
getMappins() - Method in class org.apache.tika.metadata.filter.FieldNameMappingFilter
 
getMaxEmbeddedResources() - Method in class org.apache.tika.pipes.HandlerConfig
 
getMaxEntityExpansions() - Static method in class org.apache.tika.utils.XMLReaderUtils
 
getMaxFieldSize() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
getMaxFilesProcessedPerProcess() - Method in class org.apache.tika.pipes.PipesConfigBase

Restart the forked PipesServer after it has processed this many files to avoid
 slow-building memory leaks.

getMaxForEmitBatchBytes() - Method in class org.apache.tika.pipes.PipesConfigBase

What is the maximum bytes size per extract that
  will be allowed to be shipped back to the emit queue in the forking process.

getMaximumCompressionRatio() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getMaximumCompressionRatio() - Method in class org.apache.tika.sax.SecureContentHandler

Returns the maximum compression ratio.

getMaximumDepth() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getMaximumDepth() - Method in class org.apache.tika.sax.SecureContentHandler

Returns the maximum XML element nesting level.

getMaximumPackageEntryDepth() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getMaximumPackageEntryDepth() - Method in class org.apache.tika.sax.SecureContentHandler

Returns the maximum package entry nesting level.

getMaxJsonStringFieldLength() - Static method in class org.apache.tika.config.TikaConfig
 
getMaxKeySize() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
getMaxNumReuses() - Static method in class org.apache.tika.utils.XMLReaderUtils

Get the maximum number of times a SAXParser or DOMBuilder may be reused.

getMaxStringLength() - Method in class org.apache.tika.Tika

Returns the maximum length of strings returned by the
 parseToString methods.

getMaxTotalEstimatedBytes() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
getMaxValuesPerField() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
getMaxWaitForClientMillis() - Method in class org.apache.tika.pipes.PipesConfig
 
getMediaTypeRegistry() - Method in class org.apache.tika.config.TikaConfig
 
getMediaTypeRegistry() - Method in class org.apache.tika.mime.MimeTypes
 
getMediaTypeRegistry() - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector
 
getMediaTypeRegistry() - Method in class org.apache.tika.parser.CompositeParser

Returns the media type registry used to infer type relationships.

getMediaTypeRegistry() - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser

Returns the media type registry used to infer type relationships.

getMessage() - Method in exception org.apache.tika.exception.WriteLimitReachedException
 
getMessage() - Method in exception org.apache.tika.pipes.async.OfferLargerThanQueueSize
 
getMessage() - Method in class org.apache.tika.pipes.PipesResult
 
getMetadata() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
getMetadata() - Method in class org.apache.tika.renderer.RenderResult
 
getMetadataCommandArguments() - Method in class org.apache.tika.embedder.ExternalEmbedder

Gets the map of Metadata keys to command line parameters.

getMetadataExtractionPatterns() - Method in class org.apache.tika.parser.external.ExternalParser
 
getMetadataFilter() - Method in class org.apache.tika.config.TikaConfig
 
getMetadataList() - Method in class org.apache.tika.parser.ParseRecord
 
getMetadataList() - Method in class org.apache.tika.pipes.emitter.EmitData
 
getMetadataList() - Method in class org.apache.tika.sax.RecursiveParserWrapperHandler
 
getMetadataListFilter() - Method in class org.apache.tika.config.TikaConfig
 
getMetadataPolicy() - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser
 
getMetadataPolicy(Map<String, Param>) - Static method in class org.apache.tika.parser.multiple.AbstractMultipleParser
 
getMetadataWriteFilterFactory() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getMimeRepository() - Method in class org.apache.tika.config.TikaConfig
 
getMimes() - Method in class org.apache.tika.metadata.filter.ClearByMimeMetadataFilter
 
getMimeType(File) - Method in class org.apache.tika.mime.MimeTypes

Deprecated.
Use Tika.detect(File) instead


getMimeType(String) - Method in class org.apache.tika.mime.MimeTypes

Deprecated.
Use Tika.detect(String) instead


getMimeTypes() - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
getMinLength() - Method in class org.apache.tika.detect.TrainedModelDetector
 
getMinLength() - Method in class org.apache.tika.mime.MimeTypes

Return the minimum length of data to provide to analyzing methods based
 on the document's content in order to check all the known MimeTypes.

getMSB() - Method in class org.apache.tika.metadata.MachineMetadata.Endian
 
getName() - Method in class org.apache.tika.config.Param
 
getName() - Method in class org.apache.tika.config.ParamField
 
getName() - Method in class org.apache.tika.metadata.MachineMetadata.Endian
 
getName() - Method in class org.apache.tika.metadata.Property
 
getName() - Method in class org.apache.tika.mime.MimeType

Returns the name of this media type.

getName() - Method in class org.apache.tika.pipes.emitter.AbstractEmitter
 
getName() - Method in interface org.apache.tika.pipes.emitter.Emitter
 
getName() - Method in class org.apache.tika.pipes.emitter.EmptyEmitter
 
getName() - Method in class org.apache.tika.pipes.fetcher.AbstractFetcher
 
getName() - Method in class org.apache.tika.pipes.fetcher.EmptyFetcher
 
getName() - Method in interface org.apache.tika.pipes.fetcher.Fetcher
 
getName(String) - Static method in class org.apache.tika.io.FilenameUtils

This is a duplication of the algorithm and functionality
 available in commons io FilenameUtils.

getNewContentHandler() - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
 
getNewContentHandler() - Method in class org.apache.tika.sax.BasicContentHandlerFactory
 
getNewContentHandler() - Method in interface org.apache.tika.sax.ContentHandlerFactory
 
getNewContentHandler(OutputStream, Charset) - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
 
getNewContentHandler(OutputStream, Charset) - Method in class org.apache.tika.sax.BasicContentHandlerFactory
 
getNewContentHandler(OutputStream, Charset) - Method in interface org.apache.tika.sax.ContentHandlerFactory
 
getNextId() - Method in class org.apache.tika.renderer.RenderingTracker
 
getNumClients() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getNumEmitters() - Method in class org.apache.tika.pipes.async.AsyncConfig

Number of emitters

getNumOfHidden() - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
getNumOfInputs() - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
getNumOfOutputs() - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
getOnParseException() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
getOnParseException() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
getOpenContainer() - Method in class org.apache.tika.io.TikaInputStream

Returns the open container object if any, such as a
 POIFS FileSystem in the event of an OLE2 document
 being detected and processed by the OLE2 detector.

getOrganizations() - Static method in class org.apache.tika.sax.StandardOrganizations

Returns the map containing the collection of the most important technical standard
 organizations.

getOrganzationsRegex() - Static method in class org.apache.tika.sax.StandardOrganizations

Returns the regular expression containing the most important technical standard
 organizations.

getOutputParser() - Method in class org.apache.tika.parser.external2.ExternalParser
 
getOutputThreshold() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getOutputThreshold() - Method in class org.apache.tika.sax.SecureContentHandler

Returns the configured output threshold.

getPage(int) - Method in class org.apache.tika.renderer.PageBasedRenderResults
 
getParameters() - Method in class org.apache.tika.mime.MediaType

Returns an immutable sorted map of the parameters of this media type.

getParams() - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
getParseContext() - Method in class org.apache.tika.pipes.emitter.EmitData
 
getParseContext() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
getParseMode() - Method in class org.apache.tika.pipes.HandlerConfig
 
getParser() - Method in class org.apache.tika.config.TikaConfig

Returns the configured parser instance.

getParser() - Method in class org.apache.tika.Tika

Returns the parser instance used by this facade.

getParser(Metadata) - Method in class org.apache.tika.parser.CompositeParser

Returns the parser that best matches the given metadata.

getParser(Metadata, ParseContext) - Method in class org.apache.tika.parser.CompositeParser
 
getParserClassname(Parser) - Static method in class org.apache.tika.utils.ParserUtils

Identifies the real class name of the Parser, unwrapping
 any ParserDecorator decorations on top of it.

getParsers() - Method in class org.apache.tika.parser.CompositeParser

Returns the component parsers.

getParsers() - Method in class org.apache.tika.parser.ParseRecord
 
getParsers(ParseContext) - Method in class org.apache.tika.parser.CompositeParser
 
getParsers(ParseContext) - Method in class org.apache.tika.parser.DefaultParser
 
getPassword(Metadata) - Method in interface org.apache.tika.parser.PasswordProvider

Looks up the password for a document with the given metadata,
 and returns it for the Parser.

getPasswordProvider() - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
getPath() - Method in class org.apache.tika.io.TikaInputStream

If the user created this TikaInputStream with a file,
 the original file will be returned.

getPath(int) - Method in class org.apache.tika.io.TikaInputStream
 
getPipesReporter() - Method in class org.apache.tika.pipes.async.AsyncConfig
 
getPipesReporters() - Method in class org.apache.tika.pipes.CompositePipesReporter
 
getPoolSize() - Method in class org.apache.tika.fork.ForkParser

Returns the size of the process pool.

getPoolSize() - Static method in class org.apache.tika.utils.XMLReaderUtils
 
getPos() - Method in class org.apache.tika.io.BoundedInputStream
 
getPosition() - Method in class org.apache.tika.io.TikaInputStream

Returns the current position within the stream.

getPrimaryProperty() - Method in class org.apache.tika.metadata.Property

Gets the primary property for a composite property

getProcessTimeMillis() - Method in class org.apache.tika.utils.FileProcessResult
 
getProperties(String) - Static method in class org.apache.tika.metadata.Property
 
getPropertyType() - Method in class org.apache.tika.metadata.Property
 
getPropertyType(String) - Static method in class org.apache.tika.metadata.Property

Get the type of a property

getProvider() - Method in class org.apache.tika.parser.digest.InputStreamDigester

When subclassing this, becare to ensure that your provider is
 thread-safe (not likely) or return a new provider with each call.

getQNameAsString(QName) - Static method in class org.apache.tika.sax.ElementMappingContentHandler
 
getQueueSize() - Method in class org.apache.tika.pipes.async.AsyncConfig

FetchEmitTuple queue size

getQueueSize() - Method in exception org.apache.tika.pipes.async.OfferLargerThanQueueSize
 
getRangeEnd() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
getRangeStart() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
getRawScore() - Method in class org.apache.tika.language.detect.LanguageResult
 
getRegex() - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
getRegisteredMimeType(String) - Method in class org.apache.tika.mime.MimeTypes

Returns the registered, normalised media type with the given name (or alias).

getRel() - Method in class org.apache.tika.sax.Link
 
getResource(Class<T>) - Method in class org.apache.tika.io.TemporaryResources

Returns the latest of the tracked resources that implements or
 extends the given interface or class.

getResourceAsStream(String) - Method in class org.apache.tika.config.ServiceLoader

Returns an input stream for reading the specified resource from the
 configured class loader.

getResourceName(Metadata, AtomicInteger) - Static method in class org.apache.tika.parser.RecursiveParserWrapper
 
getResults() - Method in class org.apache.tika.renderer.RenderResults
 
getSAXParser() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the SAX parser specified in this parsing context.

getSAXParserFactory() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the SAX parser factory specified in this parsing context.

getSAXTransformerFactory() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns a SAXTransformerFactory.

getScore() - Method in class org.apache.tika.sax.StandardReference
 
getSecondaryExtractProperties() - Method in class org.apache.tika.metadata.Property

Gets the secondary properties for a composite property

getSecondOrganizationAcronym() - Method in class org.apache.tika.sax.StandardReference
 
getSeparator() - Method in class org.apache.tika.sax.StandardReference
 
getServiceClass(Class<T>, String) - Method in class org.apache.tika.config.ServiceLoader

Loads and returns the named service class that's expected to implement
 the given interface.

getServiceLoader() - Method in class org.apache.tika.config.TikaConfig
 
getSetter() - Method in class org.apache.tika.config.ParamField
 
getShortBE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a BE short value from the beginning of a byte array

getShortBE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a BE short value from a byte array

getShortLE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a LE short value from the beginning of a byte array

getShortLE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a LE short value from a byte array

getShutdownClientAfterMillis() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getSizeOffered() - Method in exception org.apache.tika.pipes.async.OfferLargerThanQueueSize
 
getSKIP() - Static method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
getSleepOnStartupTimeoutMillis() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getSourceField() - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
getSpoolToDisk() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getStackTrace(Throwable) - Static method in class org.apache.tika.utils.ExceptionUtils

Get the full stacktrace as a string

getStaleFetcherDelaySeconds() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getStaleFetcherTimeoutSeconds() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getStarted() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
getStartupTimeoutMillis() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getStatelessParser(ParseContext) - Static method in class org.apache.tika.extractor.EmbeddedDocumentUtil

Utility function to get the Parser that was sent in to the
 ParseContext to handle embedded documents.

getStatus() - Method in class org.apache.tika.pipes.pipesiterator.TotalCountResult
 
getStatus() - Method in class org.apache.tika.pipes.PipesResult
 
getStatus() - Method in class org.apache.tika.renderer.RenderResult
 
getStatusCounts() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
getStderr() - Method in class org.apache.tika.utils.FileProcessResult
 
getStderrLength() - Method in class org.apache.tika.utils.FileProcessResult
 
getStdout() - Method in class org.apache.tika.utils.FileProcessResult
 
getStdoutLength() - Method in class org.apache.tika.utils.FileProcessResult
 
getStreamLength() - Method in class org.apache.tika.utils.StreamGobbler
 
getString() - Static method in class org.apache.tika.Tika
 
getSubtype() - Method in class org.apache.tika.mime.MediaType

Return the Sub-Type of the MediaType,
 such as "plain" for "text/plain"

getSuffixFromPath(String) - Static method in class org.apache.tika.io.FilenameUtils

This includes the period, e.g. ".pdf".

getSuffixStrategy() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
getSupertype(MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry

Returns the supertype of the given type.

getSupported() - Method in class org.apache.tika.pipes.emitter.EmitterManager
 
getSupported() - Method in class org.apache.tika.pipes.fetcher.FetcherManager
 
getSupportedEmbedTypes() - Method in class org.apache.tika.embedder.ExternalEmbedder
 
getSupportedEmbedTypes(ParseContext) - Method in interface org.apache.tika.embedder.Embedder

Returns the set of media types supported by this embedder when used with
 the given parse context.

getSupportedEmbedTypes(ParseContext) - Method in class org.apache.tika.embedder.ExternalEmbedder
 
getSupportedTypes() - Method in class org.apache.tika.parser.external.ExternalParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.fork.ForkParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.CompositeParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.CryptoParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.DelegatingParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.EmptyParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.ErrorParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.external.ExternalParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.external2.ExternalParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.NetworkParser
 
getSupportedTypes(ParseContext) - Method in interface org.apache.tika.parser.Parser

Returns the set of media types supported by this parser when used
 with the given parse context.

getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.ParserDecorator

Delegates the method call to the decorated parser.

getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.RecursiveParserWrapper
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.parser.RegexCaptureParser
 
getSupportedTypes(ParseContext) - Method in class org.apache.tika.renderer.CompositeRenderer
 
getSupportedTypes(ParseContext) - Method in interface org.apache.tika.renderer.Renderer

Returns the set of media types supported by this renderer when used
 with the given parse context.

getTag() - Method in exception org.apache.tika.sax.TaggedSAXException

Returns the object reference used as the tag this exception.

getTail() - Method in class org.apache.tika.io.TailStream

Returns an array with the last data read from the underlying stream.

getTargetField() - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
getText() - Method in class org.apache.tika.sax.Link
 
getThreshold() - Method in class org.apache.tika.sax.StandardsExtractingContentHandler

Gets the threshold to be used for selecting the standard references found
 within the text based on their score.

getThrowOnZeroBytes() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
getTikaConfig() - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
getTikaConfig() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getTimeoutMillis() - Method in class org.apache.tika.config.TikaTaskTimeout
 
getTimeoutMillis() - Method in class org.apache.tika.pipes.PipesConfigBase
 
getTimeoutMillis(ParseContext, long) - Static method in class org.apache.tika.config.TikaTaskTimeout
 
getTitle() - Method in class org.apache.tika.sax.Link
 
getTo() - Method in class org.apache.tika.renderer.PageRangeRequest
 
getTotalCount() - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
getTotalCount() - Method in interface org.apache.tika.pipes.pipesiterator.TotalCounter

Returns the total count so far.

getTotalCount() - Method in class org.apache.tika.pipes.pipesiterator.TotalCountResult
 
getTotalCountResult() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
getTotalProcessed() - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
getTransformer() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns a new transformer

getTransformer(ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the transformer specified in this parsing context.

getTransformerFactory() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns a TransformerFactory.

getTranslator() - Method in class org.apache.tika.config.TikaConfig

Returns the configured translator instance.

getTranslator() - Method in class org.apache.tika.language.translate.DefaultTranslator

Returns the current translator

getTranslator() - Method in class org.apache.tika.Tika

Returns the translator instance used by this facade.

getTranslators() - Method in class org.apache.tika.language.translate.DefaultTranslator

Returns all available translators

getType() - Method in class org.apache.tika.config.Param
 
getType() - Method in class org.apache.tika.config.ParamField
 
getType() - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
getType() - Method in class org.apache.tika.mime.MediaType

Return the Type of the MediaType, such as
 "text" for "text/plain"

getType() - Method in class org.apache.tika.mime.MimeType

Returns the normalized media type name.

getType() - Method in class org.apache.tika.pipes.HandlerConfig
 
getType() - Method in class org.apache.tika.sax.BasicContentHandlerFactory
 
getType() - Method in class org.apache.tika.sax.Link
 
getTypes() - Method in class org.apache.tika.metadata.filter.ClearByAttachmentTypeMetadataFilter
 
getTypes() - Method in class org.apache.tika.mime.MediaTypeRegistry

Returns the set of all known canonical media types.

getTypeString() - Method in class org.apache.tika.config.Param
 
getUByte(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

get the unsigned value of a byte.

getUIntBE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a BE unsigned int value from a byte array

getUIntBE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a BE unsigned int value from a byte array

getUIntLE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a LE unsigned int value from a byte array

getUIntLE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a LE unsigned int value from a byte array

getUniformTypeIdentifier() - Method in class org.apache.tika.mime.MimeType

Get the UTI for this mime type.

getUri() - Method in class org.apache.tika.sax.Link
 
getUShortBE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a BE unsigned short value from the beginning of a byte array

getUShortBE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a BE unsigned short value from a byte array

getUShortLE(byte[]) - Static method in class org.apache.tika.io.EndianUtils

Get a LE unsigned short value from the beginning of a byte array

getUShortLE(byte[], int) - Static method in class org.apache.tika.io.EndianUtils

Get a LE unsigned short value from a byte array

getValue() - Method in class org.apache.tika.config.Param
 
getValues(String) - Method in class org.apache.tika.metadata.Metadata

Get the values associated to a metadata name.

getValues(Property) - Method in class org.apache.tika.metadata.Metadata

Get the values associated to a metadata name.

getValueType() - Method in class org.apache.tika.metadata.Property
 
getWarnings() - Method in class org.apache.tika.parser.ParseRecord
 
getWrappedParser() - Method in class org.apache.tika.parser.ParserDecorator

Gets the parser wrapped by this ParserDecorator

getWriteLimit() - Method in class org.apache.tika.pipes.HandlerConfig
 
getWriteLimit() - Method in class org.apache.tika.sax.BasicContentHandlerFactory
 
getWriteLimit() - Method in interface org.apache.tika.sax.WriteLimiter
 
getXMLInputFactory() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the StAX input factory specified in this parsing context.

getXMLInputFactory(ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the StAX input factory specified in this parsing context.

getXMLReader() - Static method in class org.apache.tika.utils.XMLReaderUtils

Returns the XMLReader specified in this parsing context.

getZeroPadName() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
GLOB_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 




H

handle(String, MediaType, InputStream) - Method in interface org.apache.tika.extractor.EmbeddedResourceHandler

Called to process an embedded resource within the container.

handleException(SAXException) - Method in class org.apache.tika.sax.ContentHandlerDecorator

Handle any exceptions thrown by methods in this class.

handleException(SAXException) - Method in class org.apache.tika.sax.TaggedContentHandler

Tags any SAXExceptions thrown, wrapping and re-throwing.

handleGlobError(MimeType, String, MimeTypeException, String, Attributes) - Method in class org.apache.tika.mime.MimeTypesReader
 
handleInitializableProblem(String, String) - Method in interface org.apache.tika.config.InitializableProblemHandler
 
handleLoadError(String, Throwable) - Method in interface org.apache.tika.config.LoadErrorHandler

Handles a problem encountered when trying to load the specified
 service class.

handleMimeError(String, MimeTypeException, String, Attributes) - Method in class org.apache.tika.mime.MimeTypesReader
 
HandlerConfig - Class in org.apache.tika.pipes
 
HandlerConfig() - Constructor for class org.apache.tika.pipes.HandlerConfig
 
HandlerConfig(BasicContentHandlerFactory.HANDLER_TYPE, HandlerConfig.PARSE_MODE, int, int, boolean) - Constructor for class org.apache.tika.pipes.HandlerConfig
 
HandlerConfig.PARSE_MODE - Enum in org.apache.tika.pipes

HandlerConfig.PARSE_MODE.RMETA "recursive metadata" is the same as the -J option
 in tika-app and the /rmeta endpoint in tika-server.

handleSettings(Set<String>) - Method in class org.apache.tika.config.ConfigBase

This should be overridden to do something with the settings
 after loading the object.

HAS_3D - Static variable in interface org.apache.tika.metadata.PDF

If the PDF has an annotation of type 3D

HAS_ACROFORM_FIELDS - Static variable in interface org.apache.tika.metadata.PDF

Has > 0 AcroForm fields

HAS_COLLECTION - Static variable in interface org.apache.tika.metadata.PDF

Has a collection element in the root.

HAS_COMMENTS - Static variable in interface org.apache.tika.metadata.Office
 
HAS_HIDDEN_COLUMNS - Static variable in interface org.apache.tika.metadata.Office
 
HAS_HIDDEN_ROWS - Static variable in interface org.apache.tika.metadata.Office
 
HAS_HIDDEN_SHEETS - Static variable in interface org.apache.tika.metadata.Office
 
HAS_MARKED_CONTENT - Static variable in interface org.apache.tika.metadata.PDF
 
HAS_SIGNATURE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
HAS_VERY_HIDDEN_SHEETS - Static variable in interface org.apache.tika.metadata.Office
 
HAS_XFA - Static variable in interface org.apache.tika.metadata.PDF

Has XFA

HAS_XMP - Static variable in interface org.apache.tika.metadata.PDF

Has XMP, whether or not it is valid

hasEnoughText() - Method in class org.apache.tika.language.detect.LanguageDetector

Tell the caller whether more text is required for the current document
 before the language can be reliably detected.

hasFile() - Method in class org.apache.tika.io.TikaInputStream
 
hashCode() - Method in class org.apache.tika.metadata.Metadata
 
hashCode() - Method in class org.apache.tika.metadata.Property
 
hashCode() - Method in class org.apache.tika.mime.MediaType
 
hashCode() - Method in class org.apache.tika.mime.MimeType
 
hashCode() - Method in class org.apache.tika.parser.ParseContext
 
hashCode() - Method in class org.apache.tika.pipes.emitter.EmitKey
 
hashCode() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
hashCode() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
hashCode() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
hashCode() - Method in class org.apache.tika.pipes.HandlerConfig
 
hashCode() - Method in class org.apache.tika.renderer.PageRangeRequest
 
hasHitBound() - Method in class org.apache.tika.io.BoundedInputStream
 
hasHitMaximumEmbeddedResources() - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler
 
hasInputStreamFactory() - Method in class org.apache.tika.io.TikaInputStream
 
hasLength() - Method in class org.apache.tika.io.TikaInputStream
 
hasMacroLanguage(String) - Static method in class org.apache.tika.language.detect.LanguageNames
 
hasMagic() - Method in class org.apache.tika.mime.MimeType
 
hasModel(String) - Method in class org.apache.tika.language.detect.LanguageDetector

Provide information about whether a model exists for a specific
 language.

hasParameters() - Method in class org.apache.tika.mime.MediaType

Checks whether this media type contains parameters.

hasRange() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
HEADLINE - Static variable in interface org.apache.tika.metadata.IPTC

A brief synopsis of the caption.

HEADLINE - Static variable in interface org.apache.tika.metadata.Photoshop
 
HexCoDec - Class in org.apache.tika.mime

A set of Hex encoding and decoding utility methods.

HexCoDec() - Constructor for class org.apache.tika.mime.HexCoDec
 
HIDDEN_SHEET_NAMES - Static variable in interface org.apache.tika.metadata.Office
 
HIDDEN_SLIDES - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
HIGH - org.apache.tika.language.detect.LanguageConfidence
 
HISTORY - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
HISTORY_ACTION - Static variable in interface org.apache.tika.metadata.XMPMM

Action in the XMPMM's history section

HISTORY_EVENT_INSTANCEID - Static variable in interface org.apache.tika.metadata.XMPMM

Instance id in the XMPMM's history section

HISTORY_SOFTWARE_AGENT - Static variable in interface org.apache.tika.metadata.XMPMM

Software agent that created the action in the XMPMM's
 history section

HISTORY_WHEN - Static variable in interface org.apache.tika.metadata.XMPMM

When the action occurred in the XMPMM's history section

HTML - org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE
 
HTML - Interface in org.apache.tika.metadata
 
HttpHeaders - Interface in org.apache.tika.metadata

A collection of HTTP header names.





I

ID - Static variable in interface org.apache.tika.metadata.QuattroPro

ID.

IDENTIFIER - Static variable in interface org.apache.tika.metadata.DublinCore

Recommended best practice is to identify the resource by means of
 a string or number conforming to a formal identification system.

IDENTIFIER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
IDENTIFIER - Static variable in interface org.apache.tika.metadata.XMP

An unordered array of text strings that unambiguously identify the resource
 within a given context.

IDENTIFIER - Static variable in interface org.apache.tika.metadata.XMPDC

Recommended best practice is to identify the resource by means of
 a string or number conforming to a formal identification system.

identifyStaticServiceProviders(Class<T>) - Method in class org.apache.tika.config.ServiceLoader

Returns the defined static service providers of the given type, without
 attempting to load them.

ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.DIFContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.LinkContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.SafeContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.SecureContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.TeeContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.TextContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.ToTextContentHandler

Writes the given ignorable characters to the given character stream.

ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.WriteOutContentHandler
 
ignorableWhitespace(char[], int, int) - Method in class org.apache.tika.sax.xpath.MatchingContentHandler
 
IGNORE - org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE
 
IGNORE - Static variable in interface org.apache.tika.config.InitializableProblemHandler

Strategy that simply ignores all problems.

IGNORE - Static variable in interface org.apache.tika.config.LoadErrorHandler

Strategy that simply ignores all problems.

IGNORE_ZERO_BYTE_FILE_EXCEPTION - Static variable in exception org.apache.tika.exception.ZeroByteFileException

If this is in the ParseContext, the
 AutoDetectParser and the
 RecursiveParserWrapper will
 ignore embedded files with zero-byte length inputstreams

IgnoreZeroByteFileException() - Constructor for class org.apache.tika.exception.ZeroByteFileException.IgnoreZeroByteFileException
 
ILLUSTRATOR_TYPE - Static variable in interface org.apache.tika.metadata.PDF
 
image(String) - Static method in class org.apache.tika.mime.MediaType
 
IMAGE_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Images in the document

IMAGE_CREATOR - Static variable in interface org.apache.tika.metadata.IPTC

Creator or creators of the image.

IMAGE_CREATOR_ID - Static variable in interface org.apache.tika.metadata.IPTC

The ID of the creator or creators of the image.

IMAGE_CREATOR_ID_WRONG_CASE - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated.
use IPTC.IMAGE_CREATOR_ID


IMAGE_CREATOR_NAME - Static variable in interface org.apache.tika.metadata.IPTC

The name of the creator or creators of the image.

IMAGE_LENGTH - Static variable in interface org.apache.tika.metadata.TIFF

"Image height in pixels."

IMAGE_REGISTRY_ENTRY - Static variable in interface org.apache.tika.metadata.IPTC

Both a Registry Item Id and a Registry Organisation Id to record any
 registration of this item with a registry.

IMAGE_SUPPLIER - Static variable in interface org.apache.tika.metadata.IPTC

Identifies the most recent supplier of the item, who is not necessarily
 its owner or creator.

IMAGE_SUPPLIER_ID - Static variable in interface org.apache.tika.metadata.IPTC

Identifies the most recent supplier of the item, who is not necessarily
 its owner or creator.

IMAGE_SUPPLIER_ID_WRONG_CASE - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated.
use IPTC.IMAGE_SUPPLIER_ID


IMAGE_SUPPLIER_IMAGE_ID - Static variable in interface org.apache.tika.metadata.IPTC

Optional identifier assigned by the Image Supplier to the image.

IMAGE_SUPPLIER_NAME - Static variable in interface org.apache.tika.metadata.IPTC

Identifies the most recent supplier of the item, who is not necessarily
 its owner or creator.

IMAGE_WIDTH - Static variable in interface org.apache.tika.metadata.TIFF

"Image width in pixels."

IMPORTANCE - Static variable in interface org.apache.tika.metadata.MAPI
 
IN_REPLY_TO_ID - Static variable in interface org.apache.tika.metadata.MAPI
 
IncludeFieldMetadataFilter - Class in org.apache.tika.metadata.filter
 
IncludeFieldMetadataFilter() - Constructor for class org.apache.tika.metadata.filter.IncludeFieldMetadataFilter
 
IncludeFieldMetadataFilter(Set<String>) - Constructor for class org.apache.tika.metadata.filter.IncludeFieldMetadataFilter
 
INCREMENTAL_UPDATE_NUMBER - Static variable in interface org.apache.tika.metadata.PDF

This is a zero-based number for incremental updates within a PDF -- 0 is the first
 update, 1 is the second, etc.

INFO - Static variable in interface org.apache.tika.config.InitializableProblemHandler

Strategy that logs warnings of all problems using a Logger
 created using the given class name.

init(DataInputStream, DataOutputStream) - Method in interface org.apache.tika.fork.ForkProxy
 
INITIAL_AUTHOR - Static variable in interface org.apache.tika.metadata.Office

Name of the initial creator/author of a document

Initializable - Interface in org.apache.tika.config

Components that must do special processing across multiple fields
 at initialization time should implement this interface.

InitializableProblemHandler - Interface in org.apache.tika.config

This is to be used to handle potential recoverable problems that
 might arise during initialization.

initialize(Map<String, Param>) - Method in interface org.apache.tika.config.Initializable
 
initialize(Map<String, Param>) - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
initialize(Map<String, Param>) - Method in class org.apache.tika.parser.external2.ExternalParser
 
initialize(Map<String, Param>) - Method in class org.apache.tika.parser.RegexCaptureParser
 
initialize(Map<String, Param>) - Method in class org.apache.tika.pipes.CompositePipesReporter
 
initialize(Map<String, Param>) - Method in class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher
 
initialize(Map<String, Param>) - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
initialize(Map<String, Param>) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
initialize(Map<String, Param>) - Method in class org.apache.tika.pipes.PipesReporterBase
 
initialize(Map<String, Param>) - Method in class org.apache.tika.renderer.CompositeRenderer
 
initializeResources() - Method in class org.apache.tika.pipes.PipesServer
 
INLINE - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
INPUT_FILE_TOKEN - Static variable in class org.apache.tika.parser.external.ExternalParser

The token, which if present in the Command string, will
 be replaced with the input filename.

INPUT_FILE_TOKEN - Static variable in class org.apache.tika.parser.external2.ExternalParser
 
InputStreamDigester - Class in org.apache.tika.parser.digest
 
InputStreamDigester(int, String, String, DigestingParser.Encoder) - Constructor for class org.apache.tika.parser.digest.InputStreamDigester
 
InputStreamDigester(int, String, DigestingParser.Encoder) - Constructor for class org.apache.tika.parser.digest.InputStreamDigester
 
InputStreamFactory - Interface in org.apache.tika.io

A factory which returns a fresh InputStream for the same
 resource each time.

INSTANCE - Static variable in class org.apache.tika.detect.EmptyDetector

Singleton instance of this class.

INSTANCE - Static variable in class org.apache.tika.parser.EmptyParser

Singleton instance of this class.

INSTANCE - Static variable in class org.apache.tika.parser.ErrorParser

Singleton instance of this class.

INSTANCE - Static variable in exception org.apache.tika.sax.StoppingEarlyException
 
INSTANCE - Static variable in class org.apache.tika.sax.xpath.AttributeMatcher
 
INSTANCE - Static variable in class org.apache.tika.sax.xpath.ElementMatcher
 
INSTANCE - Static variable in class org.apache.tika.sax.xpath.NodeMatcher
 
INSTANCE - Static variable in class org.apache.tika.sax.xpath.TextMatcher
 
INSTANCEID - Static variable in interface org.apache.tika.metadata.XMPMM

An identifier for a specific incarnation of a resource, updated
 each time a file is saved.

inStartElement - Variable in class org.apache.tika.sax.ToXMLContentHandler
 
INSTITUTION - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
INSTRUCTIONS - Static variable in interface org.apache.tika.metadata.IPTC

Any of a number of instructions from the provider or creator to the
 receiver of the item.

INSTRUCTIONS - Static variable in interface org.apache.tika.metadata.Photoshop
 
INSTRUMENT - Static variable in interface org.apache.tika.metadata.XMPDM

"The musical instrument."

INTEGER - org.apache.tika.metadata.Property.ValueType
 
INTELLECTUAL_GENRE - Static variable in interface org.apache.tika.metadata.IPTC

Describes the nature, intellectual, artistic or journalistic
 characteristic of a item, not specifically its content.

INTERMEDIATE_RESULT - org.apache.tika.pipes.PipesResult.STATUS
 
INTERMEDIATE_RESULT - org.apache.tika.pipes.PipesServer.STATUS
 
internalBoolean(String) - Static method in class org.apache.tika.metadata.Property
 
internalClosedChoise(String, String...) - Static method in class org.apache.tika.metadata.Property
 
internalDate(String) - Static method in class org.apache.tika.metadata.Property
 
internalDateBag(String) - Static method in class org.apache.tika.metadata.Property
 
internalInteger(String) - Static method in class org.apache.tika.metadata.Property
 
internalIntegerSequence(String) - Static method in class org.apache.tika.metadata.Property
 
internalOpenChoise(String, String...) - Static method in class org.apache.tika.metadata.Property
 
internalRational(String) - Static method in class org.apache.tika.metadata.Property
 
internalReal(String) - Static method in class org.apache.tika.metadata.Property
 
internalText(String) - Static method in class org.apache.tika.metadata.Property
 
internalTextBag(String) - Static method in class org.apache.tika.metadata.Property
 
internalURI(String) - Static method in class org.apache.tika.metadata.Property
 
INTERNET_MESSAGE_ID - Static variable in interface org.apache.tika.metadata.MAPI
 
INTERNET_REFERENCES - Static variable in interface org.apache.tika.metadata.MAPI
 
INTERPRETED_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
INTERRUPTED_EXCEPTION - org.apache.tika.pipes.PipesResult.STATUS
 
INTERRUPTED_EXCEPTION - Static variable in class org.apache.tika.pipes.PipesResult
 
IOUtils - Class in org.apache.tika.io
 
IOUtils() - Constructor for class org.apache.tika.io.IOUtils
 
IPTC - Interface in org.apache.tika.metadata

IPTC photo metadata schema.

IPTC_LAST_EDITED - Static variable in interface org.apache.tika.metadata.IPTC

The date and optionally time when any of the IPTC photo metadata fields
 has been last edited

IS_ENCRYPTED - Static variable in interface org.apache.tika.metadata.PDF
 
IS_ENCRYPTED - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
IS_FLAGGED - Static variable in interface org.apache.tika.metadata.MAPI
 
IS_OS_AIX - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_HP_UX - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_IRIX - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_LINUX - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_MAC - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_MAC_OSX - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_OS2 - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_SOLARIS - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_SUN_OS - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_UNIX - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_VERSION_WSL - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_OS_WINDOWS - Static variable in class org.apache.tika.utils.SystemUtils
 
IS_TIMEOUT - Static variable in interface org.apache.tika.metadata.ExternalProcess

Was the process timed out

IS_VALID - Static variable in interface org.apache.tika.metadata.PST
 
isAnchor() - Method in class org.apache.tika.sax.Link
 
isAvailable() - Method in class org.apache.tika.language.translate.DefaultTranslator
 
isAvailable() - Method in class org.apache.tika.language.translate.EmptyTranslator
 
isAvailable() - Method in interface org.apache.tika.language.translate.Translator
 
isBlank(String) - Static method in class org.apache.tika.utils.StringUtils
 
isCauseOf(SAXException) - Method in class org.apache.tika.sax.TaggedContentHandler

Tests if the given exception was caused by this handler.

isDynamic() - Method in class org.apache.tika.config.ServiceLoader

Returns if the service loader is static or dynamic

isEmitIntermediateResults() - Method in class org.apache.tika.pipes.async.AsyncConfig
 
isEmpty() - Method in class org.apache.tika.parser.ParseContext
 
isEmpty(CharSequence) - Static method in class org.apache.tika.utils.StringUtils
 
isEndDocumentWasCalled() - Method in class org.apache.tika.sax.EndDocumentShieldingContentHandler
 
isExternal() - Method in class org.apache.tika.metadata.Property
 
isExtractEmbeddedDocumentBytes() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
isExtractFileSystemMetadata() - Method in class org.apache.tika.pipes.fetcher.fs.config.FileSystemFetcherConfig
 
isIframe() - Method in class org.apache.tika.sax.Link
 
isImage() - Method in class org.apache.tika.sax.Link
 
isIncludeEmpty() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
isIncludeOriginal() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
isInstanceOf(String, MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry

Parses and normalises the given media type string and checks whether
 the result equals the given base type or is a specialization of it.

isInstanceOf(MediaType, MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry

Checks whether the given media type equals the given base type or
 is a specialization of it.

isIntermediate() - Method in class org.apache.tika.pipes.PipesResult
 
isInternal() - Method in class org.apache.tika.metadata.Property
 
isInvalid(int) - Method in class org.apache.tika.sax.SafeContentHandler

Checks whether the given Unicode character is an invalid XML character
 and should be replaced for output.

isInvalid(int) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
isLanguage(String) - Method in class org.apache.tika.language.detect.LanguageResult

Return true if the target language matches the detected language.

isLink() - Method in class org.apache.tika.sax.Link
 
isMacroLanguage(String) - Static method in class org.apache.tika.language.detect.LanguageNames
 
isMixedLanguages() - Method in class org.apache.tika.language.detect.LanguageDetector
 
isMostlyAscii() - Method in class org.apache.tika.detect.TextStatistics

Checks whether at least one byte was seen and that the bytes that
 were seen were mostly plain text (i.e.

isMSB() - Method in class org.apache.tika.metadata.MachineMetadata.Endian
 
isMultiValued(String) - Method in class org.apache.tika.metadata.Metadata

Returns true if named value is multivalued.

isMultiValued(Property) - Method in class org.apache.tika.metadata.Metadata

Returns true if named value is multivalued.

isMultiValuePermitted() - Method in class org.apache.tika.metadata.Property

Is the PropertyType one which accepts multiple values?

ISO_SPEED_RATINGS - Static variable in interface org.apache.tika.metadata.TIFF

"ISO Speed and ISO Latitude of the input device as specified in ISO 12232"

isQuoteAssignmentValues() - Method in class org.apache.tika.embedder.ExternalEmbedder

Gets whether or not to quote assignment values, i.e. tag='value'.

isReasonablyCertain() - Method in class org.apache.tika.language.detect.LanguageResult
 
ISREGEX_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
isRequired() - Method in class org.apache.tika.config.ParamField
 
isScript() - Method in class org.apache.tika.sax.Link
 
isShortText() - Method in class org.apache.tika.language.detect.LanguageDetector
 
isSkipContainerDocument() - Method in interface org.apache.tika.parser.DigestingParser.DigesterFactory
 
isSpecializationOf(MediaType, MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry

Checks whether the given media type a is a specialization of a more
 generic type b.

isStderrTruncated() - Method in class org.apache.tika.utils.FileProcessResult
 
isStdoutTruncated() - Method in class org.apache.tika.utils.FileProcessResult
 
isSupported(String) - Static method in class org.apache.tika.utils.CharsetUtils

Safely return whether  is supported, without throwing exceptions

isSupported(TikaInputStream) - Method in interface org.apache.tika.extractor.ContainerExtractor

Is this Container Extractor able to process the
 supplied container?

isSupported(TikaInputStream) - Method in class org.apache.tika.extractor.ParserContainerExtractor
 
isThrowOnWriteLimitReached() - Method in class org.apache.tika.pipes.HandlerConfig
 
isThrowOnWriteLimitReached() - Method in class org.apache.tika.sax.BasicContentHandlerFactory
 
isThrowOnWriteLimitReached() - Method in interface org.apache.tika.sax.WriteLimiter
 
isTikaInputStream(InputStream) - Static method in class org.apache.tika.io.TikaInputStream

Checks whether the given stream is a TikaInputStream instance.

isTimeout() - Method in class org.apache.tika.utils.FileProcessResult
 
isUnknown() - Method in class org.apache.tika.language.detect.LanguageResult
 
isUseMime() - Method in class org.apache.tika.detect.FileCommandDetector
 
isValid(String) - Static method in class org.apache.tika.mime.MimeType

Checks that the given string is a valid Internet media type name
 based on rules from RFC 2054 section 5.3.

isWriteFileNameToContent() - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
isWriteLimitReached() - Method in class org.apache.tika.parser.ParseRecord
 
isWriteLimitReached(Throwable) - Static method in exception org.apache.tika.exception.WriteLimitReachedException

Checks whether the given exception (or any of it's root causes) was
 thrown by this handler as a signal of reaching the write limit.

iterator() - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 




J

JOB_ID - Static variable in interface org.apache.tika.metadata.IPTC

Number or identifier for the purpose of improved workflow handling.

joinWith(String, List<String>) - Static method in class org.apache.tika.utils.StringUtils
 




K

KEEP_ALL - org.apache.tika.parser.multiple.AbstractMultipleParser.MetadataPolicy

Where multiple parsers output a given key,
 store all their different (unique) values

KEY - Static variable in interface org.apache.tika.metadata.XMPDM

"The audio's musical key."

KEY_WORDS - Static variable in interface org.apache.tika.metadata.XMPPDF

Unordered text strings of keywords.

keySet() - Method in class org.apache.tika.parser.ParseContext
 
KEYWORDS - Static variable in interface org.apache.tika.metadata.IPTC

Keywords to express the subject of the content.

KEYWORDS - Static variable in interface org.apache.tika.metadata.Office

Keywords pertaining to a document.





L

LABEL - Static variable in interface org.apache.tika.metadata.XMP

A word or short phrase that identifies a resource as a member of a userdefined collection.

LANGUAGE - Static variable in interface org.apache.tika.metadata.DublinCore

A language of the intellectual content of the resource.

LANGUAGE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
LANGUAGE - Static variable in interface org.apache.tika.metadata.XMPDC

A language of the intellectual content of the resource.

LanguageConfidence - Enum in org.apache.tika.language.detect
 
LanguageDetector - Class in org.apache.tika.language.detect
 
LanguageDetector() - Constructor for class org.apache.tika.language.detect.LanguageDetector
 
LanguageHandler - Class in org.apache.tika.language.detect

SAX content handler that updates a language detector based on all the
 received character content.

LanguageHandler() - Constructor for class org.apache.tika.language.detect.LanguageHandler
 
LanguageHandler(LanguageDetector) - Constructor for class org.apache.tika.language.detect.LanguageHandler
 
LanguageHandler(LanguageWriter) - Constructor for class org.apache.tika.language.detect.LanguageHandler
 
LanguageNames - Class in org.apache.tika.language.detect

Support for language tags (as defined by https://tools.ietf.org/html/bcp47)

LanguageNames() - Constructor for class org.apache.tika.language.detect.LanguageNames
 
LanguageResult - Class in org.apache.tika.language.detect
 
LanguageResult(String, LanguageConfidence, float) - Constructor for class org.apache.tika.language.detect.LanguageResult
 
LanguageWriter - Class in org.apache.tika.language.detect

Writer that builds a language profile based on all the written content.

LanguageWriter(LanguageDetector) - Constructor for class org.apache.tika.language.detect.LanguageWriter
 
LAST_AUTHOR - Static variable in interface org.apache.tika.metadata.Office

Name of the last (most recent) author of a document

LAST_MODIFIED_BY - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

The user who performed the last modification.

LAST_PRINTED - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

The date and time of the last printing.

LAST_WINS - org.apache.tika.parser.multiple.AbstractMultipleParser.MetadataPolicy

The last parser to output a given key wins,
 overriding previous parser values for a
 clashing key.

LATITUDE - Static variable in interface org.apache.tika.metadata.Geographic

The WGS84 Latitude of the Point

LATITUDE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
leftPad(String, int, char) - Static method in class org.apache.tika.utils.StringUtils
 
leftPad(String, int, String) - Static method in class org.apache.tika.utils.StringUtils

Left pad a String with a specified String.

LICENSE_LOCATION - Static variable in interface org.apache.tika.metadata.CreativeCommons
 
LICENSE_URL - Static variable in interface org.apache.tika.metadata.CreativeCommons
 
LICENSOR - Static variable in interface org.apache.tika.metadata.IPTC

A person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_CITY - Static variable in interface org.apache.tika.metadata.IPTC

The city of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_COUNTRY - Static variable in interface org.apache.tika.metadata.IPTC

The country of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_EMAIL - Static variable in interface org.apache.tika.metadata.IPTC

The email of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_EXTENDED_ADDRESS - Static variable in interface org.apache.tika.metadata.IPTC

The extended address of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_ID - Static variable in interface org.apache.tika.metadata.IPTC

The ID of the person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_ID_WRONG_CASE - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated.
use IPTC.LICENSOR_ID


LICENSOR_NAME - Static variable in interface org.apache.tika.metadata.IPTC

The name of the person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_POSTAL_CODE - Static variable in interface org.apache.tika.metadata.IPTC

The postal code of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_REGION - Static variable in interface org.apache.tika.metadata.IPTC

The region of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_STREET_ADDRESS - Static variable in interface org.apache.tika.metadata.IPTC

The street address of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_TELEPHONE_1 - Static variable in interface org.apache.tika.metadata.IPTC

The phone number of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_TELEPHONE_2 - Static variable in interface org.apache.tika.metadata.IPTC

The phone number of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LICENSOR_URL - Static variable in interface org.apache.tika.metadata.IPTC

The URL of a person or company that should be contacted to obtain a licence for
 using the item or who has licensed the item.

LINE_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of lines in the document

Link - Class in org.apache.tika.sax
 
Link(String, String, String, String) - Constructor for class org.apache.tika.sax.Link
 
Link(String, String, String, String, String) - Constructor for class org.apache.tika.sax.Link
 
LinkContentHandler - Class in org.apache.tika.sax

Content handler that collects links from an XHTML document.

LinkContentHandler() - Constructor for class org.apache.tika.sax.LinkContentHandler

Default constructor

LinkContentHandler(boolean) - Constructor for class org.apache.tika.sax.LinkContentHandler

Default constructor

LITTLE - Static variable in class org.apache.tika.metadata.MachineMetadata.Endian
 
load(InputStream) - Static method in class org.apache.tika.config.Param
 
load(InputStream) - Static method in class org.apache.tika.pipes.PipesConfig
 
load(Path) - Static method in class org.apache.tika.pipes.async.AsyncConfig
 
load(Path) - Static method in class org.apache.tika.pipes.emitter.EmitterManager
 
load(Path) - Static method in class org.apache.tika.pipes.fetcher.FetcherManager
 
load(Path) - Static method in class org.apache.tika.pipes.PipesConfig
 
load(Element) - Static method in class org.apache.tika.parser.AutoDetectParserConfig
 
load(Element, boolean) - Static method in class org.apache.tika.metadata.filter.MetadataFilter

Loads the metadata filter from the config file if it exists, otherwise returns NoOpFilter

load(Element, boolean) - Static method in class org.apache.tika.metadata.listfilter.MetadataListFilter

Loads the metadata list filter from the config file if it exists, otherwise returns NoOpFilter

load(Node) - Static method in class org.apache.tika.config.Param
 
loadDefaultModels(File) - Method in class org.apache.tika.detect.TrainedModelDetector
 
loadDefaultModels(InputStream) - Method in class org.apache.tika.detect.NNExampleModelDetector
 
loadDefaultModels(InputStream) - Method in class org.apache.tika.detect.TrainedModelDetector
 
loadDefaultModels(ClassLoader) - Method in class org.apache.tika.detect.NNExampleModelDetector

this method gets overwritten to register load neural network models

loadDefaultModels(ClassLoader) - Method in class org.apache.tika.detect.TrainedModelDetector
 
loadDefaultModels(Path) - Method in class org.apache.tika.detect.TrainedModelDetector
 
loadDynamicServiceProviders(Class<T>) - Method in class org.apache.tika.config.ServiceLoader

Returns the available dynamic service providers of the given type.

LoadErrorHandler - Interface in org.apache.tika.config

Interface for error handling strategies in service class loading.

loadModels() - Method in class org.apache.tika.language.detect.LanguageDetector

Load (or re-load) all available language models.

loadModels(Set<String>) - Method in class org.apache.tika.language.detect.LanguageDetector

Load (or re-load) the models specified in .

loadServiceProviders(Class<T>) - Method in class org.apache.tika.config.ServiceLoader

Returns all the available service providers of the given type.

loadStaticServiceProviders(Class<T>) - Method in class org.apache.tika.config.ServiceLoader
 
loadStaticServiceProviders(Class<T>, Collection<Class<? extends T>>) - Method in class org.apache.tika.config.ServiceLoader

Returns the available static service providers of the given type.

LOCAL_NAME_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
LOCALE - org.apache.tika.metadata.Property.ValueType
 
LOCATION - Static variable in interface org.apache.tika.metadata.HttpHeaders
 
LOCATION_CREATED - Static variable in interface org.apache.tika.metadata.IPTC

The location the content of the item was created.

LOCATION_CREATED_CITY - Static variable in interface org.apache.tika.metadata.IPTC

Name of the city of a location.

LOCATION_CREATED_COUNTRY_CODE - Static variable in interface org.apache.tika.metadata.IPTC

The ISO code of a country of a location.

LOCATION_CREATED_COUNTRY_NAME - Static variable in interface org.apache.tika.metadata.IPTC

The name of a country of a location.

LOCATION_CREATED_PROVINCE_OR_STATE - Static variable in interface org.apache.tika.metadata.IPTC

The name of a subregion of a country - a province or state - of a
 location.

LOCATION_CREATED_SUBLOCATION - Static variable in interface org.apache.tika.metadata.IPTC

Name of a sublocation.

LOCATION_CREATED_WORLD_REGION - Static variable in interface org.apache.tika.metadata.IPTC

The name of a world region of a location.

LOCATION_SHOWN - Static variable in interface org.apache.tika.metadata.IPTC

A location the content of the item is about.

LOCATION_SHOWN_CITY - Static variable in interface org.apache.tika.metadata.IPTC

Name of the city of a location.

LOCATION_SHOWN_COUNTRY_CODE - Static variable in interface org.apache.tika.metadata.IPTC

The ISO code of a country of a location.

LOCATION_SHOWN_COUNTRY_NAME - Static variable in interface org.apache.tika.metadata.IPTC

The name of a country of a location.

LOCATION_SHOWN_PROVINCE_OR_STATE - Static variable in interface org.apache.tika.metadata.IPTC

The name of a subregion of a country - a province or state - of a
 location.

LOCATION_SHOWN_SUBLOCATION - Static variable in interface org.apache.tika.metadata.IPTC

Name of a sublocation.

LOCATION_SHOWN_WORLD_REGION - Static variable in interface org.apache.tika.metadata.IPTC

The name of a world region of a location.

LOG_COMMENT - Static variable in interface org.apache.tika.metadata.XMPDM

"User's log comments."

LoggingPipesReporter - Class in org.apache.tika.pipes

Simple PipesReporter that logs everything at the debug level.

LoggingPipesReporter() - Constructor for class org.apache.tika.pipes.LoggingPipesReporter
 
LONGITUDE - Static variable in interface org.apache.tika.metadata.Geographic

The WGS84 Longitude of the Point

LONGITUDE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
LookaheadInputStream - Class in org.apache.tika.io

Stream wrapper that make it easy to read up to n bytes ahead from
 a stream that supports the mark feature.

LookaheadInputStream(InputStream, int) - Constructor for class org.apache.tika.io.LookaheadInputStream

Creates a lookahead wrapper for the given input stream.

looksLikeUTF8() - Method in class org.apache.tika.detect.TextStatistics

Checks whether the observed byte stream looks like UTF-8 encoded text.

lookup(int) - Static method in enum org.apache.tika.pipes.PipesServer.STATUS
 
LOOP - Static variable in interface org.apache.tika.metadata.XMPDM

"When true, the clip can be looped seamlessly."

LOW - org.apache.tika.language.detect.LanguageConfidence
 
LOWEST_VERSION - Static variable in interface org.apache.tika.metadata.QuattroPro

Lowest version.





M

MACHINE_ALPHA - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_ARM - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_EFI - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_IA_64 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_M32R - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_M68K - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_M88K - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_MIPS - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_PPC - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_S370 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_S390 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_SH3 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_SH4 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_SH5 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_SPARC - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_TYPE - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_UNKNOWN - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_VAX - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_x86_32 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MACHINE_x86_64 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
MachineMetadata - Interface in org.apache.tika.metadata

Metadata for describing machines, such as their
 architecture, type and endian-ness

MachineMetadata.Endian - Class in org.apache.tika.metadata
 
MACRO - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
magic_neg(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
MAGIC_PRIORITY_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MAGIC_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
magic_trust(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
MagicDetector - Class in org.apache.tika.detect

Content type detection based on magic bytes, i.e. type-specific patterns
 near the beginning of the document input stream.

MagicDetector(MediaType, byte[]) - Constructor for class org.apache.tika.detect.MagicDetector

Creates a detector for input documents that have the exact given byte
 pattern at the beginning of the document stream.

MagicDetector(MediaType, byte[], byte[], boolean, boolean, int, int) - Constructor for class org.apache.tika.detect.MagicDetector

Creates a detector for input documents that meet the specified
 magic match.

MagicDetector(MediaType, byte[], byte[], boolean, int, int) - Constructor for class org.apache.tika.detect.MagicDetector

Creates a detector for input documents that meet the specified
 magic match.

MagicDetector(MediaType, byte[], byte[], int, int) - Constructor for class org.apache.tika.detect.MagicDetector

Creates a detector for input documents that meet the specified magic
 match.

MagicDetector(MediaType, byte[], int) - Constructor for class org.apache.tika.detect.MagicDetector

Creates a detector for input documents that have the exact given byte
 pattern at the given offset of the document stream.

main(String[]) - Static method in class org.apache.tika.pipes.PipesServer
 
MAJOR_VERSION - Static variable in interface org.apache.tika.metadata.WordPerfect

Major version.

makeName(String, String, String) - Static method in class org.apache.tika.language.detect.LanguageNames
 
MANAGER - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
mapAttributes(Attributes) - Method in class org.apache.tika.sax.ElementMappingContentHandler.TargetElement
 
MAPI - Interface in org.apache.tika.metadata

Properties that typically appear in MSG/PST message format files.

MAPI_FROM_REPRESENTING_EMAIL - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_FROM_REPRESENTING_NAME - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_IMPORTANCE - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_IS_FLAGGED - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_MESSAGE_CLASS - Static variable in interface org.apache.tika.metadata.Office

MAPI message class.

MAPI_MESSAGE_CLIENT_SUBMIT_TIME - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_PRIORTY - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_RECIPIENTS_STRING - Static variable in interface org.apache.tika.metadata.Office
 
MAPI_SENT_BY_SERVER_TYPE - Static variable in interface org.apache.tika.metadata.Office
 
mark(int) - Method in class org.apache.tika.io.BoundedInputStream
 
mark(int) - Method in class org.apache.tika.io.LookaheadInputStream
 
mark(int) - Method in class org.apache.tika.io.TailStream

 This implementation saves the internal state including the
 content of the tail buffer so that it can be restored when ''reset()'' is
 called later.

mark(int) - Method in class org.apache.tika.io.TikaInputStream
 
MARKED - Static variable in interface org.apache.tika.metadata.XMPRights

When true, indicates that this is a rights-managed resource.

markSupported() - Method in class org.apache.tika.io.BoundedInputStream
 
markSupported() - Method in class org.apache.tika.io.LookaheadInputStream
 
markSupported() - Method in class org.apache.tika.io.TikaInputStream
 
MATCH_MASK_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MATCH_MINSHOULDMATCH_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MATCH_OFFSET_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MATCH_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MATCH_TYPE_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MATCH_VALUE_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
Matcher - Class in org.apache.tika.sax.xpath

XPath element matcher.

Matcher() - Constructor for class org.apache.tika.sax.xpath.Matcher
 
matches(byte[]) - Method in class org.apache.tika.mime.MimeType
 
matchesAttribute(String, String) - Method in class org.apache.tika.sax.xpath.AttributeMatcher
 
matchesAttribute(String, String) - Method in class org.apache.tika.sax.xpath.CompositeMatcher
 
matchesAttribute(String, String) - Method in class org.apache.tika.sax.xpath.Matcher

Returns true if the XPath expression matches the named
 attribute of the element associated with this evaluation state.

matchesAttribute(String, String) - Method in class org.apache.tika.sax.xpath.NamedAttributeMatcher
 
matchesAttribute(String, String) - Method in class org.apache.tika.sax.xpath.NodeMatcher
 
matchesAttribute(String, String) - Method in class org.apache.tika.sax.xpath.SubtreeMatcher
 
matchesElement() - Method in class org.apache.tika.sax.xpath.CompositeMatcher
 
matchesElement() - Method in class org.apache.tika.sax.xpath.ElementMatcher
 
matchesElement() - Method in class org.apache.tika.sax.xpath.Matcher

Returns true if the XPath expression matches
 the element associated with this evaluation state.

matchesElement() - Method in class org.apache.tika.sax.xpath.NodeMatcher
 
matchesElement() - Method in class org.apache.tika.sax.xpath.SubtreeMatcher
 
matchesMagic(byte[]) - Method in class org.apache.tika.mime.MimeType
 
matchesText() - Method in class org.apache.tika.sax.xpath.CompositeMatcher
 
matchesText() - Method in class org.apache.tika.sax.xpath.Matcher

Returns true if the XPath expression matches all text
 nodes whose parent is the element associated with this evaluation
 state.

matchesText() - Method in class org.apache.tika.sax.xpath.NodeMatcher
 
matchesText() - Method in class org.apache.tika.sax.xpath.SubtreeMatcher
 
matchesText() - Method in class org.apache.tika.sax.xpath.TextMatcher
 
MatchingContentHandler - Class in org.apache.tika.sax.xpath

Content handler decorator that only passes the elements, attributes,
 and text nodes that match the given XPath expression.

MatchingContentHandler(ContentHandler, Matcher) - Constructor for class org.apache.tika.sax.xpath.MatchingContentHandler
 
MAX_AVAIL_HEIGHT - Static variable in interface org.apache.tika.metadata.IPTC

The maximum available height in pixels of the original photo from which
 this photo has been derived by downsizing.

MAX_AVAIL_WIDTH - Static variable in interface org.apache.tika.metadata.IPTC

The maximum available width in pixels of the original photo from which
 this photo has been derived by downsizing.

MAX_JSON_STRING_FIELD_LENGTH_ELEMENT_NAME - Static variable in class org.apache.tika.config.TikaConfig
 
MediaType - Class in org.apache.tika.mime

Internet media type.

MediaType(String, String) - Constructor for class org.apache.tika.mime.MediaType
 
MediaType(String, String, Map<String, String>) - Constructor for class org.apache.tika.mime.MediaType
 
MediaType(MediaType, String, String) - Constructor for class org.apache.tika.mime.MediaType

Creates a media type by adding a parameter to a base type.

MediaType(MediaType, Charset) - Constructor for class org.apache.tika.mime.MediaType

Creates a media type by adding the "charset" parameter to a base type.

MediaType(MediaType, Map<String, String>) - Constructor for class org.apache.tika.mime.MediaType
 
MediaTypeRegistry - Class in org.apache.tika.mime

Registry of known Internet media types.

MediaTypeRegistry() - Constructor for class org.apache.tika.mime.MediaTypeRegistry
 
MEDIUM - org.apache.tika.language.detect.LanguageConfidence
 
mergeMetadata(Metadata, Metadata, AbstractMultipleParser.MetadataPolicy) - Static method in class org.apache.tika.parser.multiple.AbstractMultipleParser
 
Message - Interface in org.apache.tika.metadata

A collection of Message related property names.

MESSAGE_BCC - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_BCC_DISPLAY_NAME - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_BCC_EMAIL - Static variable in interface org.apache.tika.metadata.Message

Where possible, this records the email value in the bcc field.

MESSAGE_BCC_NAME - Static variable in interface org.apache.tika.metadata.Message

In Outlook messages, there are sometimes separate fields for "bcc-name" and
 "bcc-display-name" name.

MESSAGE_CC - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_CC_DISPLAY_NAME - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_CC_EMAIL - Static variable in interface org.apache.tika.metadata.Message

Where possible, this records the email value in the cc field.

MESSAGE_CC_NAME - Static variable in interface org.apache.tika.metadata.Message

In Outlook messages, there are sometimes separate fields for "cc-name" and
 "cc-display-name" name.

MESSAGE_CLASS - Static variable in interface org.apache.tika.metadata.MAPI

MAPI message class.

MESSAGE_CLASS_RAW - Static variable in interface org.apache.tika.metadata.MAPI

MAPI message class.

MESSAGE_FROM - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_FROM_EMAIL - Static variable in interface org.apache.tika.metadata.Message

Where possible, this records the value from the name field.

MESSAGE_FROM_NAME - Static variable in interface org.apache.tika.metadata.Message

Where possible, this records the value from the name field.

MESSAGE_PREFIX - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_RAW_HEADER_PREFIX - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_RECIPIENT_ADDRESS - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_TO - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_TO_DISPLAY_NAME - Static variable in interface org.apache.tika.metadata.Message
 
MESSAGE_TO_EMAIL - Static variable in interface org.apache.tika.metadata.Message

Where possible, this records the email value in the to field.

MESSAGE_TO_NAME - Static variable in interface org.apache.tika.metadata.Message

In Outlook messages, there are sometimes separate fields for "to-name" and
 "to-display-name" name.

meta_neg(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
meta_trust(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
metadata(Metadata) - Method in class org.apache.tika.sax.XMPContentHandler
 
Metadata - Class in org.apache.tika.metadata

A multi-valued metadata container.

Metadata() - Constructor for class org.apache.tika.metadata.Metadata

Constructs a new, empty metadata.

METADATA - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
METADATA_COMMAND_ARGUMENTS_SERIALIZED_TOKEN - Static variable in class org.apache.tika.embedder.ExternalEmbedder

Token to be replaced with a String array of metadata assignment command
 arguments

METADATA_COMMAND_ARGUMENTS_TOKEN - Static variable in class org.apache.tika.embedder.ExternalEmbedder

Token to be replaced with a String array of metadata assignment command
 arguments

METADATA_DATE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
METADATA_DATE - Static variable in interface org.apache.tika.metadata.XMP

The date and time that any metadata for this resource was last changed.

METADATA_KEY_ATTR - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
METADATA_MATCH_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
METADATA_MOD_DATE - Static variable in interface org.apache.tika.metadata.XMPDM

"The date and time when the metadata was last modified."

METADATA_POLICY_CONFIG_KEY - Static variable in class org.apache.tika.parser.multiple.AbstractMultipleParser
 
METADATA_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
MetadataFilter - Class in org.apache.tika.metadata.filter

Filters the metadata in place after the parse

MetadataFilter() - Constructor for class org.apache.tika.metadata.filter.MetadataFilter
 
metadataList - Variable in class org.apache.tika.sax.RecursiveParserWrapperHandler
 
MetadataListFilter - Class in org.apache.tika.metadata.listfilter
 
MetadataListFilter() - Constructor for class org.apache.tika.metadata.listfilter.MetadataListFilter
 
MetadataWriteFilter - Interface in org.apache.tika.metadata.writefilter
 
MetadataWriteFilterFactory - Interface in org.apache.tika.metadata.writefilter
 
MIDDAY - Static variable in class org.apache.tika.utils.DateUtils

Custom time zone used to interpret date values without a time
 component in a way that most likely falls within the same day
 regardless of in which time zone it is later interpreted.

MIME_INFO_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MIME_TYPE - org.apache.tika.metadata.Property.ValueType
 
MIME_TYPE_MAGIC - Static variable in interface org.apache.tika.metadata.TikaMimeKeys
 
MIME_TYPE_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MIME_TYPE_TYPE_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
MimeType - Class in org.apache.tika.mime

Internet media type.

MIMETYPE_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
MimeTypeException - Exception in org.apache.tika.mime

A class to encapsulate MimeType related exceptions.

MimeTypeException(String) - Constructor for exception org.apache.tika.mime.MimeTypeException

Constructs a MimeTypeException with the specified detail message.

MimeTypeException(String, Throwable) - Constructor for exception org.apache.tika.mime.MimeTypeException

Constructs a MimeTypeException with the specified detail message
 and root cause.

MimeTypes - Class in org.apache.tika.mime

This class is a MimeType repository.

MimeTypes() - Constructor for class org.apache.tika.mime.MimeTypes
 
MIMETYPES_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
MimeTypesFactory - Class in org.apache.tika.mime

Creates instances of MimeTypes.

MimeTypesFactory() - Constructor for class org.apache.tika.mime.MimeTypesFactory
 
MimeTypesReader - Class in org.apache.tika.mime

A reader for XML files compliant with the freedesktop MIME-info DTD.

MimeTypesReader(MimeTypes) - Constructor for class org.apache.tika.mime.MimeTypesReader
 
MimeTypesReaderMetKeys - Interface in org.apache.tika.mime

Met Keys used by the MimeTypesReader.

MINIMAL - org.apache.tika.config.TikaConfigSerializer.Mode

Minimal version of the config, defaults where possible

MINOR_MODEL_AGE_DISCLOSURE - Static variable in interface org.apache.tika.metadata.IPTC

Age of the youngest model pictured in the image, at the time that the
 image was made.

MINOR_VERSION - Static variable in interface org.apache.tika.metadata.WordPerfect

Minor version.

mixedLanguages - Variable in class org.apache.tika.language.detect.LanguageDetector
 
MODEL_AGE - Static variable in interface org.apache.tika.metadata.IPTC

Age of the human model(s) at the time this image was taken in a model
 released image.

MODEL_NAME_ENGLISH - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
MODEL_RELEASE_ID - Static variable in interface org.apache.tika.metadata.IPTC

Optional identifier associated with each Model Release.

MODEL_RELEASE_STATUS - Static variable in interface org.apache.tika.metadata.IPTC

Summarizes the availability and scope of model releases authorizing usage
 of the likenesses of persons appearing in the photograph.

MODIFIED - Static variable in interface org.apache.tika.metadata.DublinCore

Date on which the resource was changed.

MODIFIED - Static variable in interface org.apache.tika.metadata.FileSystem
 
MODIFIED - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
MODIFIED - Static variable in interface org.apache.tika.metadata.XMPDC

Date on which the resource was changed.

modifiedService(ServiceReference, Object) - Method in class org.apache.tika.config.TikaActivator
 
MODIFIER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
MODIFY_DATE - Static variable in interface org.apache.tika.metadata.XMP

The date and time the resource was last modified.

MULTIPART_BOUNDARY - Static variable in interface org.apache.tika.metadata.Message
 
MULTIPART_SUBTYPE - Static variable in interface org.apache.tika.metadata.Message
 
mustNotBeEmpty(String, String) - Static method in class org.apache.tika.config.TikaConfig
 
mustNotBeEmpty(String, Path) - Static method in class org.apache.tika.config.TikaConfig
 




N

N_PAGES - Static variable in interface org.apache.tika.metadata.PagedText

"The number of pages in the document (including any in contained
 documents)."

name() - Method in annotation type org.apache.tika.config.Field
 
NamedAttributeMatcher - Class in org.apache.tika.sax.xpath

Final evaluation state of a ...


NamedAttributeMatcher(String, String) - Constructor for class org.apache.tika.sax.xpath.NamedAttributeMatcher
 
NamedElementMatcher - Class in org.apache.tika.sax.xpath

Intermediate evaluation state of a ...


NamedElementMatcher(String, String, Matcher) - Constructor for class org.apache.tika.sax.xpath.NamedElementMatcher
 
NameDetector - Class in org.apache.tika.detect

Content type detection based on the resource name.

NameDetector(Map<Pattern, MediaType>) - Constructor for class org.apache.tika.detect.NameDetector

Creates a new content type detector based on the given name patterns.

names() - Method in class org.apache.tika.metadata.Metadata

Returns an array of the names contained in the metadata.

NAMESPACE_PREFIX_DELIMITER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

The common delimiter used between the namespace abbreviation and the property name

NAMESPACE_URI - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore
 
NAMESPACE_URI - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
NAMESPACE_URI - Static variable in interface org.apache.tika.metadata.XMP
 
NAMESPACE_URI - Static variable in interface org.apache.tika.metadata.XMPIdq
 
NAMESPACE_URI - Static variable in interface org.apache.tika.metadata.XMPMM
 
NAMESPACE_URI_DC - Static variable in interface org.apache.tika.metadata.DublinCore
 
NAMESPACE_URI_DC_TERMS - Static variable in interface org.apache.tika.metadata.DublinCore
 
NAMESPACE_URI_DOC_META - Static variable in interface org.apache.tika.metadata.Office
 
NAMESPACE_URI_IPTC_CORE - Static variable in interface org.apache.tika.metadata.IPTC
 
NAMESPACE_URI_IPTC_EXT - Static variable in interface org.apache.tika.metadata.IPTC
 
NAMESPACE_URI_PHOTOSHOP - Static variable in interface org.apache.tika.metadata.Photoshop
 
NAMESPACE_URI_PLUS - Static variable in interface org.apache.tika.metadata.IPTC
 
NAMESPACE_URI_XMP_RIGHTS - Static variable in interface org.apache.tika.metadata.XMPRights
 
namespaces - Variable in class org.apache.tika.sax.ToXMLContentHandler
 
NetworkParser - Class in org.apache.tika.parser
 
NetworkParser(URI) - Constructor for class org.apache.tika.parser.NetworkParser
 
NetworkParser(URI, Set<MediaType>) - Constructor for class org.apache.tika.parser.NetworkParser
 
newInstance() - Method in interface org.apache.tika.metadata.writefilter.MetadataWriteFilterFactory
 
newInstance() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
newInstance(Class, ServiceLoader) - Static method in class org.apache.tika.utils.ServiceLoaderUtils

Loads a class and instantiates it.

newInstance(String) - Static method in class org.apache.tika.utils.ServiceLoaderUtils

Loads a class and instantiates it

newInstance(String, ClassLoader) - Static method in class org.apache.tika.utils.ServiceLoaderUtils

Loads a class and instantiates it

newInstance(Metadata, ParseContext) - Method in interface org.apache.tika.extractor.EmbeddedDocumentExtractorFactory
 
newInstance(Metadata, ParseContext) - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractorFactory
 
newInstance(Metadata, ParseContext) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory
 
newline() - Method in class org.apache.tika.sax.XHTMLContentHandler
 
NICKNAME - Static variable in interface org.apache.tika.metadata.XMP

A word or short phrase that represents the nick name fo the file

NNExampleModelDetector - Class in org.apache.tika.detect
 
NNExampleModelDetector() - Constructor for class org.apache.tika.detect.NNExampleModelDetector
 
NNExampleModelDetector(File) - Constructor for class org.apache.tika.detect.NNExampleModelDetector
 
NNExampleModelDetector(Path) - Constructor for class org.apache.tika.detect.NNExampleModelDetector
 
NNTrainedModel - Class in org.apache.tika.detect
 
NNTrainedModel(int, int, int, float[]) - Constructor for class org.apache.tika.detect.NNTrainedModel
 
NNTrainedModelBuilder - Class in org.apache.tika.detect
 
NNTrainedModelBuilder() - Constructor for class org.apache.tika.detect.NNTrainedModelBuilder
 
NO_EMIT - Static variable in class org.apache.tika.pipes.emitter.EmitKey
 
NO_EMITTER_FOUND - org.apache.tika.pipes.PipesResult.STATUS
 
NO_FETCHER_FOUND - org.apache.tika.pipes.PipesResult.STATUS
 
NO_OP_REPORTER - Static variable in class org.apache.tika.pipes.PipesReporter
 
NodeMatcher - Class in org.apache.tika.sax.xpath

Final evaluation state of a ...


NodeMatcher() - Constructor for class org.apache.tika.sax.xpath.NodeMatcher
 
NonDetectingEncodingDetector - Class in org.apache.tika.detect

Always returns the charset passed in via the initializer

NonDetectingEncodingDetector() - Constructor for class org.apache.tika.detect.NonDetectingEncodingDetector

Sets charset to UTF-8.

NonDetectingEncodingDetector(Charset) - Constructor for class org.apache.tika.detect.NonDetectingEncodingDetector
 
NONE - org.apache.tika.language.detect.LanguageConfidence
 
NONE - org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY
 
NOOP_FILTER - Static variable in class org.apache.tika.metadata.filter.NoOpFilter
 
NoOpFilter - Class in org.apache.tika.metadata.filter

This filter performs no operations on the metadata
 and leaves it untouched.

NoOpFilter() - Constructor for class org.apache.tika.metadata.filter.NoOpFilter
 
NoOpListFilter - Class in org.apache.tika.metadata.listfilter
 
NoOpListFilter() - Constructor for class org.apache.tika.metadata.listfilter.NoOpListFilter
 
normalize(String) - Static method in class org.apache.tika.io.FilenameUtils

Scans the given file name for reserved characters on different OSs and
 file systems and returns a sanitized version of the name with the
 reserved chars replaced by their hexadecimal value.

normalize(MediaType) - Method in class org.apache.tika.mime.MediaTypeRegistry
 
normalizeName(String) - Static method in class org.apache.tika.language.detect.LanguageNames
 
NOT_COMPLETED - org.apache.tika.pipes.pipesiterator.TotalCountResult.STATUS
 
NOTES - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
NS_URI_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
NULL - Static variable in class org.apache.tika.language.detect.LanguageResult
 
NULL - Static variable in interface org.apache.tika.parser.external.ExternalParser.LineConsumer

A null consumer

NUM_3D_ANNOTATIONS - Static variable in interface org.apache.tika.metadata.PDF

Number of 3D annotations a PDF contains.

NUM_IMAGES - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This is the number of images (as in a multi-frame gif) returned by
 Java's ImageReader.getNumImages(boolean).

NUMBER_OF_BEATS - Static variable in interface org.apache.tika.metadata.XMPDM

"The number of beats."





O

OBJECT_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Objects in the document.

OCR_PAGE_COUNT - Static variable in interface org.apache.tika.metadata.PDF

This counts the number of pages that would have been OCR'd or were OCR'd depending
 on the OCR settings.

OCTET_STREAM - Static variable in class org.apache.tika.mime.MediaType
 
OCTET_STREAM - Static variable in class org.apache.tika.mime.MimeTypes

Name of the root type, application/octet-stream.

OCX_NAME - Static variable in interface org.apache.tika.metadata.Office
 
offer(List<FetchEmitTuple>, long) - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
offer(FetchEmitTuple, long) - Method in class org.apache.tika.pipes.async.AsyncProcessor
 
OfferLargerThanQueueSize - Exception in org.apache.tika.pipes.async
 
OfferLargerThanQueueSize(int, int) - Constructor for exception org.apache.tika.pipes.async.OfferLargerThanQueueSize
 
Office - Interface in org.apache.tika.metadata

Office Document properties collection.

OfficeOpenXMLCore - Interface in org.apache.tika.metadata

Core properties as defined in the Office Open XML specification part Two that are not
 in the DublinCore namespace.

OfficeOpenXMLExtended - Interface in org.apache.tika.metadata

Extended properties as defined in the Office Open XML specification part Four.

OfflineContentHandler - Class in org.apache.tika.sax

Content handler decorator that always returns an empty stream from the
 OfflineContentHandler.resolveEntity(String, String) method to prevent potential
 network or other external resources from being accessed by an XML parser.

OfflineContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.OfflineContentHandler
 
OOM - org.apache.tika.pipes.PipesResult.STATUS
 
OOM - org.apache.tika.pipes.PipesServer.STATUS
 
OOM - Static variable in class org.apache.tika.pipes.PipesResult
 
OPEN_CHOICE - org.apache.tika.metadata.Property.ValueType
 
org.apache.tika - package org.apache.tika

Apache Tika.

org.apache.tika.concurrent - package org.apache.tika.concurrent
 
org.apache.tika.config - package org.apache.tika.config

Tika configuration tools.

org.apache.tika.detect - package org.apache.tika.detect

Media type detection.

org.apache.tika.embedder - package org.apache.tika.embedder
 
org.apache.tika.exception - package org.apache.tika.exception

Tika exception.

org.apache.tika.extractor - package org.apache.tika.extractor

Extraction of component documents.

org.apache.tika.fork - package org.apache.tika.fork

Forked parser.

org.apache.tika.io - package org.apache.tika.io

IO utilities.

org.apache.tika.language.detect - package org.apache.tika.language.detect
 
org.apache.tika.language.translate - package org.apache.tika.language.translate
 
org.apache.tika.metadata - package org.apache.tika.metadata

Multi-valued metadata container, and set of constant metadata fields.

org.apache.tika.metadata.filter - package org.apache.tika.metadata.filter
 
org.apache.tika.metadata.listfilter - package org.apache.tika.metadata.listfilter
 
org.apache.tika.metadata.writefilter - package org.apache.tika.metadata.writefilter
 
org.apache.tika.mime - package org.apache.tika.mime

Media type information.

org.apache.tika.parser - package org.apache.tika.parser

Tika parsers.

org.apache.tika.parser.digest - package org.apache.tika.parser.digest
 
org.apache.tika.parser.external - package org.apache.tika.parser.external

External parser process.

org.apache.tika.parser.external2 - package org.apache.tika.parser.external2
 
org.apache.tika.parser.multiple - package org.apache.tika.parser.multiple
 
org.apache.tika.pipes - package org.apache.tika.pipes
 
org.apache.tika.pipes.async - package org.apache.tika.pipes.async
 
org.apache.tika.pipes.emitter - package org.apache.tika.pipes.emitter
 
org.apache.tika.pipes.extractor - package org.apache.tika.pipes.extractor
 
org.apache.tika.pipes.fetcher - package org.apache.tika.pipes.fetcher
 
org.apache.tika.pipes.fetcher.config - package org.apache.tika.pipes.fetcher.config
 
org.apache.tika.pipes.fetcher.fs - package org.apache.tika.pipes.fetcher.fs
 
org.apache.tika.pipes.fetcher.fs.config - package org.apache.tika.pipes.fetcher.fs.config
 
org.apache.tika.pipes.fetcher.url - package org.apache.tika.pipes.fetcher.url
 
org.apache.tika.pipes.pipesiterator - package org.apache.tika.pipes.pipesiterator
 
org.apache.tika.pipes.pipesiterator.filelist - package org.apache.tika.pipes.pipesiterator.filelist
 
org.apache.tika.pipes.pipesiterator.fs - package org.apache.tika.pipes.pipesiterator.fs
 
org.apache.tika.renderer - package org.apache.tika.renderer
 
org.apache.tika.sax - package org.apache.tika.sax

SAX utilities.

org.apache.tika.sax.xpath - package org.apache.tika.sax.xpath

XPath utilities

org.apache.tika.utils - package org.apache.tika.utils

Utilities.

ORGANISATION_CODE - Static variable in interface org.apache.tika.metadata.IPTC

A set of metadata about artwork or an object in the item

ORGANISATION_NAME - Static variable in interface org.apache.tika.metadata.IPTC

Name of the organisation or company which is featured in the content.

ORIENTATION - Static variable in interface org.apache.tika.metadata.TIFF

"The Orientation of the image."
 1 = 0th row at top, 0th column at left
 2 = 0th row at top, 0th column at right
 3 = 0th row at bottom, 0th column at right
 4 = 0th row at bottom, 0th column at left
 5 = 0th row at left, 0th column at top
 6 = 0th row at right, 0th column at top
 7 = 0th row at right, 0th column at bottom
 8 = 0th row at left, 0th column at bottom

ORIGINAL_DATE - Static variable in interface org.apache.tika.metadata.TIFF

"Date and time when original image was generated"

ORIGINAL_DOCUMENTID - Static variable in interface org.apache.tika.metadata.XMPMM

The common identifier for the original resource from which
 the current resource is derived.

ORIGINAL_RESOURCE_NAME - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Some file formats can store information about their original
 file name/location or about their attachment's original file name/location
 within the file.

OS_NAME - Static variable in class org.apache.tika.utils.SystemUtils
 
OS_VERSION - Static variable in class org.apache.tika.utils.SystemUtils
 
OUTPUT_FILE_TOKEN - Static variable in class org.apache.tika.parser.external.ExternalParser

The token, which if present in the Command string, will
 be replaced with the output filename.

OUTPUT_FILE_TOKEN - Static variable in class org.apache.tika.parser.external2.ExternalParser
 
OVERALL_PERCENTAGE_UNMAPPED_UNICODE_CHARS - Static variable in interface org.apache.tika.metadata.PDF
 
OverrideDetector - Class in org.apache.tika.detect

Deprecated.
after 2.5.0 this functionality was moved to the CompositeDetector


OverrideDetector() - Constructor for class org.apache.tika.detect.OverrideDetector

Deprecated.
 
OWNER - Static variable in interface org.apache.tika.metadata.XMPRights

A list of legal owners of the resource.





P

PAGE_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Pages are there in the (paged) document

PAGE_NUMBER - Static variable in interface org.apache.tika.metadata.TikaPagedText

1-based page number for a specific page

PAGE_ROTATION - Static variable in interface org.apache.tika.metadata.TikaPagedText
 
PageBasedRenderResults - Class in org.apache.tika.renderer
 
PageBasedRenderResults(TemporaryResources) - Constructor for class org.apache.tika.renderer.PageBasedRenderResults
 
PagedText - Interface in org.apache.tika.metadata

XMP Paged-text schema.

PageRangeRequest - Class in org.apache.tika.renderer

The range of pages to render.

PageRangeRequest(int, int) - Constructor for class org.apache.tika.renderer.PageRangeRequest
 
PARAGRAPH_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of individual Paragraphs in the document

Param<T> - Class in org.apache.tika.config

This is a serializable model class for parameters from configuration file.

Param() - Constructor for class org.apache.tika.config.Param
 
Param(String, Class<T>, T) - Constructor for class org.apache.tika.config.Param
 
Param(String, T) - Constructor for class org.apache.tika.config.Param
 
ParamField - Class in org.apache.tika.config

This class stores metdata for Field annotation are used to map them
 to Param at runtime

ParamField(AccessibleObject) - Constructor for class org.apache.tika.config.ParamField

Creates a ParamField object

ParentContentHandler - Class in org.apache.tika.extractor

Simple pointer class to allow parsers to pass on the parent contenthandler through
 to the embedded document's parse

ParentContentHandler(ContentHandler) - Constructor for class org.apache.tika.extractor.ParentContentHandler
 
parse(File) - Method in class org.apache.tika.Tika

Parses the given file and returns the extracted text content.

parse(File, Metadata) - Method in class org.apache.tika.Tika

Parses the given file and returns the extracted text content.

parse(InputStream) - Method in class org.apache.tika.Tika

Parses the given document and returns the extracted text content.

parse(InputStream, Metadata) - Method in class org.apache.tika.Tika

Parses the given document and returns the extracted text content.

parse(InputStream, ContentHandlerFactory, Metadata, ParseContext) - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser

Deprecated.
The ContentHandlerFactory override is still experimental
 and the method signature is subject to change before Tika 2.0


parse(InputStream, ContentHandler, Metadata) - Method in class org.apache.tika.parser.AbstractParser

Deprecated.
use the Parser.parse(InputStream, ContentHandler,
 Metadata, ParseContext) method instead


parse(InputStream, ContentHandler, Metadata) - Method in class org.apache.tika.parser.AutoDetectParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.fork.ForkParser

This sends the objects to the server for parsing, and the server via
 the proxies acts on the handler as if it were updating it directly.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.AutoDetectParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.CompositeParser

Delegates the call to the matching component parser.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.CryptoParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.DelegatingParser

Looks up the delegate parser from the parsing context and
 delegates the parse operation to it.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.DigestingParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.EmptyParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.ErrorParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.external.ExternalParser

Executes the configured external command and passes the given document
 stream as a simple XHTML document to the given SAX content handler.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.external2.ExternalParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser

Processes the given Stream through one or more parsers,
 resetting things between parsers as requested by policy.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.NetworkParser
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in interface org.apache.tika.parser.Parser

Parses a document stream into a sequence of XHTML SAX events.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.ParserDecorator

Delegates the method call to the decorated parser.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.ParserPostProcessor

Forwards the call to the delegated parser and post-processes the
 results as described above.

parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.RecursiveParserWrapper
 
parse(InputStream, ContentHandler, Metadata, ParseContext) - Method in class org.apache.tika.parser.RegexCaptureParser
 
parse(String) - Static method in class org.apache.tika.mime.MediaType

Parses the given string to a media type.

parse(String) - Static method in enum org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY
 
parse(String) - Method in class org.apache.tika.sax.xpath.XPathParser

Parses the given simple XPath expression to an evaluation state
 initialized at the document node.

parse(URL) - Method in class org.apache.tika.Tika

Parses the resource at the given URL and returns the extracted
 text content.

parse(Path) - Method in class org.apache.tika.Tika

Parses the file at the given path and returns the extracted text content.

parse(Path, Metadata) - Method in class org.apache.tika.Tika

Parses the file at the given path and returns the extracted text content.

parse(MediaType, String, String, String, String) - Static method in class org.apache.tika.detect.MagicDetector
 
parse(FetchEmitTuple) - Method in class org.apache.tika.pipes.PipesParser
 
PARSE_EXCEPTION_EMIT - org.apache.tika.pipes.PipesResult.STATUS
 
PARSE_EXCEPTION_NO_EMIT - org.apache.tika.pipes.PipesResult.STATUS
 
PARSE_EXCEPTION_NO_EMIT - org.apache.tika.pipes.PipesServer.STATUS
 
PARSE_SUCCESS - org.apache.tika.pipes.PipesResult.STATUS
 
PARSE_SUCCESS - org.apache.tika.pipes.PipesServer.STATUS
 
PARSE_SUCCESS_WITH_EXCEPTION - org.apache.tika.pipes.PipesResult.STATUS
 
PARSE_TIME_MILLIS - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
ParseContext - Class in org.apache.tika.parser

Parse context.

ParseContext() - Constructor for class org.apache.tika.parser.ParseContext
 
parseEmbedded(InputStream, ContentHandler, Metadata, boolean) - Method in interface org.apache.tika.extractor.EmbeddedDocumentExtractor

Processes the supplied embedded resource, calling the delegating
  parser with the appropriate details.

parseEmbedded(InputStream, ContentHandler, Metadata, boolean) - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
parseEmbedded(InputStream, ContentHandler, Metadata, boolean) - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
parseEmbedded(InputStream, ContentHandler, Metadata, boolean) - Method in class org.apache.tika.extractor.RUnpackExtractor
 
parseFromTuple(FetchEmitTuple, Fetcher) - Method in class org.apache.tika.pipes.PipesServer
 
parseHandlerType(String, BasicContentHandlerFactory.HANDLER_TYPE) - Static method in class org.apache.tika.sax.BasicContentHandlerFactory

Tries to parse string into handler type.

parseMode(String) - Static method in enum org.apache.tika.pipes.HandlerConfig.PARSE_MODE
 
Parser - Interface in org.apache.tika.parser

Tika parser interface.

PARSER_TAG - Static variable in interface org.apache.tika.parser.external.ExternalParsersConfigReaderMetKeys
 
parserCompleted(Parser, Metadata, ContentHandler, ParseContext, Exception) - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser

Used to notify implementations that a Parser has Finished
 or Failed, and to allow them to decide to continue or
 abort further parsing

parserCompleted(Parser, Metadata, ContentHandler, ParseContext, Exception) - Method in class org.apache.tika.parser.multiple.FallbackParser
 
parserCompleted(Parser, Metadata, ContentHandler, ParseContext, Exception) - Method in class org.apache.tika.parser.multiple.SupplementingParser
 
ParserContainerExtractor - Class in org.apache.tika.extractor

An implementation of ContainerExtractor powered by the regular
 Parser API.

ParserContainerExtractor() - Constructor for class org.apache.tika.extractor.ParserContainerExtractor
 
ParserContainerExtractor(TikaConfig) - Constructor for class org.apache.tika.extractor.ParserContainerExtractor
 
ParserContainerExtractor(Parser, Detector) - Constructor for class org.apache.tika.extractor.ParserContainerExtractor
 
ParserDecorator - Class in org.apache.tika.parser

Decorator base class for the Parser interface.

ParserDecorator(Parser) - Constructor for class org.apache.tika.parser.ParserDecorator

Creates a decorator for the given parser.

ParseRecord - Class in org.apache.tika.parser

Use this class to store exceptions, warnings and other information
 during the parse.

ParseRecord() - Constructor for class org.apache.tika.parser.ParseRecord
 
ParserFactory - Class in org.apache.tika.parser
 
ParserFactory(Map<String, String>) - Constructor for class org.apache.tika.parser.ParserFactory
 
ParserFactoryFactory - Class in org.apache.tika.fork

Lightweight, easily serializable class that contains enough information
 to build a ParserFactory

ParserFactoryFactory(String, Map<String, String>) - Constructor for class org.apache.tika.fork.ParserFactoryFactory
 
ParserPostProcessor - Class in org.apache.tika.parser

Parser decorator that post-processes the results from a decorated parser.

ParserPostProcessor(Parser) - Constructor for class org.apache.tika.parser.ParserPostProcessor

Creates a post-processing decorator for the given parser.

parserPrepare(Parser, Metadata, ParseContext) - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser

Used to allow implementations to prepare or change things
 before parsing occurs

ParserUtils - Class in org.apache.tika.utils

Helper util methods for Parsers themselves.

ParserUtils() - Constructor for class org.apache.tika.utils.ParserUtils
 
parseSAX(InputStream, ContentHandler, ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

This checks context for a user specified SAXParser.

parseSAX(Reader, ContentHandler, ParseContext) - Static method in class org.apache.tika.utils.XMLReaderUtils

This checks context for a user specified SAXParser.

parseToString(File) - Method in class org.apache.tika.Tika

Parses the given file and returns the extracted text content.

parseToString(InputStream) - Method in class org.apache.tika.Tika

Parses the given document and returns the extracted text content.

parseToString(InputStream, Metadata) - Method in class org.apache.tika.Tika

Parses the given document and returns the extracted text content.

parseToString(InputStream, Metadata, int) - Method in class org.apache.tika.Tika

Parses the given document and returns the extracted text content.

parseToString(URL) - Method in class org.apache.tika.Tika

Parses the resource at the given URL and returns the extracted
 text content.

parseToString(Path) - Method in class org.apache.tika.Tika

Parses the file at the given path and returns the extracted text content.

ParsingEmbeddedDocumentExtractor - Class in org.apache.tika.extractor

Helper class for parsers of package archives or other compound document
 formats that support embedded or attached component documents.

ParsingEmbeddedDocumentExtractor(ParseContext) - Constructor for class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
ParsingEmbeddedDocumentExtractorFactory - Class in org.apache.tika.extractor
 
ParsingEmbeddedDocumentExtractorFactory() - Constructor for class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractorFactory
 
ParsingReader - Class in org.apache.tika.parser

Reader for the text content from a given binary stream.

ParsingReader(File) - Constructor for class org.apache.tika.parser.ParsingReader

Creates a reader for the text content of the given file.

ParsingReader(InputStream) - Constructor for class org.apache.tika.parser.ParsingReader

Creates a reader for the text content of the given binary stream.

ParsingReader(InputStream, String) - Constructor for class org.apache.tika.parser.ParsingReader

Creates a reader for the text content of the given binary stream
 with the given name.

ParsingReader(Path) - Constructor for class org.apache.tika.parser.ParsingReader

Creates a reader for the text content of the file at the given path.

ParsingReader(Parser, InputStream, Metadata, ParseContext) - Constructor for class org.apache.tika.parser.ParsingReader

Creates a reader for the text content of the given binary stream
 with the given document metadata.

ParsingReader(Parser, InputStream, Metadata, ParseContext, Executor) - Constructor for class org.apache.tika.parser.ParsingReader

Creates a reader for the text content of the given binary stream
 with the given document metadata.

PasswordProvider - Interface in org.apache.tika.parser

Interface for providing a password to a Parser for handling Encrypted
 and Password Protected Documents.

PATTERN_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
PDF - Interface in org.apache.tika.metadata

PDF properties collection.

PDF_DOC_INFO_CUSTOM_PREFIX - Static variable in interface org.apache.tika.metadata.PDF
 
PDF_DOC_INFO_PREFIX - Static variable in interface org.apache.tika.metadata.PDF

Prefix to be used for properties that record what was stored
 in the docinfo section (as opposed to XMP)

PDF_EXTENSION_VERSION - Static variable in interface org.apache.tika.metadata.PDF
 
PDF_INCREMENTAL_UPDATE_COUNT - Static variable in interface org.apache.tika.metadata.PDF

Incremental updates as extracted by the StartXRefScanner.

PDF_PREFIX - Static variable in interface org.apache.tika.metadata.PDF
 
PDF_VERSION - Static variable in interface org.apache.tika.metadata.PDF
 
PDF_VERSION - Static variable in interface org.apache.tika.metadata.XMPPDF
 
PDFA_PREFIX - Static variable in interface org.apache.tika.metadata.PDF
 
PDFA_VERSION - Static variable in interface org.apache.tika.metadata.PDF
 
PDFAID_CONFORMANCE - Static variable in interface org.apache.tika.metadata.PDF
 
PDFAID_PART - Static variable in interface org.apache.tika.metadata.PDF
 
PDFAID_PREFIX - Static variable in interface org.apache.tika.metadata.PDF
 
PDFUAID_PART - Static variable in interface org.apache.tika.metadata.PDF
 
PDFVT_MODIFIED - Static variable in interface org.apache.tika.metadata.PDF
 
PDFVT_VERSION - Static variable in interface org.apache.tika.metadata.PDF
 
PDFX_CONFORMANCE - Static variable in interface org.apache.tika.metadata.PDF
 
PDFX_VERSION - Static variable in interface org.apache.tika.metadata.PDF
 
PDFXID_VERSION - Static variable in interface org.apache.tika.metadata.PDF
 
peek(byte[]) - Method in class org.apache.tika.io.TikaInputStream

Fills the given buffer with upcoming bytes from this stream without
 advancing the current stream position.

PERSON - Static variable in interface org.apache.tika.metadata.IPTC

Name of a person the content of the item is about.

PhoneExtractingContentHandler - Class in org.apache.tika.sax

Class used to extract phone numbers while parsing.

PhoneExtractingContentHandler() - Constructor for class org.apache.tika.sax.PhoneExtractingContentHandler

Creates a decorator that by default forwards incoming SAX events to
 a dummy content handler that simply ignores all the events.

PhoneExtractingContentHandler(ContentHandler, Metadata) - Constructor for class org.apache.tika.sax.PhoneExtractingContentHandler

Creates a decorator for the given SAX event handler and Metadata object.

Photoshop - Interface in org.apache.tika.metadata

XMP Photoshop metadata schema.

PING - org.apache.tika.pipes.PipesServer.STATUS
 
PIPES_RESULT - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
PipesClient - Class in org.apache.tika.pipes

The PipesClient is designed to be single-threaded.

PipesClient(PipesConfigBase) - Constructor for class org.apache.tika.pipes.PipesClient
 
PipesConfig - Class in org.apache.tika.pipes
 
PipesConfigBase - Class in org.apache.tika.pipes
 
PipesConfigBase() - Constructor for class org.apache.tika.pipes.PipesConfigBase
 
PipesException - Exception in org.apache.tika.pipes

Fatal exception that means that something went seriously wrong.

PipesException(Throwable) - Constructor for exception org.apache.tika.pipes.PipesException
 
PipesIterator - Class in org.apache.tika.pipes.pipesiterator

Abstract class that handles the testing for timeouts/thread safety
 issues.

PipesIterator() - Constructor for class org.apache.tika.pipes.pipesiterator.PipesIterator
 
PipesParser - Class in org.apache.tika.pipes
 
PipesParser(PipesConfig) - Constructor for class org.apache.tika.pipes.PipesParser
 
PipesReporter - Class in org.apache.tika.pipes

This is called asynchronously by the AsyncProcessor.

PipesReporter() - Constructor for class org.apache.tika.pipes.PipesReporter
 
PipesReporterBase - Class in org.apache.tika.pipes

Base class that includes filtering by PipesResult.STATUS

PipesReporterBase() - Constructor for class org.apache.tika.pipes.PipesReporterBase
 
PipesResult - Class in org.apache.tika.pipes
 
PipesResult(EmitData) - Constructor for class org.apache.tika.pipes.PipesResult

This assumes parse success with no parse exception

PipesResult(EmitData, String) - Constructor for class org.apache.tika.pipes.PipesResult

This assumes that the message is a stack trace (container
 parse exception).

PipesResult(PipesResult.STATUS) - Constructor for class org.apache.tika.pipes.PipesResult
 
PipesResult(PipesResult.STATUS, String) - Constructor for class org.apache.tika.pipes.PipesResult
 
PipesResult(PipesResult.STATUS, EmitData, boolean) - Constructor for class org.apache.tika.pipes.PipesResult
 
PipesResult.STATUS - Enum in org.apache.tika.pipes
 
PipesServer - Class in org.apache.tika.pipes

This server is forked from the PipesClient.

PipesServer(Path, InputStream, PrintStream, long, long, long) - Constructor for class org.apache.tika.pipes.PipesServer
 
PipesServer.STATUS - Enum in org.apache.tika.pipes
 
PLAIN_TEXT - Static variable in class org.apache.tika.mime.MimeTypes

Name of the text type, text/plain.

PLATFORM - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_AIX - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_ARM - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_EMBEDDED - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_FREEBSD - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_HPUX - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_IRIX - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_LINUX - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_NETBSD - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_SOLARIS - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_SYSV - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_TRU64 - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLATFORM_WINDOWS - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PLUS_VERSION - Static variable in interface org.apache.tika.metadata.IPTC

The version number of the PLUS standards in place at the time of the
 transaction.

predict(double[]) - Method in class org.apache.tika.detect.NNTrainedModel
 
predict(double[]) - Method in class org.apache.tika.detect.TrainedModel
 
predict(float[]) - Method in class org.apache.tika.detect.NNTrainedModel

The given input vector of unseen is m=(256 + 1) * n= 1 this returns a
 prediction probability

predict(float[]) - Method in class org.apache.tika.detect.TrainedModel
 
PREFIX - Static variable in interface org.apache.tika.metadata.AccessPermissions
 
PREFIX - Static variable in interface org.apache.tika.metadata.Database
 
PREFIX - Static variable in interface org.apache.tika.metadata.FileSystem
 
PREFIX - Static variable in interface org.apache.tika.metadata.MachineMetadata
 
PREFIX - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore
 
PREFIX - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
PREFIX - Static variable in interface org.apache.tika.metadata.WARC
 
PREFIX - Static variable in interface org.apache.tika.metadata.XMP
 
PREFIX - Static variable in interface org.apache.tika.metadata.XMPIdq
 
PREFIX - Static variable in interface org.apache.tika.metadata.XMPMM
 
PREFIX - Static variable in interface org.apache.tika.metadata.XMPPDF
 
PREFIX_ - Static variable in interface org.apache.tika.metadata.XMP

The xmp prefix followed by the colon delimiter

PREFIX_ - Static variable in interface org.apache.tika.metadata.XMPIdq

The xmpidq prefix followed by the colon delimiter

PREFIX_ - Static variable in interface org.apache.tika.metadata.XMPMM

The xmpMM prefix followed by the colon delimiter

PREFIX_ - Static variable in interface org.apache.tika.metadata.XMPRights

The xmpRights prefix followed by the colon delimiter

PREFIX_DC - Static variable in interface org.apache.tika.metadata.DublinCore
 
PREFIX_DC - Static variable in interface org.apache.tika.metadata.XMPDC
 
PREFIX_DC_TERMS - Static variable in interface org.apache.tika.metadata.DublinCore
 
PREFIX_DC_TERMS - Static variable in interface org.apache.tika.metadata.XMPDC
 
PREFIX_DOC_META - Static variable in interface org.apache.tika.metadata.Office
 
PREFIX_EXTERNAL_META - Static variable in interface org.apache.tika.metadata.ExternalProcess
 
PREFIX_FONT_META - Static variable in interface org.apache.tika.metadata.Font
 
PREFIX_HTML_META - Static variable in interface org.apache.tika.metadata.HTML
 
PREFIX_IPTC_CORE - Static variable in interface org.apache.tika.metadata.IPTC
 
PREFIX_IPTC_EXT - Static variable in interface org.apache.tika.metadata.IPTC
 
PREFIX_MAPI_ATTACH_META - Static variable in interface org.apache.tika.metadata.MAPI
 
PREFIX_MAPI_META - Static variable in interface org.apache.tika.metadata.MAPI
 
PREFIX_MAPI_PROPERTY - Static variable in interface org.apache.tika.metadata.MAPI
 
PREFIX_PHOTOSHOP - Static variable in interface org.apache.tika.metadata.Photoshop
 
PREFIX_PLUS - Static variable in interface org.apache.tika.metadata.IPTC
 
PREFIX_RTF_META - Static variable in interface org.apache.tika.metadata.RTFMetadata
 
PREFIX_XMP_RIGHTS - Static variable in interface org.apache.tika.metadata.XMPRights
 
PRESENTATION_FORMAT - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
PRINT_DATE - Static variable in interface org.apache.tika.metadata.Office

When was the document last printed?

PRINT_DATE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
priorExtensionFileType(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
priority - Variable in class org.apache.tika.mime.MimeTypesReader
 
priorMagicFileType(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
priorMetaFileType(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
PRIORTY - Static variable in interface org.apache.tika.metadata.MAPI
 
ProbabilisticMimeDetectionSelector - Class in org.apache.tika.mime

Selector for combining different mime detection results
 based on probability

ProbabilisticMimeDetectionSelector() - Constructor for class org.apache.tika.mime.ProbabilisticMimeDetectionSelector
 
ProbabilisticMimeDetectionSelector(MimeTypes) - Constructor for class org.apache.tika.mime.ProbabilisticMimeDetectionSelector
 
ProbabilisticMimeDetectionSelector(MimeTypes, ProbabilisticMimeDetectionSelector.Builder) - Constructor for class org.apache.tika.mime.ProbabilisticMimeDetectionSelector
 
ProbabilisticMimeDetectionSelector(ProbabilisticMimeDetectionSelector.Builder) - Constructor for class org.apache.tika.mime.ProbabilisticMimeDetectionSelector
 
ProbabilisticMimeDetectionSelector.Builder - Class in org.apache.tika.mime

build class for probability parameters setting

process(DataInputStream, DataOutputStream) - Method in interface org.apache.tika.fork.ForkResource
 
process(FetchEmitTuple) - Method in class org.apache.tika.pipes.PipesClient
 
processingInstruction(String, String) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
processingInstruction(String, String) - Method in class org.apache.tika.sax.TeeContentHandler
 
processingInstruction(String, String) - Method in class org.apache.tika.sax.xpath.MatchingContentHandler
 
processRequests() - Method in class org.apache.tika.pipes.PipesServer
 
ProcessUtils - Class in org.apache.tika.utils
 
ProcessUtils() - Constructor for class org.apache.tika.utils.ProcessUtils
 
PRODUCER - Static variable in interface org.apache.tika.metadata.PDF
 
PRODUCER - Static variable in interface org.apache.tika.metadata.XMPPDF
 
PRODUCT_TYPE - Static variable in interface org.apache.tika.metadata.WordPerfect

Product type.

PROG_ID - Static variable in interface org.apache.tika.metadata.Office

Embedded files may have a "progID" associated with them, such as
 Word.Document.12 or AcroExch.Document.DC

PROGRAM_ID - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
PROJECT_ID - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
PROPER_NAME - org.apache.tika.metadata.Property.ValueType
 
property(String, String) - Method in class org.apache.tika.sax.XMPContentHandler
 
Property - Class in org.apache.tika.metadata

XMP property definition.

PROPERTY - org.apache.tika.metadata.Property.ValueType
 
PROPERTY_GROUP_IPTC_CORE - Static variable in interface org.apache.tika.metadata.IPTC
 
PROPERTY_GROUP_IPTC_EXT - Static variable in interface org.apache.tika.metadata.IPTC
 
PROPERTY_RELEASE_ID - Static variable in interface org.apache.tika.metadata.IPTC

Optional identifier associated with each Property Release.

PROPERTY_RELEASE_STATUS - Static variable in interface org.apache.tika.metadata.IPTC

Summarises the availability and scope of property releases authorizing
 usage of the properties appearing in the photograph.

Property.PropertyType - Enum in org.apache.tika.metadata
 
Property.ValueType - Enum in org.apache.tika.metadata
 
PropertyTypeException - Exception in org.apache.tika.metadata

XMP property definition violation exception.

PropertyTypeException(String) - Constructor for exception org.apache.tika.metadata.PropertyTypeException
 
PropertyTypeException(Property.PropertyType) - Constructor for exception org.apache.tika.metadata.PropertyTypeException
 
PropertyTypeException(Property.PropertyType, Property.PropertyType) - Constructor for exception org.apache.tika.metadata.PropertyTypeException
 
PropertyTypeException(Property.ValueType, Property.ValueType) - Constructor for exception org.apache.tika.metadata.PropertyTypeException
 
PROTECTED - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
PROTECTED_WORKSHEET - Static variable in interface org.apache.tika.metadata.Office
 
PROVINCE_OR_STATE - Static variable in interface org.apache.tika.metadata.IPTC

Name of the subregion of a country -- either called province or state or
 anything else -- the content is focussing on -- either the subregion
 shown in visual media or referenced by text or audio media.

PST - Interface in org.apache.tika.metadata
 
PST_FOLDER_PATH - Static variable in interface org.apache.tika.metadata.PST
 
PST_PREFIX - Static variable in interface org.apache.tika.metadata.PST
 
PUBLISHER - Static variable in interface org.apache.tika.metadata.DublinCore

An entity responsible for making the resource available.

PUBLISHER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
PUBLISHER - Static variable in interface org.apache.tika.metadata.XMPDC

An entity responsible for making the resource available.

PULL_DOWN - Static variable in interface org.apache.tika.metadata.XMPDM

"The sampling phase of film to be converted to video (pull-down)."





Q

QuattroPro - Interface in org.apache.tika.metadata

QuattroPro properties collection.

QUATTROPRO_METADATA_NAME_PREFIX - Static variable in interface org.apache.tika.metadata.QuattroPro
 




R

RangeFetcher - Interface in org.apache.tika.pipes.fetcher

This class extracts a range of bytes from a given fetch key.

RATING - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
RATING - Static variable in interface org.apache.tika.metadata.XMP

A user-assigned rating for this file.

RATIONAL - org.apache.tika.metadata.Property.ValueType
 
RDF - Static variable in class org.apache.tika.sax.XMPContentHandler

The RDF namespace URI

read() - Method in class org.apache.tika.io.BoundedInputStream
 
read() - Method in class org.apache.tika.io.LookaheadInputStream
 
read() - Method in class org.apache.tika.io.TailStream

 This implementation adds the read byte to the internal tail
 buffer.

read() - Method in class org.apache.tika.utils.RereadableInputStream

Reads a byte from the stream, saving it in the store if it is being
 read from the original stream.

read(byte[]) - Method in class org.apache.tika.io.BoundedInputStream

Invokes the delegate's read(byte[]) method.

read(byte[]) - Method in class org.apache.tika.io.TailStream

 This implementation delegates to the underlying stream and
 then adds the correct portion of the read buffer to the internal tail
 buffer.

read(byte[], int, int) - Method in class org.apache.tika.io.BoundedInputStream

Invokes the delegate's read(byte[], int, int) method.

read(byte[], int, int) - Method in class org.apache.tika.io.LookaheadInputStream
 
read(byte[], int, int) - Method in class org.apache.tika.io.TailStream

 This implementation delegates to the underlying stream and
 then adds the correct portion of the read buffer to the internal tail
 buffer.

read(char[], int, int) - Method in class org.apache.tika.parser.ParsingReader

Reads parsed text from the pipe connected to the parsing thread.

read(InputStream) - Method in class org.apache.tika.mime.MimeTypesReader
 
read(InputStream) - Static method in class org.apache.tika.parser.external.ExternalParsersConfigReader
 
read(Document) - Method in class org.apache.tika.mime.MimeTypesReader
 
read(Document) - Static method in class org.apache.tika.parser.external.ExternalParsersConfigReader
 
read(Element) - Static method in class org.apache.tika.parser.external.ExternalParsersConfigReader
 
readByteFrequencies(InputStream) - Method in class org.apache.tika.detect.TrainedModelDetector

Read the inputstream and build a byte frequency histogram

readIntBE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a BE int value from an InputStream

readIntLE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a LE int value from an InputStream

readIntME(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a PDP-11 style Middle Endian int value from an InputStream

readLongBE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a NE long value from an InputStream

readLongLE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a LE long value from an InputStream

readNBytes(byte[], int, int) - Method in class org.apache.tika.io.BoundedInputStream
 
readNBytes(int) - Method in class org.apache.tika.io.BoundedInputStream
 
readShortBE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a BE short value from an InputStream

readShortLE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a LE short value from an InputStream

readUE7(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Gets the integer value that is stored in UTF-8 like fashion, in Big Endian
 but with the high bit on each number indicating if it continues or not

readUIntBE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a BE unsigned int value from an InputStream

readUIntLE(InputStream) - Static method in class org.apache.tika.io.EndianUtils

Get a LE unsigned int value from an InputStream

readUShortBE(InputStream) - Static method in class org.apache.tika.io.EndianUtils
 
readUShortLE(InputStream) - Static method in class org.apache.tika.io.EndianUtils
 
READY - org.apache.tika.pipes.PipesServer.STATUS
 
REAL - org.apache.tika.metadata.Property.ValueType
 
REALIZATION - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
reallyEndDocument() - Method in class org.apache.tika.sax.EndDocumentShieldingContentHandler
 
RECIPIENTS_STRING - Static variable in interface org.apache.tika.metadata.MAPI
 
recordEmbeddedStreamException(Throwable, Metadata) - Static method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
recordException(Throwable, Metadata) - Static method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
recordParserDetails(String, Metadata) - Static method in class org.apache.tika.utils.ParserUtils

Records details of the Parser used to the Metadata,
 typically wanted where multiple parsers could be picked between
 or used.

recordParserDetails(Parser, Metadata) - Static method in class org.apache.tika.utils.ParserUtils

Records details of the Parser used to the Metadata,
 typically wanted where multiple parsers could be picked between
 or used.

recordParserFailure(Parser, Throwable, Metadata) - Static method in class org.apache.tika.utils.ParserUtils

Records details of a Parser's failure to the
 Metadata, so you can check what went wrong even if the
 Exception wasn't immediately thrown (eg when several different
 Parsers are used)

RecursiveParserWrapper - Class in org.apache.tika.parser

This is a helper class that wraps a parser in a recursive handler.

RecursiveParserWrapper(Parser) - Constructor for class org.apache.tika.parser.RecursiveParserWrapper

Initialize the wrapper with RecursiveParserWrapper.catchEmbeddedExceptions set
 to true as default.

RecursiveParserWrapper(Parser, boolean) - Constructor for class org.apache.tika.parser.RecursiveParserWrapper
 
RecursiveParserWrapperHandler - Class in org.apache.tika.sax

This is the default implementation of AbstractRecursiveParserWrapperHandler.

RecursiveParserWrapperHandler(ContentHandlerFactory) - Constructor for class org.apache.tika.sax.RecursiveParserWrapperHandler

Create a handler with no limit on the number of embedded resources

RecursiveParserWrapperHandler(ContentHandlerFactory, int) - Constructor for class org.apache.tika.sax.RecursiveParserWrapperHandler

Create a handler that limits the number of embedded resources that will be
 parsed

RecursiveParserWrapperHandler(ContentHandlerFactory, int, MetadataFilter) - Constructor for class org.apache.tika.sax.RecursiveParserWrapperHandler
 
REFERENCES - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
RegexCaptureParser - Class in org.apache.tika.parser
 
RegexCaptureParser() - Constructor for class org.apache.tika.parser.RegexCaptureParser
 
RegexUtils - Class in org.apache.tika.utils

Inspired from Nutch code class OutlinkExtractor.

RegexUtils() - Constructor for class org.apache.tika.utils.RegexUtils
 
register(Process) - Method in class org.apache.tika.parser.AbstractExternalProcessParser
 
registerModels(MediaType, TrainedModel) - Method in class org.apache.tika.detect.TrainedModelDetector
 
REGISTRY_ENTRY_CREATED_ITEM_ID - Static variable in interface org.apache.tika.metadata.IPTC

A unique identifier created by a registry and applied by the creator of
 the item.

REGISTRY_ENTRY_CREATED_ORGANISATION_ID - Static variable in interface org.apache.tika.metadata.IPTC

An identifier for the registry which issued the corresponding Registry Image Id.

RELATION - Static variable in interface org.apache.tika.metadata.DublinCore

A reference to a related resource.

RELATION - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
RELATION - Static variable in interface org.apache.tika.metadata.XMPDC

A reference to a related resource.

RELATIVE_PEAK_AUDIO_FILE_PATH - Static variable in interface org.apache.tika.metadata.XMPDM

"The relative path to the file's peak audio file.

release(String) - Method in class org.apache.tika.parser.AbstractExternalProcessParser
 
RELEASE_DATE - Static variable in interface org.apache.tika.metadata.XMPDM

"The date the title was released."

remove(String) - Method in class org.apache.tika.metadata.Metadata

Remove a metadata and all its associated values.

removedService(ServiceReference, Object) - Method in class org.apache.tika.config.TikaActivator
 
render(InputStream, Metadata, ParseContext, RenderRequest...) - Method in class org.apache.tika.renderer.CompositeRenderer
 
render(InputStream, Metadata, ParseContext, RenderRequest...) - Method in interface org.apache.tika.renderer.Renderer
 
RENDER_ALL - Static variable in class org.apache.tika.renderer.PageRangeRequest
 
RENDERED_BY - Static variable in interface org.apache.tika.metadata.Rendering
 
RENDERED_MS - Static variable in interface org.apache.tika.metadata.Rendering
 
Renderer - Interface in org.apache.tika.renderer

Interface for a renderer.

Rendering - Interface in org.apache.tika.metadata
 
RENDERING - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
RENDERING_PREFIX - Static variable in interface org.apache.tika.metadata.Rendering
 
RenderingParser - Interface in org.apache.tika.parser
 
RenderingState - Class in org.apache.tika.renderer

This should be to track state for each file (embedded or otherwise).

RenderingState() - Constructor for class org.apache.tika.renderer.RenderingState
 
RenderingTracker - Class in org.apache.tika.renderer

Use this in the ParseContext to keep track of unique ids for rendered
 images in embedded docs.

RenderingTracker() - Constructor for class org.apache.tika.renderer.RenderingTracker
 
RenderRequest - Interface in org.apache.tika.renderer

Empty interface for requests to a renderer.

RenderResult - Class in org.apache.tika.renderer
 
RenderResult(RenderResult.STATUS, int, Object, Metadata) - Constructor for class org.apache.tika.renderer.RenderResult
 
RenderResult.STATUS - Enum in org.apache.tika.renderer
 
RenderResults - Class in org.apache.tika.renderer
 
RenderResults(TemporaryResources) - Constructor for class org.apache.tika.renderer.RenderResults
 
RENDITION_CLASS - Static variable in interface org.apache.tika.metadata.XMPMM

The rendition class name for this resource.

RENDITION_LAYOUT - Static variable in interface org.apache.tika.metadata.Epub

This is set to "pre-paginated" if any itemref on the spine or the
 metadata has a "pre-paginated" value, "reflowable" otherwise.

RENDITION_PARAMS - Static variable in interface org.apache.tika.metadata.XMPMM

Can be used to provide additional rendition parameters that
 are too complex or verbose to encode in xmpMM:RenditionClass

repeat(char, int) - Static method in class org.apache.tika.utils.StringUtils

Returns padding using the specified delimiter repeated
 to a given length.

repeat(String, int) - Static method in class org.apache.tika.utils.StringUtils

Repeat a String repeat times to form a
 new String.

report(FetchEmitTuple, PipesResult, long) - Method in class org.apache.tika.pipes.CompositePipesReporter
 
report(FetchEmitTuple, PipesResult, long) - Method in class org.apache.tika.pipes.LoggingPipesReporter
 
report(FetchEmitTuple, PipesResult, long) - Method in class org.apache.tika.pipes.PipesReporter
 
report(TotalCountResult) - Method in class org.apache.tika.pipes.CompositePipesReporter
 
report(TotalCountResult) - Method in class org.apache.tika.pipes.PipesReporter

No-op implementation.

required() - Method in annotation type org.apache.tika.config.Field
 
RereadableInputStream - Class in org.apache.tika.utils

Wraps an input stream, reading it only once, but making it available
 for rereading an arbitrary number of times.

RereadableInputStream(InputStream) - Constructor for class org.apache.tika.utils.RereadableInputStream

Creates a rereadable input stream  with defaults of 512*1024*1024 bytes (500M) for
 maxBytesInMemory and both readToEndOfStreamOnFirstRewind and closeOriginalStreamOnClose
 set to true

RereadableInputStream(InputStream, boolean) - Constructor for class org.apache.tika.utils.RereadableInputStream

Creates a rereadable input stream defaulting to 512*1024*1024 bytes (500M) for
 maxBytesInMemory

RereadableInputStream(InputStream, int) - Constructor for class org.apache.tika.utils.RereadableInputStream

Creates a rereadable input stream  with closeOriginalStreamOnClose set to true

RereadableInputStream(InputStream, int, boolean) - Constructor for class org.apache.tika.utils.RereadableInputStream

Creates a rereadable input stream.

RESERVED_FILENAME_CHARACTERS - Static variable in class org.apache.tika.io.FilenameUtils

Reserved characters

reset() - Method in class org.apache.tika.io.BoundedInputStream
 
reset() - Method in class org.apache.tika.io.LookaheadInputStream
 
reset() - Method in class org.apache.tika.io.TailStream

 This implementation restores this stream's state to the
 state when ''mark()'' was called the last time.

reset() - Method in class org.apache.tika.io.TikaInputStream
 
reset() - Method in class org.apache.tika.language.detect.LanguageDetector

Reset statistics about the current document being processed

reset() - Method in class org.apache.tika.language.detect.LanguageWriter
 
RESOLUTION_HORIZONTAL - Static variable in interface org.apache.tika.metadata.TIFF

"Horizontal resolution in pixels per unit."

RESOLUTION_UNIT - Static variable in interface org.apache.tika.metadata.TIFF

"Units used for Horizontal and Vertical Resolutions."

RESOLUTION_VERTICAL - Static variable in interface org.apache.tika.metadata.TIFF

"Vertical resolution in pixels per unit."

resolveEntity(String, String) - Method in class org.apache.tika.mime.MimeTypesReader
 
resolveEntity(String, String) - Method in class org.apache.tika.sax.OfflineContentHandler

Returns an empty stream.

RESOURCE_NAME_KEY - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
REVISION - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

The revision number.

rewind() - Method in class org.apache.tika.utils.RereadableInputStream

"Rewinds" the stream to the beginning for rereading.

RichTextContentHandler - Class in org.apache.tika.sax

Content handler for Rich Text, it will extract XHTML <img/>
 tag <alt/> attribute and XHTML <a/> tag <name/>
 attribute into the output.

RichTextContentHandler(Writer) - Constructor for class org.apache.tika.sax.RichTextContentHandler

Creates a content handler that writes XHTML body character events to
 the given writer.

RIGHTS - Static variable in interface org.apache.tika.metadata.DublinCore

Information about rights held in and over the resource.

RIGHTS - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
RIGHTS - Static variable in interface org.apache.tika.metadata.XMPDC

Information about rights held in and over the resource.

RIGHTS_USAGE_TERMS - Static variable in interface org.apache.tika.metadata.IPTC

The licensing parameters of the item expressed in free-text.

RMETA - org.apache.tika.pipes.HandlerConfig.PARSE_MODE
 
ROOT_XML_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
ROW_COUNT - Static variable in interface org.apache.tika.metadata.Database
 
RTF_PICT_META_PREFIX - Static variable in interface org.apache.tika.metadata.RTFMetadata
 
RTFMetadata - Interface in org.apache.tika.metadata
 
run() - Method in class org.apache.tika.pipes.PipesServer
 
run() - Method in class org.apache.tika.utils.StreamGobbler
 
RUnpackExtractor - Class in org.apache.tika.extractor

Recursive Unpacker and text and metadata extractor.

RUnpackExtractor(ParseContext, long) - Constructor for class org.apache.tika.extractor.RUnpackExtractor
 
RUnpackExtractorFactory - Class in org.apache.tika.extractor
 
RUnpackExtractorFactory() - Constructor for class org.apache.tika.extractor.RUnpackExtractorFactory
 
RuntimeSAXException - Exception in org.apache.tika.exception

Use this to throw a SAXException in subclassed methods that don't throw SAXExceptions

RuntimeSAXException(SAXException) - Constructor for exception org.apache.tika.exception.RuntimeSAXException
 




S

SafeContentHandler - Class in org.apache.tika.sax

Content handler decorator that makes sure that the character events
 (SafeContentHandler.characters(char[], int, int) or
 SafeContentHandler.ignorableWhitespace(char[], int, int)) passed to the decorated
 content handler contain only valid XML characters.

SafeContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.SafeContentHandler
 
SafeContentHandler.Output - Interface in org.apache.tika.sax

Internal interface that allows both character and
 ignorable whitespace content to be filtered the same way.

SAMPLES_PER_PIXEL - Static variable in interface org.apache.tika.metadata.TIFF

"Number of components per pixel."

save(OutputStream) - Method in class org.apache.tika.config.Param
 
save(Document, Node) - Method in class org.apache.tika.config.Param
 
SAVE_DATE - Static variable in interface org.apache.tika.metadata.Office

When was the document last saved?

SCALE_TYPE - Static variable in interface org.apache.tika.metadata.XMPDM

"The musical scale used in the music.

SCENE - Static variable in interface org.apache.tika.metadata.XMPDM

"The name of the scene."

SCENE_CODE - Static variable in interface org.apache.tika.metadata.IPTC

Describes the scene of a news content.

SCHEME - Static variable in interface org.apache.tika.metadata.XMPIdq

A qualifier providing the name of the formal identification
 scheme used for an item in the xmp:Identifier array.

SCRIPT_SOURCE - Static variable in interface org.apache.tika.metadata.HTML

If a script element contains a src value, this value
 is set in the embedded document's metadata

SecureContentHandler - Class in org.apache.tika.sax

Content handler decorator that attempts to prevent denial of service
 attacks against Tika parsers.

SecureContentHandler(ContentHandler, TikaInputStream) - Constructor for class org.apache.tika.sax.SecureContentHandler

Decorates the given content handler with zip bomb prevention based
 on the count of bytes read from the given counting input stream.

SECURITY_LOCKED_FOR_ANNOTATIONS - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
SECURITY_NONE - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
SECURITY_PASSWORD_PROTECTED - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
SECURITY_READ_ONLY_ENFORCED - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
SECURITY_READ_ONLY_RECOMMENDED - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
SECURITY_UNKNOWN - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
select(Metadata) - Method in class org.apache.tika.extractor.BasicEmbeddedBytesSelector
 
select(Metadata) - Method in interface org.apache.tika.extractor.DocumentSelector

Checks if a document with the given metadata matches the specified
 selection criteria.

select(Metadata) - Method in class org.apache.tika.extractor.EmbeddedBytesSelector.AcceptAll
 
select(Metadata) - Method in interface org.apache.tika.extractor.EmbeddedBytesSelector
 
SENT_BY_SERVER_TYPE - Static variable in interface org.apache.tika.metadata.MAPI
 
SEQ - org.apache.tika.metadata.Property.PropertyType

An ordered array

serialize(TikaConfig, TikaConfigSerializer.Mode, Writer, Charset) - Static method in class org.apache.tika.config.TikaConfigSerializer
 
serializeMetadata(List<String>) - Static method in class org.apache.tika.embedder.ExternalEmbedder

Serializes a collection of metadata command line arguments into a single
 string.

serializeParams(Document, Element, Object) - Static method in class org.apache.tika.config.TikaConfigSerializer
 
ServiceLoader - Class in org.apache.tika.config

Internal utility class that Tika uses to look up service providers.

ServiceLoader() - Constructor for class org.apache.tika.config.ServiceLoader
 
ServiceLoader(ClassLoader) - Constructor for class org.apache.tika.config.ServiceLoader
 
ServiceLoader(ClassLoader, LoadErrorHandler) - Constructor for class org.apache.tika.config.ServiceLoader
 
ServiceLoader(ClassLoader, LoadErrorHandler, boolean) - Constructor for class org.apache.tika.config.ServiceLoader
 
ServiceLoader(ClassLoader, LoadErrorHandler, InitializableProblemHandler, boolean) - Constructor for class org.apache.tika.config.ServiceLoader
 
ServiceLoaderUtils - Class in org.apache.tika.utils

Service Loading and Ordering related utils

ServiceLoaderUtils() - Constructor for class org.apache.tika.utils.ServiceLoaderUtils
 
set(Class<T>, T) - Method in class org.apache.tika.parser.ParseContext

Adds the given value to the context as an implementation of the given
 interface.

set(String...) - Static method in class org.apache.tika.mime.MediaType

Convenience method that parses the given media type strings and
 returns an unmodifiable set that contains all the parsed types.

set(String, String) - Method in class org.apache.tika.metadata.Metadata

Set metadata name/value.

set(String, String[]) - Method in class org.apache.tika.metadata.Metadata
 
set(String, String, Map<String, String[]>) - Method in interface org.apache.tika.metadata.writefilter.MetadataWriteFilter

Based on the field and the value, this filter modifies
 the field and/or the value to something that should be set in the
 Metadata object.

set(String, String, Map<String, String[]>) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilter
 
set(Property, boolean) - Method in class org.apache.tika.metadata.Metadata

Sets the integer value of the identified metadata property.

set(Property, double) - Method in class org.apache.tika.metadata.Metadata

Sets the real or rational value of the identified metadata property.

set(Property, int) - Method in class org.apache.tika.metadata.Metadata

Sets the integer value of the identified metadata property.

set(Property, long) - Method in class org.apache.tika.metadata.Metadata

Sets the integer value of the identified metadata property.

set(Property, String) - Method in class org.apache.tika.metadata.Metadata

Sets the value of the identified metadata property.

set(Property, String[]) - Method in class org.apache.tika.metadata.Metadata

Sets the values of the identified metadata property.

set(Property, Calendar) - Method in class org.apache.tika.metadata.Metadata

Sets the date value of the identified metadata property.

set(Property, Date) - Method in class org.apache.tika.metadata.Metadata

Sets the date value of the identified metadata property.

set(MediaType...) - Static method in class org.apache.tika.mime.MediaType

Convenience method that returns an unmodifiable set that contains
 all the given media types.

setAll(Properties) - Method in class org.apache.tika.metadata.Metadata

Copy All key-value pairs from properties.

setAutoDetectParserConfig(AutoDetectParserConfig) - Method in class org.apache.tika.parser.AutoDetectParser

Sets the configuration that will be used to create SecureContentHandlers
 that will be used for parsing.

setBasePath(String) - Method in class org.apache.tika.pipes.fetcher.fs.config.FileSystemFetcherConfig
 
setBasePath(String) - Method in class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher

Default behavior si that clients will send in relative paths, this
 must be set to allow this fetcher to fetch the
 full path.

setBasePath(String) - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
setCaptureMap(Map<String, String>) - Method in class org.apache.tika.parser.RegexCaptureParser
 
setCommand(String...) - Method in class org.apache.tika.embedder.ExternalEmbedder

Sets the command to be run.

setCommand(String...) - Method in class org.apache.tika.parser.external.ExternalParser

Sets the command to be run.

setCommandAppendOperator(String) - Method in class org.apache.tika.embedder.ExternalEmbedder

Sets the operator to append rather than replace a value for the command
 line tool, i.e. "+=".

setCommandAssignmentDelimeter(String) - Method in class org.apache.tika.embedder.ExternalEmbedder

Sets the delimiter for multiple assignments for the command line tool,
 i.e. ", ".

setCommandAssignmentOperator(String) - Method in class org.apache.tika.embedder.ExternalEmbedder

Sets the assignment operator for the command line tool, i.e. "=".

setCommandLine(List<String>) - Method in class org.apache.tika.parser.external2.ExternalParser

Use this to specify the full commandLine.

setConfigClassName(String) - Method in class org.apache.tika.pipes.fetcher.config.FetcherConfigContainer
 
setContentHandler(ContentHandler) - Method in class org.apache.tika.sax.ContentHandlerDecorator

Sets the underlying content handler.

setContentHandlerDecoratorFactory(ContentHandlerDecoratorFactory) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setContextClassLoader(ClassLoader) - Static method in class org.apache.tika.config.ServiceLoader

Sets the context class loader to use for all threads that access
 this class.

setCorePoolSize(int) - Method in interface org.apache.tika.concurrent.ConfigurableThreadPoolExecutor
 
setCountTotal(boolean) - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
setDefaultTimeZone(String) - Method in class org.apache.tika.metadata.filter.DateNormalizingMetadataFilter
 
setDescription(String) - Method in class org.apache.tika.mime.MimeType

Set the description of this media type.

setDetector(Detector) - Method in class org.apache.tika.parser.AutoDetectParser

Sets the type detector used by this parser to auto-detect the type
 of a document.

setDigesterFactory(DigestingParser.DigesterFactory) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setDocumentLocator(Locator) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
setDocumentLocator(Locator) - Method in class org.apache.tika.sax.DIFContentHandler
 
setDocumentLocator(Locator) - Method in class org.apache.tika.sax.TeeContentHandler
 
setDocumentLocator(Locator) - Method in class org.apache.tika.sax.TextContentHandler
 
setEmbeddedBytesExcludeEmbeddedResourceTypes(List<String>) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory
 
setEmbeddedBytesExcludeMimeTypes(List<String>) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory
 
setEmbeddedBytesIncludeEmbeddedResourceTypes(List<String>) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory
 
setEmbeddedBytesIncludeMimeTypes(List<String>) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory
 
setEmbeddedBytesSelector(EmbeddedBytesSelector) - Method in class org.apache.tika.extractor.RUnpackExtractor
 
setEmbeddedDocumentExtractorFactory(EmbeddedDocumentExtractorFactory) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setEmbeddedIdPrefix(String) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setEmitIntermediateResults(boolean) - Method in class org.apache.tika.pipes.async.AsyncConfig
 
setEmitKey(EmitKey) - Method in class org.apache.tika.pipes.FetchEmitTuple
 
setEmitKeyBase(String) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setEmitMaxEstimatedBytes(long) - Method in class org.apache.tika.pipes.async.AsyncConfig
 
setEmitter(String) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setEmitterName(String) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setEmitWithinMillis(long) - Method in class org.apache.tika.pipes.async.AsyncConfig

If nothing has been emitted in this amount of time
 and the AsyncConfig.getEmitMaxEstimatedBytes() has not been reached yet,
 emit what's in the emit queue.

setEncodingDetector(EncodingDetector) - Method in class org.apache.tika.parser.AbstractEncodingDetectorParser
 
setExclude(List<String>) - Method in class org.apache.tika.metadata.filter.ExcludeFieldMetadataFilter
 
setExcludeFields(List<String>) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setExcludes(List<String>) - Method in class org.apache.tika.pipes.PipesReporterBase
 
setExcludeUnmapped(boolean) - Method in class org.apache.tika.metadata.filter.FieldNameMappingFilter

If this is true (default), this means that only the fields that
 have a "from" value in the mapper will be passed through.

setExitValue(int) - Method in class org.apache.tika.utils.FileProcessResult
 
setExtractEmbeddedDocumentBytes(boolean) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setExtractFileSystemMetadata(boolean) - Method in class org.apache.tika.pipes.fetcher.fs.config.FileSystemFetcherConfig
 
setExtractFileSystemMetadata(boolean) - Method in class org.apache.tika.pipes.fetcher.fs.FileSystemFetcher

Extract file system metadata (created, modified, accessed) when fetching file.

setFallback(Parser) - Method in class org.apache.tika.parser.CompositeParser

Sets the fallback parser.

setFetcherName(String) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setFileList(String) - Method in class org.apache.tika.pipes.pipesiterator.filelist.FileListPipesIterator
 
setFilePath(String) - Method in class org.apache.tika.detect.FileCommandDetector
 
setFilters(List<MetadataFilter>) - Method in class org.apache.tika.metadata.filter.CompositeMetadataFilter
 
setFilters(List<MetadataListFilter>) - Method in class org.apache.tika.metadata.listfilter.CompositeMetadataListFilter
 
setForkedJvmArgs(List<String>) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setGeoPointFieldName(String) - Method in class org.apache.tika.metadata.filter.GeoPointMetadataFilter

Set the field for the concatenated LATITUDE,LONGITUDE string.

setHandlerType(String) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setHasHeader(boolean) - Method in class org.apache.tika.pipes.pipesiterator.filelist.FileListPipesIterator
 
setIdentifier(String) - Method in class org.apache.tika.sax.StandardReference
 
setIgnoredLineConsumer(ExternalParser.LineConsumer) - Method in class org.apache.tika.parser.external.ExternalParser

Set a consumer for the lines ignored by the parse functions

setInclude(List<String>) - Method in class org.apache.tika.metadata.filter.IncludeFieldMetadataFilter
 
setIncludeEmpty(boolean) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setIncludeFields(List<String>) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setIncludeOriginal(boolean) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setIncludes(List<String>) - Method in class org.apache.tika.pipes.PipesReporterBase
 
setJavaCommand(List<String>) - Method in class org.apache.tika.fork.ForkParser

Sets the command used to start the forked server process.

setJavaPath(String) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setJson(String) - Method in class org.apache.tika.pipes.fetcher.config.FetcherConfigContainer
 
setMainOrganizationAcronym(String) - Method in class org.apache.tika.sax.StandardReference
 
setMappings(Map<String, String>) - Method in class org.apache.tika.metadata.filter.FieldNameMappingFilter
 
setMatchMap(Map<String, String>) - Method in class org.apache.tika.parser.RegexCaptureParser
 
setMaxBufferLength(int) - Method in class org.apache.tika.sax.StandardsExtractingContentHandler

The number of characters to store in memory for checking for standards.

setMaxBytes(int) - Method in class org.apache.tika.detect.FileCommandDetector

If this is not called on a TikaInputStream, this detector
 will spool up to this many bytes to a file to be detected
 by the 'file' command.

setMaxEmbeddedBytesForExtraction(long) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory

Total number of bytes to write out.

setMaxEmbeddedResources(int) - Method in class org.apache.tika.pipes.HandlerConfig
 
setMaxEmbeddedResources(int) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setMaxEntityExpansions(int) - Static method in class org.apache.tika.utils.XMLReaderUtils

Set the maximum number of entity expansions allowable in SAX/DOM/StAX parsing.

setMaxFieldSize(int) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setMaxFilesProcessedPerProcess(int) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setMaxFilesProcessedPerServer(int) - Method in class org.apache.tika.fork.ForkParser

If there is a slowly building memory leak in one of the parsers,
 it is useful to set a limit on the number of files processed
 by a server before it is shutdown and restarted.

setMaxForEmitBatchBytes(long) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setMaximumCompressionRatio(long) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setMaximumCompressionRatio(long) - Method in class org.apache.tika.sax.SecureContentHandler

Sets the ratio between output characters and input bytes.

setMaximumDepth(int) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setMaximumDepth(int) - Method in class org.apache.tika.sax.SecureContentHandler

Sets the maximum XML element nesting level.

setMaximumPackageEntryDepth(int) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setMaximumPackageEntryDepth(int) - Method in class org.apache.tika.sax.SecureContentHandler

Sets the maximum package entry nesting level.

setMaximumPoolSize(int) - Method in interface org.apache.tika.concurrent.ConfigurableThreadPoolExecutor
 
setMaxKeySize(int) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setMaxNumReuses(int) - Static method in class org.apache.tika.utils.XMLReaderUtils
 
setMaxStdErr(int) - Method in class org.apache.tika.parser.external2.ExternalParser
 
setMaxStdOut(int) - Method in class org.apache.tika.parser.external2.ExternalParser
 
setMaxStringLength(int) - Method in class org.apache.tika.Tika

Sets the maximum length of strings returned by the parseToString
 methods.

setMaxTotalEstimatedBytes(int) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setMaxValuesPerField(int) - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
setMaxWaitForClientMillis(long) - Method in class org.apache.tika.pipes.PipesConfig
 
setMaxWaitMs(long) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setMediaTypeRegistry(MediaTypeRegistry) - Method in class org.apache.tika.parser.CompositeParser

Sets the media type registry used to infer type relationships.

setMediaTypeRegistry(MediaTypeRegistry) - Method in class org.apache.tika.parser.multiple.AbstractMultipleParser

Sets the media type registry used to infer type relationships.

setMetadataCommandArguments(Map<Property, String[]>) - Method in class org.apache.tika.embedder.ExternalEmbedder

Sets the map of Metadata keys to command line parameters.

setMetadataExtractionPatterns(Map<Pattern, String>) - Method in class org.apache.tika.parser.external.ExternalParser

Sets the map of regular expression patterns and Metadata
 keys.

setMetadataWriteFilter(MetadataWriteFilter) - Method in class org.apache.tika.metadata.Metadata

Sets the writeFilter that is called before Metadata.set(String, String)
 Metadata.set(String, String[]), Metadata.add(String, String),
 Metadata.add(String, String[]).

setMetadataWriteFilterFactory(MetadataWriteFilterFactory) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setMimes(List<String>) - Method in class org.apache.tika.metadata.filter.ClearByMimeMetadataFilter
 
setMixedLanguages(boolean) - Method in class org.apache.tika.language.detect.LanguageDetector
 
setName(String) - Method in class org.apache.tika.config.Param
 
setName(String) - Method in class org.apache.tika.pipes.emitter.AbstractEmitter
 
setName(String) - Method in class org.apache.tika.pipes.fetcher.AbstractFetcher
 
setNumClients(int) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setNumEmitters(int) - Method in class org.apache.tika.pipes.async.AsyncConfig
 
setNumOfHidden(int) - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
setNumOfInputs(int) - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
setNumOfOutputs(int) - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
setOnParseException(String) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setOnParseException(FetchEmitTuple.ON_PARSE_EXCEPTION) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setOpenContainer(Object) - Method in class org.apache.tika.io.TikaInputStream

Stores the open container object against
 the stream, eg after a Zip contents
 detector has loaded the file to decide
 what it contains.

setOutputParser(Parser) - Method in class org.apache.tika.parser.external2.ExternalParser

This parser is called on the output of the process.

setOutputThreshold(long) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setOutputThreshold(long) - Method in class org.apache.tika.sax.SecureContentHandler

Sets the threshold for output characters before the zip bomb prevention
 is activated.

setParams(float[]) - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
setParseContext(ParseContext) - Method in class org.apache.tika.pipes.emitter.EmitData
 
setParseMode(String) - Method in class org.apache.tika.pipes.HandlerConfig
 
setParseMode(String) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setParseMode(HandlerConfig.PARSE_MODE) - Method in class org.apache.tika.pipes.HandlerConfig
 
setParseMode(HandlerConfig.PARSE_MODE) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setParsers(Map<MediaType, Parser>) - Method in class org.apache.tika.parser.CompositeParser

Sets the component parsers.

setPipesReporter(PipesReporter) - Method in class org.apache.tika.pipes.async.AsyncConfig
 
setPoolSize(int) - Method in class org.apache.tika.fork.ForkParser

Sets the size of the process pool.

setPoolSize(int) - Static method in class org.apache.tika.mime.MimeTypesReader

Set the pool size for cached XML parsers.

setPoolSize(int) - Static method in class org.apache.tika.utils.XMLReaderUtils

Set the pool size for cached XML parsers.

setPriors(Map<String, Float>) - Method in class org.apache.tika.language.detect.LanguageDetector

Set the a-priori probabilities for these languages.

setProcessTimeMillis(long) - Method in class org.apache.tika.utils.FileProcessResult
 
setQueueSize(int) - Method in class org.apache.tika.pipes.async.AsyncConfig
 
setQueueSize(int) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setQuoteAssignmentValues(boolean) - Method in class org.apache.tika.embedder.ExternalEmbedder

Sets whether or not to quote assignment values, i.e. tag='value'.

setRegex(String) - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
setRenderer(Renderer) - Method in interface org.apache.tika.parser.RenderingParser
 
setReturnStderr(boolean) - Method in class org.apache.tika.parser.external2.ExternalParser

If set to true, this will return the stderr in the metadata
 via ExternalProcess.STD_ERR.

setReturnStdout(boolean) - Method in class org.apache.tika.parser.external2.ExternalParser

If set to true, this will return the stdout in the metadata
 via ExternalProcess.STD_OUT.

setScore(double) - Method in class org.apache.tika.sax.StandardReference
 
setScore(double) - Method in class org.apache.tika.sax.StandardReference.StandardReferenceBuilder
 
setSecondOrganization(String, String) - Method in class org.apache.tika.sax.StandardReference.StandardReferenceBuilder
 
setSecondOrganizationAcronym(String) - Method in class org.apache.tika.sax.StandardReference
 
setSeparator(String) - Method in class org.apache.tika.sax.StandardReference
 
setServerParseTimeoutMillis(long) - Method in class org.apache.tika.fork.ForkParser

The maximum amount of time allowed for the server to try to parse a file.

setServerPulseMillis(long) - Method in class org.apache.tika.fork.ForkParser

The amount of time in milliseconds that the server
 should wait before checking to see if the parse has timed out
 or if the wait has timed out
 The default is 5 seconds.

setServerWaitTimeoutMillis(long) - Method in class org.apache.tika.fork.ForkParser

The maximum amount of time allowed for the server to wait for a new request to parse
 a file.

setShortText(boolean) - Method in class org.apache.tika.language.detect.LanguageDetector
 
setShutdownClientAfterMillis(long) - Method in class org.apache.tika.pipes.PipesConfigBase

If the client has been inactive after this many milliseconds,
 shut it down.

setSkipContainerDocument(boolean) - Method in interface org.apache.tika.parser.DigestingParser.DigesterFactory
 
setSleepOnStartupTimeoutMillis(long) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setSourceField(String) - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
setSpoolToDisk(long) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setStaleFetcherDelaySeconds(int) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setStaleFetcherTimeoutSeconds(int) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setStartupTimeoutMillis(long) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setStderr(String) - Method in class org.apache.tika.utils.FileProcessResult
 
setStderrLength(long) - Method in class org.apache.tika.utils.FileProcessResult
 
setStderrTruncated(boolean) - Method in class org.apache.tika.utils.FileProcessResult
 
setStdout(String) - Method in class org.apache.tika.utils.FileProcessResult
 
setStdoutLength(long) - Method in class org.apache.tika.utils.FileProcessResult
 
setStdoutTruncated(boolean) - Method in class org.apache.tika.utils.FileProcessResult
 
setSuffixStrategy(String) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setSuffixStrategy(EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
setSuperType(MimeType, MediaType) - Method in class org.apache.tika.mime.MimeTypes
 
setSupportedEmbedTypes(Set<MediaType>) - Method in class org.apache.tika.embedder.ExternalEmbedder
 
setSupportedTypes(List<String>) - Method in class org.apache.tika.parser.external2.ExternalParser

This is set during initialization from a tika-config.

setSupportedTypes(Set<MediaType>) - Method in class org.apache.tika.parser.external.ExternalParser
 
setTargetField(String) - Method in class org.apache.tika.metadata.filter.CaptureGroupMetadataFilter
 
setTemporaryFileDirectory(File) - Method in class org.apache.tika.io.TemporaryResources

Sets the directory to be used for the temporary files created by
 the TemporaryResources.createTempFile(String) method.

setTemporaryFileDirectory(Path) - Method in class org.apache.tika.io.TemporaryResources

Sets the directory to be used for the temporary files created by
 the TemporaryResources.createTempFile(String) method.

setThreshold(double) - Method in class org.apache.tika.sax.StandardsExtractingContentHandler

Sets the score to be used as threshold.

setThrowOnWriteLimitReached(boolean) - Method in class org.apache.tika.pipes.HandlerConfig
 
setThrowOnWriteLimitReached(boolean) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setThrowOnZeroBytes(boolean) - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
setTikaConfig(String) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setTikaConfig(Path) - Method in class org.apache.tika.pipes.PipesConfigBase
 
setTimeout(boolean) - Method in class org.apache.tika.utils.FileProcessResult
 
setTimeoutMillis(long) - Method in class org.apache.tika.pipes.PipesConfigBase

How long to wait in milliseconds before timing out the forked process.

setTimeoutMs(long) - Method in class org.apache.tika.detect.FileCommandDetector
 
setTimeoutMs(long) - Method in class org.apache.tika.parser.external2.ExternalParser
 
setType(Class<T>) - Method in class org.apache.tika.config.Param
 
setType(String) - Method in class org.apache.tika.pipes.HandlerConfig
 
setType(MediaType) - Method in class org.apache.tika.detect.NNTrainedModelBuilder
 
setType(BasicContentHandlerFactory.HANDLER_TYPE) - Method in class org.apache.tika.pipes.HandlerConfig
 
setTypes(List<String>) - Method in class org.apache.tika.metadata.filter.ClearByAttachmentTypeMetadataFilter

For types see TikaCoreProperties.EmbeddedResourceType

setTypeString(String) - Method in class org.apache.tika.config.Param
 
setUseMime(boolean) - Method in class org.apache.tika.detect.FileCommandDetector
 
setWriteContent(boolean) - Method in class org.apache.tika.parser.RegexCaptureParser
 
setWriteFileNameToContent(boolean) - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
setWriteFileNameToContent(boolean) - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractorFactory
 
setWriteFileNameToContent(boolean) - Method in class org.apache.tika.extractor.RUnpackExtractorFactory
 
setWriteLimit(int) - Method in class org.apache.tika.pipes.HandlerConfig
 
setWriteLimit(int) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
setWriteLimitReached(boolean) - Method in class org.apache.tika.parser.ParseRecord
 
setZeroPadName(int) - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
shortText - Variable in class org.apache.tika.language.detect.LanguageDetector
 
SHOT_DATE - Static variable in interface org.apache.tika.metadata.XMPDM

"The date and time when the video was shot."

SHOT_LOCATION - Static variable in interface org.apache.tika.metadata.XMPDM

"The name of the location where the video was shot.

SHOT_NAME - Static variable in interface org.apache.tika.metadata.XMPDM

"The name of the shot or take."

shouldParseEmbedded(Metadata) - Method in interface org.apache.tika.extractor.EmbeddedDocumentExtractor
 
shouldParseEmbedded(Metadata) - Method in class org.apache.tika.extractor.EmbeddedDocumentUtil
 
shouldParseEmbedded(Metadata) - Method in class org.apache.tika.extractor.ParsingEmbeddedDocumentExtractor
 
shouldTranslate(InputStream, Metadata) - Method in class org.apache.tika.extractor.DefaultEmbeddedStreamTranslator

This should sniff the stream to determine if it needs to be translated.

shouldTranslate(InputStream, Metadata) - Method in interface org.apache.tika.extractor.EmbeddedStreamTranslator
 
SIGNATURE_CONTACT_INFO - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SIGNATURE_DATE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SIGNATURE_FILTER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SIGNATURE_LOCATION - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SIGNATURE_NAME - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SIGNATURE_REASON - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SIMPLE - org.apache.tika.metadata.Property.PropertyType

A single value

SimpleThreadPoolExecutor - Class in org.apache.tika.concurrent

Simple Thread Pool Executor

SimpleThreadPoolExecutor() - Constructor for class org.apache.tika.concurrent.SimpleThreadPoolExecutor
 
size() - Method in class org.apache.tika.metadata.Metadata

Returns the number of metadata names in this metadata.

skip(long) - Method in class org.apache.tika.io.BoundedInputStream

Invokes the delegate's skip(long) method.

skip(long) - Method in class org.apache.tika.io.LookaheadInputStream
 
skip(long) - Method in class org.apache.tika.io.TailStream

 This implementation delegates to the read() method
 to ensure that the tail buffer is also filled if data is skipped.

skip(long) - Method in class org.apache.tika.io.TikaInputStream

This relies on IOUtils.skip(InputStream, long, byte[]) to ensure
 that the alleged bytes skipped were actually skipped.

skip(InputStream, long, byte[]) - Static method in class org.apache.tika.io.IOUtils
 
SKIP - org.apache.tika.pipes.FetchEmitTuple.ON_PARSE_EXCEPTION
 
SKIP - Static variable in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
skippedEntity(String) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
skippedEntity(String) - Method in class org.apache.tika.sax.TeeContentHandler
 
skippedEntity(String) - Method in class org.apache.tika.sax.xpath.MatchingContentHandler
 
SLIDE_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Slides are there in the (presentation) document

SOFTWARE - Static variable in interface org.apache.tika.metadata.TIFF

"Software or firmware used to generate the image."

sortLoadedClasses(List<T>) - Static method in class org.apache.tika.utils.ServiceLoaderUtils

Sorts a list of loaded classes, so that non-Tika ones come
 before Tika ones, and otherwise in reverse alphabetical order

SOURCE - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
SOURCE - Static variable in interface org.apache.tika.metadata.DublinCore

A reference to a resource from which the present resource is derived.

SOURCE - Static variable in interface org.apache.tika.metadata.IPTC

Identifies the original owner of the copyright for the intellectual
 content of the item.

SOURCE - Static variable in interface org.apache.tika.metadata.Photoshop
 
SOURCE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
SOURCE - Static variable in interface org.apache.tika.metadata.XMPDC

A reference to a resource from which the present resource is derived.

SOURCE_PATH - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This should be used to store the path (relative or full)
 of the source file, including the file name,
 e.g. doc/path/to/my_pdf.pdf

SPACE - Static variable in class org.apache.tika.utils.StringUtils

A String for a space character.

SPEAKER_PLACEMENT - Static variable in interface org.apache.tika.metadata.XMPDM

"A description of the speaker angles from center front in degrees.

STANDARD_REFERENCES - Static variable in class org.apache.tika.sax.StandardsExtractingContentHandler
 
StandardOrganizations - Class in org.apache.tika.sax

This class provides a collection of the most important technical standard organizations.

StandardOrganizations() - Constructor for class org.apache.tika.sax.StandardOrganizations
 
StandardReference - Class in org.apache.tika.sax

Class that represents a standard reference.

StandardReference.StandardReferenceBuilder - Class in org.apache.tika.sax
 
StandardReferenceBuilder(String, String) - Constructor for class org.apache.tika.sax.StandardReference.StandardReferenceBuilder
 
StandardsExtractingContentHandler - Class in org.apache.tika.sax

StandardsExtractingContentHandler is a Content Handler used to extract
 standard references while parsing.

StandardsExtractingContentHandler() - Constructor for class org.apache.tika.sax.StandardsExtractingContentHandler

Creates a decorator that by default forwards incoming SAX events to a
 dummy content handler that simply ignores all the events.

StandardsExtractingContentHandler(ContentHandler, Metadata) - Constructor for class org.apache.tika.sax.StandardsExtractingContentHandler

Creates a decorator for the given SAX event handler and Metadata object.

StandardsText - Class in org.apache.tika.sax

StandardText relies on regular expressions to extract standard references
 from text.

StandardsText() - Constructor for class org.apache.tika.sax.StandardsText
 
StandardWriteFilter - Class in org.apache.tika.metadata.writefilter

This is to be used to limit the amount of metadata that a
 parser can add based on the StandardWriteFilter.maxTotalEstimatedSize,
 StandardWriteFilter.maxFieldSize, StandardWriteFilter.maxValuesPerField, and
 StandardWriteFilter.maxKeySize.

StandardWriteFilter(int, int, int, int, Set<String>, Set<String>, boolean) - Constructor for class org.apache.tika.metadata.writefilter.StandardWriteFilter
 
StandardWriteFilterFactory - Class in org.apache.tika.metadata.writefilter

Factory class for StandardWriteFilter.

StandardWriteFilterFactory() - Constructor for class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
start(BundleContext) - Method in class org.apache.tika.config.TikaActivator
 
startDescription(String, String, String) - Method in class org.apache.tika.sax.XMPContentHandler
 
startDocument() - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
startDocument() - Method in class org.apache.tika.sax.DIFContentHandler
 
startDocument() - Method in class org.apache.tika.sax.EmbeddedContentHandler

Ignored.

startDocument() - Method in class org.apache.tika.sax.ExpandedTitleContentHandler
 
startDocument() - Method in class org.apache.tika.sax.TeeContentHandler
 
startDocument() - Method in class org.apache.tika.sax.TextContentHandler
 
startDocument() - Method in class org.apache.tika.sax.ToHTMLContentHandler
 
startDocument() - Method in class org.apache.tika.sax.ToXMLContentHandler

Writes the XML prefix.

startDocument() - Method in class org.apache.tika.sax.XHTMLContentHandler

Starts an XHTML document by setting up the namespace mappings
 when called for the first time.

startDocument() - Method in class org.apache.tika.sax.XMPContentHandler

Starts an XMP document by setting up the namespace mappings and
 writing out the following header:

STARTED - org.apache.tika.pipes.async.AsyncStatus.ASYNC_STATUS
 
startElement(String) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
startElement(String, String, String) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.mime.MimeTypesReader
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.DIFContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.ElementMappingContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.ExpandedTitleContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.LinkContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.RichTextContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.SafeContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.SecureContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.TeeContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.TextAndAttributeContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.TextContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.ToTextContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.ToXMLContentHandler
 
startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.XHTMLContentHandler

Starts the given element.

startElement(String, String, String, Attributes) - Method in class org.apache.tika.sax.xpath.MatchingContentHandler
 
startElement(String, AttributesImpl) - Method in class org.apache.tika.sax.XHTMLContentHandler
 
startEmbeddedDocument(ContentHandler, Metadata) - Method in class org.apache.tika.sax.AbstractRecursiveParserWrapperHandler

This is called before parsing each embedded document.

startEmbeddedDocument(ContentHandler, Metadata) - Method in class org.apache.tika.sax.RecursiveParserWrapperHandler

This is called before parsing an embedded document

startPrefixMapping(String, String) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
startPrefixMapping(String, String) - Method in class org.apache.tika.sax.TeeContentHandler
 
startPrefixMapping(String, String) - Method in class org.apache.tika.sax.ToXMLContentHandler
 
startTotalCount() - Method in class org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator
 
startTotalCount() - Method in interface org.apache.tika.pipes.pipesiterator.TotalCounter
 
STATE - Static variable in interface org.apache.tika.metadata.Photoshop
 
StatefulParser - Class in org.apache.tika.parser

The RecursiveParserWrapper wraps the parser sent
 into the parsecontext and then uses that parser
 to store state (among many other things).

StatefulParser(Parser) - Constructor for class org.apache.tika.parser.StatefulParser

Creates a decorator for the given parser.

STATIC - org.apache.tika.config.TikaConfigSerializer.Mode

Static version of the config, with explicit lists of parsers/decorators/etc

STATIC_FULL - org.apache.tika.config.TikaConfigSerializer.Mode

Static version of the config, with explicit lists of decorators etc,
 and all parsers given with their detected supported mime types

STD_ERR - Static variable in interface org.apache.tika.metadata.ExternalProcess

STD_ERR

STD_ERR_IS_TRUNCATED - Static variable in interface org.apache.tika.metadata.ExternalProcess

Whether or not stderr was truncated

STD_ERR_LENGTH - Static variable in interface org.apache.tika.metadata.ExternalProcess

Stderr length whether or not it was truncated.

STD_OUT - Static variable in interface org.apache.tika.metadata.ExternalProcess

STD_OUT

STD_OUT_IS_TRUNCATED - Static variable in interface org.apache.tika.metadata.ExternalProcess

Whether or not stdout was truncated

STD_OUT_LENGTH - Static variable in interface org.apache.tika.metadata.ExternalProcess

Stdout length whether or not it was truncated.

stop(BundleContext) - Method in class org.apache.tika.config.TikaActivator
 
StoppingEarlyException - Exception in org.apache.tika.sax

Sentinel exception to stop parsing xml once target is found
 while SAX parsing.

StoppingEarlyException() - Constructor for exception org.apache.tika.sax.StoppingEarlyException
 
StreamEmitter - Interface in org.apache.tika.pipes.emitter
 
StreamGobbler - Class in org.apache.tika.utils
 
StreamGobbler(InputStream, int) - Constructor for class org.apache.tika.utils.StreamGobbler
 
streamResetForReRead(InputStream, TemporaryResources) - Static method in class org.apache.tika.utils.ParserUtils

Resets the given TikaInputStream (checked by
 ParserUtils.ensureStreamReReadable(InputStream, TemporaryResources, Metadata))
 so that it can be re-read again.

STRETCH_MODE - Static variable in interface org.apache.tika.metadata.XMPDM

"The audio stretch mode."

StringUtils - Class in org.apache.tika.utils
 
StringUtils() - Constructor for class org.apache.tika.utils.StringUtils
 
STRUCTURE - org.apache.tika.metadata.Property.PropertyType
 
SUB_CLASS_OF_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
SUB_CLASS_TYPE_ATTR - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
SUBJECT - Static variable in interface org.apache.tika.metadata.DublinCore

The topic of the content of the resource.

SUBJECT - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

Deprecated.

SUBJECT - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

DublinCore.SUBJECT; should include both subject and keywords
 if a document format has both.

SUBJECT - Static variable in interface org.apache.tika.metadata.XMPDC

The topic of the content of the resource.

SUBJECT_CODE - Static variable in interface org.apache.tika.metadata.IPTC

Specifies one or more Subjects from the IPTC Subject-NewsCodes taxonomy
 to categorise the content.

SUBLOCATION - Static variable in interface org.apache.tika.metadata.IPTC

Name of a sublocation the content is focussing on -- either the
 location shown in visual media or referenced by text or audio media.

SUBMISSION_ACCEPTED_AT_TIME - Static variable in interface org.apache.tika.metadata.MAPI
 
SUBMISSION_ID - Static variable in interface org.apache.tika.metadata.MAPI
 
SubtreeMatcher - Class in org.apache.tika.sax.xpath

Evaluation state of a ...//... XPath expression.

SubtreeMatcher(Matcher) - Constructor for class org.apache.tika.sax.xpath.SubtreeMatcher
 
SUCCESS - org.apache.tika.renderer.RenderResult.STATUS
 
SUPPLEMENTAL_CATEGORIES - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated. 

SUPPLEMENTAL_CATEGORIES - Static variable in interface org.apache.tika.metadata.Photoshop
 
SupplementingParser - Class in org.apache.tika.parser.multiple

Runs the input stream through all available parsers,
 merging the metadata from them based on the
 AbstractMultipleParser.MetadataPolicy chosen.

SupplementingParser(MediaTypeRegistry, Collection<? extends Parser>, Map<String, Param>) - Constructor for class org.apache.tika.parser.multiple.SupplementingParser
 
SupplementingParser(MediaTypeRegistry, AbstractMultipleParser.MetadataPolicy, Collection<? extends Parser>) - Constructor for class org.apache.tika.parser.multiple.SupplementingParser
 
SupplementingParser(MediaTypeRegistry, AbstractMultipleParser.MetadataPolicy, Parser...) - Constructor for class org.apache.tika.parser.multiple.SupplementingParser
 
supportsTotalCount() - Method in class org.apache.tika.pipes.CompositePipesReporter
 
supportsTotalCount() - Method in class org.apache.tika.pipes.PipesReporter

Override this if your reporter supports total count.

SystemUtils - Class in org.apache.tika.utils

Copied from commons-lang to avoid requiring the dependency

SystemUtils() - Constructor for class org.apache.tika.utils.SystemUtils
 




T

TABLE_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Tables in the document

TABLE_ID - Static variable in interface org.apache.tika.metadata.ClimateForcast
 
TABLE_NAME - Static variable in interface org.apache.tika.metadata.Database
 
TaggedContentHandler - Class in org.apache.tika.sax

A content handler decorator that tags potential exceptions so that the
 handler that caused the exception can easily be identified.

TaggedContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.TaggedContentHandler

Creates a tagging decorator for the given content handler.

TaggedSAXException - Exception in org.apache.tika.sax

A SAXException wrapper that tags the wrapped exception with
 a given object reference.

TaggedSAXException(SAXException, Object) - Constructor for exception org.apache.tika.sax.TaggedSAXException

Creates a tagged wrapper for the given exception.

TailStream - Class in org.apache.tika.io


 A specialized input stream implementation which records the last portion read
 from an underlying stream.

TailStream(InputStream, int) - Constructor for class org.apache.tika.io.TailStream

Creates a new instance of TailStream.

TAPE_NAME - Static variable in interface org.apache.tika.metadata.XMPDM

"The name of the tape from which the clip was captured, as set during
 the capture process."

TargetElement(String, String) - Constructor for class org.apache.tika.sax.ElementMappingContentHandler.TargetElement

A shortcut that automatically creates the QName object

TargetElement(String, String, Map<QName, QName>) - Constructor for class org.apache.tika.sax.ElementMappingContentHandler.TargetElement

A shortcut that automatically creates the QName object

TargetElement(QName) - Constructor for class org.apache.tika.sax.ElementMappingContentHandler.TargetElement

Creates an TargetElement with no attributes, all attributes
 will be deleted from SAX stream

TargetElement(QName, Map<QName, QName>) - Constructor for class org.apache.tika.sax.ElementMappingContentHandler.TargetElement

Creates an TargetElement, attributes of this element will
 be mapped as specified

TeeContentHandler - Class in org.apache.tika.sax

Content handler proxy that forwards the received SAX events to zero or
 more underlying content handlers.

TeeContentHandler(ContentHandler...) - Constructor for class org.apache.tika.sax.TeeContentHandler
 
TEMPLATE - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
TEMPO - Static variable in interface org.apache.tika.metadata.XMPDM

"The audio's tempo."

TemporaryResources - Class in org.apache.tika.io

Utility class for tracking and ultimately closing or otherwise disposing
 a collection of temporary resources.

TemporaryResources() - Constructor for class org.apache.tika.io.TemporaryResources
 
text(String) - Static method in class org.apache.tika.mime.MediaType
 
TEXT - org.apache.tika.metadata.Property.ValueType
 
TEXT - org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE
 
TEXT_HTML - Static variable in class org.apache.tika.mime.MediaType
 
TEXT_PLAIN - Static variable in class org.apache.tika.mime.MediaType
 
TextAndAttributeContentHandler - Class in org.apache.tika.sax
 
TextAndAttributeContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.TextAndAttributeContentHandler
 
TextAndAttributeContentHandler(ContentHandler, boolean) - Constructor for class org.apache.tika.sax.TextAndAttributeContentHandler
 
TextContentHandler - Class in org.apache.tika.sax

Content handler decorator that only passes the
 TextContentHandler.characters(char[], int, int) and
 (@link TextContentHandler.ignorableWhitespace(char[], int, int)
 (plus TextContentHandler.startDocument() and TextContentHandler.endDocument() events to
 the decorated content handler.

TextContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.TextContentHandler
 
TextContentHandler(ContentHandler, boolean) - Constructor for class org.apache.tika.sax.TextContentHandler
 
TextDetector - Class in org.apache.tika.detect

Content type detection of plain text documents.

TextDetector() - Constructor for class org.apache.tika.detect.TextDetector

Constructs a TextDetector which will look at the default number
 of bytes from the beginning of the document.

TextDetector(int) - Constructor for class org.apache.tika.detect.TextDetector

Constructs a TextDetector which will look at a given number of
 bytes from the beginning of the document.

TextMatcher - Class in org.apache.tika.sax.xpath

Final evaluation state of a ...


TextMatcher() - Constructor for class org.apache.tika.sax.xpath.TextMatcher
 
TextStatistics - Class in org.apache.tika.detect

Utility class for computing a histogram of the bytes seen in a stream.

TextStatistics() - Constructor for class org.apache.tika.detect.TextStatistics
 
threshold(float) - Method in class org.apache.tika.mime.ProbabilisticMimeDetectionSelector.Builder
 
THROW - Static variable in interface org.apache.tika.config.InitializableProblemHandler
 
THROW - Static variable in interface org.apache.tika.config.LoadErrorHandler

Strategy that throws a RuntimeException with the given
 throwable as the root cause, thus interrupting the entire service
 loading operation.

throwIfCauseOf(Exception) - Method in class org.apache.tika.sax.TaggedContentHandler

Re-throws the original exception thrown by this handler.

throwIfCauseOf(SAXException) - Method in class org.apache.tika.sax.SecureContentHandler

Converts the given SAXException to a corresponding
 TikaException if it's caused by this instance detecting
 a zip bomb.

throwIfWriteLimitReached(Exception) - Static method in exception org.apache.tika.exception.WriteLimitReachedException
 
THUMBNAIL - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
THUMBNAIL - Static variable in interface org.apache.tika.metadata.RTFMetadata

if set to true, this means that an image file is probably a "thumbnail"
 any time a pict/emf/wmf is in an object

TIFF - Interface in org.apache.tika.metadata

XMP Exif TIFF schema.

Tika - Class in org.apache.tika

Facade class for accessing Tika functionality.

Tika() - Constructor for class org.apache.tika.Tika

Creates a Tika facade using the default configuration.

Tika(TikaConfig) - Constructor for class org.apache.tika.Tika

Creates a Tika facade using the given configuration.

Tika(Detector) - Constructor for class org.apache.tika.Tika

Creates a Tika facade using the given detector instance, the
 default parser configuration, and the default Translator.

Tika(Detector, Parser) - Constructor for class org.apache.tika.Tika

Creates a Tika facade using the given detector and parser instances, but the default
 Translator.

Tika(Detector, Parser, Translator) - Constructor for class org.apache.tika.Tika

Creates a Tika facade using the given detector, parser, and translator instances.

TIKA_CONFIG_PATH - Static variable in class org.apache.tika.parser.AutoDetectParserFactory

Path to a tika-config file.

TIKA_CONTENT - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TIKA_CONTENT_HANDLER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Simple class name of the content handler

TIKA_DETECTED_LANGUAGE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TIKA_DETECTED_LANGUAGE_CONFIDENCE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TIKA_DETECTED_LANGUAGE_CONFIDENCE_RAW - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TIKA_LINK_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
TIKA_META_EXCEPTION_EMBEDDED_STREAM - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Use this to store exceptions caught while trying to read the
 stream of an embedded resource.

TIKA_META_EXCEPTION_PREFIX - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Use this to store parse exception information in the Metadata object.

TIKA_META_EXCEPTION_WARNING - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Use this to store exceptions caught during a parse that are
 non-fatal, e.g. if a parser is in lenient mode and more
 content can be extracted if we ignore an exception thrown by
 a dependency.

TIKA_META_PREFIX - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Use this to prefix metadata properties that store information
 about the parsing process.

TIKA_META_WARN_PREFIX - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Use this to store warnings that happened during the parse.

TIKA_MIME_FILE - Static variable in interface org.apache.tika.metadata.TikaMimeKeys
 
TIKA_PAGED_TEXT_PREFIX - Static variable in interface org.apache.tika.metadata.TikaPagedText
 
TIKA_PARSED_BY - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TIKA_PARSED_BY_FULL_SET - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

Use this to store a record of all parsers that touched a given file
 in the container file's metadata.

TIKA_UTI_TAG - Static variable in interface org.apache.tika.mime.MimeTypesReaderMetKeys
 
TikaActivator - Class in org.apache.tika.config

Bundle activator that adjust the class loading mechanism of the
 ServiceLoader class to work correctly in an OSGi environment.

TikaActivator() - Constructor for class org.apache.tika.config.TikaActivator
 
TikaConfig - Class in org.apache.tika.config

Parse xml config file.

TikaConfig() - Constructor for class org.apache.tika.config.TikaConfig

Creates a default Tika configuration.

TikaConfig(File) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(File, ServiceLoader) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(InputStream) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(ClassLoader) - Constructor for class org.apache.tika.config.TikaConfig

Creates a Tika configuration from the built-in media type rules
 and all the Parser implementations available through the
 service provider mechanism in the given
 class loader.

TikaConfig(String) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(URL) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(URL, ClassLoader) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(URL, ServiceLoader) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(Path) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(Path, ServiceLoader) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(Document) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(Document, ServiceLoader) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(Element) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfig(Element, ClassLoader) - Constructor for class org.apache.tika.config.TikaConfig
 
TikaConfigException - Exception in org.apache.tika.exception

Tika Config Exception is an exception to occur when there is an error
 in Tika config file and/or one or more of the parsers failed to initialize
 from that erroneous config.

TikaConfigException(String) - Constructor for exception org.apache.tika.exception.TikaConfigException

Creates an instance of exception

TikaConfigException(String, Throwable) - Constructor for exception org.apache.tika.exception.TikaConfigException
 
TikaConfigSerializer - Class in org.apache.tika.config
 
TikaConfigSerializer() - Constructor for class org.apache.tika.config.TikaConfigSerializer
 
TikaConfigSerializer.Mode - Enum in org.apache.tika.config
 
TikaCoreProperties - Interface in org.apache.tika.metadata

Contains a core set of basic Tika metadata properties, which all parsers
 will attempt to supply (where the file format permits).

TikaCoreProperties.EmbeddedResourceType - Enum in org.apache.tika.metadata

A file might contain different types of embedded documents.

TikaEmitterException - Exception in org.apache.tika.pipes.emitter
 
TikaEmitterException(String) - Constructor for exception org.apache.tika.pipes.emitter.TikaEmitterException
 
TikaEmitterException(String, Throwable) - Constructor for exception org.apache.tika.pipes.emitter.TikaEmitterException
 
TikaException - Exception in org.apache.tika.exception

Tika exception

TikaException(String) - Constructor for exception org.apache.tika.exception.TikaException
 
TikaException(String, Throwable) - Constructor for exception org.apache.tika.exception.TikaException
 
TikaInputStream - Class in org.apache.tika.io

Input stream with extended capabilities.

TikaMemoryLimitException - Exception in org.apache.tika.exception
 
TikaMemoryLimitException(long, long) - Constructor for exception org.apache.tika.exception.TikaMemoryLimitException
 
TikaMemoryLimitException(String) - Constructor for exception org.apache.tika.exception.TikaMemoryLimitException
 
TikaMimeKeys - Interface in org.apache.tika.metadata

A collection of Tika metadata keys used in Mime Type resolution

TikaPagedText - Interface in org.apache.tika.metadata

Metadata properties for paged text, metadata appropriate
 for an individual page (useful for embedded document handlers
 called on individual pages).

TikaTaskTimeout - Class in org.apache.tika.config
 
TikaTaskTimeout(long) - Constructor for class org.apache.tika.config.TikaTaskTimeout
 
TikaTimeoutException - Exception in org.apache.tika.exception

Runtime/unchecked version of TimeoutException

TikaTimeoutException(String) - Constructor for exception org.apache.tika.exception.TikaTimeoutException
 
TIME_SIGNATURE - Static variable in interface org.apache.tika.metadata.XMPDM

"The time signature of the music."

TIMEOUT - org.apache.tika.pipes.PipesResult.STATUS
 
TIMEOUT - org.apache.tika.pipes.PipesServer.STATUS
 
TIMEOUT - org.apache.tika.renderer.RenderResult.STATUS
 
TIMEOUT - Static variable in class org.apache.tika.pipes.PipesResult
 
TIMEOUT_EXIT_CODE - Static variable in class org.apache.tika.pipes.PipesServer
 
TIMES_INSTANTIATED - Static variable in class org.apache.tika.config.TikaConfig
 
TIMESTAMP - Static variable in interface org.apache.tika.metadata.Geographic

This is the timestamp that derives from a gps record

TITLE - Static variable in interface org.apache.tika.metadata.DublinCore

A name given to the resource.

TITLE - Static variable in interface org.apache.tika.metadata.IPTC

A shorthand reference for the item.

TITLE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TITLE - Static variable in interface org.apache.tika.metadata.XMP

This doesn't belong to the XMP Basic schema.

TITLE - Static variable in interface org.apache.tika.metadata.XMPDC

A name given to the resource.

ToHTMLContentHandler - Class in org.apache.tika.sax

SAX event handler that serializes the HTML document to a character stream.

ToHTMLContentHandler() - Constructor for class org.apache.tika.sax.ToHTMLContentHandler
 
ToHTMLContentHandler(OutputStream, String) - Constructor for class org.apache.tika.sax.ToHTMLContentHandler
 
toString() - Method in class org.apache.tika.config.Param
 
toString() - Method in class org.apache.tika.config.ParamField
 
toString() - Method in class org.apache.tika.detect.MagicDetector

Returns a string representation of the Detection Rule.

toString() - Method in class org.apache.tika.io.TikaInputStream
 
toString() - Method in class org.apache.tika.language.detect.LanguageResult
 
toString() - Method in class org.apache.tika.metadata.filter.CompositeMetadataFilter
 
toString() - Method in class org.apache.tika.metadata.filter.FieldNameMappingFilter
 
toString() - Method in class org.apache.tika.metadata.listfilter.CompositeMetadataListFilter
 
toString() - Method in class org.apache.tika.metadata.Metadata
 
toString() - Method in class org.apache.tika.metadata.writefilter.StandardWriteFilterFactory
 
toString() - Method in class org.apache.tika.mime.MediaType
 
toString() - Method in class org.apache.tika.mime.MimeType

Returns the name of this media type.

toString() - Method in class org.apache.tika.parser.AutoDetectParserConfig
 
toString() - Method in class org.apache.tika.pipes.async.AsyncStatus
 
toString() - Method in class org.apache.tika.pipes.emitter.EmitData
 
toString() - Method in class org.apache.tika.pipes.emitter.EmitKey
 
toString() - Method in class org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig
 
toString() - Method in class org.apache.tika.pipes.FetchEmitTuple
 
toString() - Method in class org.apache.tika.pipes.fetcher.FetchKey
 
toString() - Method in class org.apache.tika.pipes.HandlerConfig
 
toString() - Method in class org.apache.tika.pipes.pipesiterator.TotalCountResult
 
toString() - Method in class org.apache.tika.pipes.PipesResult
 
toString() - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
toString() - Method in class org.apache.tika.sax.DIFContentHandler
 
toString() - Method in class org.apache.tika.sax.Link
 
toString() - Method in class org.apache.tika.sax.StandardReference
 
toString() - Method in class org.apache.tika.sax.TextContentHandler
 
toString() - Method in class org.apache.tika.sax.ToTextContentHandler

Returns the contents of the internal string buffer where
 all the received characters have been collected.

toString() - Method in class org.apache.tika.Tika
 
toString() - Method in class org.apache.tika.utils.FileProcessResult
 
TOTAL_TIME - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
TOTAL_UNMAPPED_UNICODE_CHARS - Static variable in interface org.apache.tika.metadata.PDF
 
TotalCounter - Interface in org.apache.tika.pipes.pipesiterator

Interface for pipesiterators that allow counting of total
 documents.

TotalCountResult - Class in org.apache.tika.pipes.pipesiterator
 
TotalCountResult() - Constructor for class org.apache.tika.pipes.pipesiterator.TotalCountResult
 
TotalCountResult(long, TotalCountResult.STATUS) - Constructor for class org.apache.tika.pipes.pipesiterator.TotalCountResult
 
TotalCountResult.STATUS - Enum in org.apache.tika.pipes.pipesiterator
 
ToTextContentHandler - Class in org.apache.tika.sax

SAX event handler that writes all character content out to a character
 stream.

ToTextContentHandler() - Constructor for class org.apache.tika.sax.ToTextContentHandler

Creates a content handler that writes character events
 to an internal string buffer.

ToTextContentHandler(OutputStream, String) - Constructor for class org.apache.tika.sax.ToTextContentHandler

Creates a content handler that writes character events to
 the given output stream using the given encoding.

ToTextContentHandler(Writer) - Constructor for class org.apache.tika.sax.ToTextContentHandler

Creates a content handler that writes character events to
 the given writer.

ToXMLContentHandler - Class in org.apache.tika.sax

SAX event handler that serializes the XML document to a character stream.

ToXMLContentHandler() - Constructor for class org.apache.tika.sax.ToXMLContentHandler
 
ToXMLContentHandler(OutputStream, String) - Constructor for class org.apache.tika.sax.ToXMLContentHandler

Creates an XML serializer that writes to the given byte stream
 using the given character encoding.

ToXMLContentHandler(String) - Constructor for class org.apache.tika.sax.ToXMLContentHandler
 
TRACK_NUMBER - Static variable in interface org.apache.tika.metadata.XMPDM

"A numeric value indicating the order of the audio file within its
 original recording."

TrainedModel - Class in org.apache.tika.detect
 
TrainedModel() - Constructor for class org.apache.tika.detect.TrainedModel
 
TrainedModelDetector - Class in org.apache.tika.detect
 
TrainedModelDetector() - Constructor for class org.apache.tika.detect.TrainedModelDetector
 
transferTo(OutputStream) - Method in class org.apache.tika.io.BoundedInputStream
 
translate(InputStream, Metadata) - Method in class org.apache.tika.extractor.DefaultEmbeddedStreamTranslator

This will consume the InputStream and return a new stream of translated bytes.

translate(InputStream, Metadata) - Method in interface org.apache.tika.extractor.EmbeddedStreamTranslator
 
translate(String, String) - Method in class org.apache.tika.language.translate.DefaultTranslator

Translate, using the first available service-loaded translator

translate(String, String) - Method in class org.apache.tika.language.translate.EmptyTranslator
 
translate(String, String) - Method in interface org.apache.tika.language.translate.Translator

Translate text to the given language
 This method attempts to auto-detect the source language of the text.

translate(String, String) - Method in class org.apache.tika.Tika

Translate the given text String to the given language, attempting to auto-detect the
 source language.

translate(String, String, String) - Method in class org.apache.tika.language.translate.DefaultTranslator

Translate, using the first available service-loaded translator

translate(String, String, String) - Method in class org.apache.tika.language.translate.EmptyTranslator
 
translate(String, String, String) - Method in interface org.apache.tika.language.translate.Translator

Translate text between given languages.

translate(String, String, String) - Method in class org.apache.tika.Tika

Translate the given text String to and from the given languages.

Translator - Interface in org.apache.tika.language.translate

Interface for Translator services.

TRANSMISSION_REFERENCE - Static variable in interface org.apache.tika.metadata.Photoshop
 
trimMessage(String) - Static method in class org.apache.tika.utils.ExceptionUtils

Utility method to trim the message from a stack trace
 string.

TRUNCATED_METADATA - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

This means that metadata keys or metadata values were truncated.

tryToAdd(FetchEmitTuple) - Method in class org.apache.tika.pipes.pipesiterator.PipesIterator
 
tryToFindExistingLeafParser(Class, ParseContext) - Static method in class org.apache.tika.extractor.EmbeddedDocumentUtil

Tries to find an existing parser within the ParseContext.

tryToParse(String) - Method in class org.apache.tika.utils.DateUtils

Tries to parse the date string; returns null if no parse was possible.

type - Variable in class org.apache.tika.mime.MimeTypesReader

Current type

TYPE - Static variable in interface org.apache.tika.metadata.DublinCore

The nature or genre of the content of the resource.

TYPE - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
TYPE - Static variable in interface org.apache.tika.metadata.XMPDC

The nature or genre of the content of the resource.

TypeDetector - Class in org.apache.tika.detect

Content type detection based on a content type hint.

TypeDetector() - Constructor for class org.apache.tika.detect.TypeDetector
 
types - Variable in class org.apache.tika.mime.MimeTypesReader
 




U

ubyteToInt(byte) - Static method in class org.apache.tika.io.EndianUtils

Convert an 'unsigned' byte to an integer. ie, don't carry across the
 sign.

unescapeCommandLine(String) - Static method in class org.apache.tika.utils.ProcessUtils
 
UNMAPPED_UNICODE_CHARS_PER_PAGE - Static variable in interface org.apache.tika.metadata.PDF
 
UNSPECIFIED_CRASH - org.apache.tika.pipes.PipesResult.STATUS
 
UNSPECIFIED_CRASH - Static variable in class org.apache.tika.pipes.PipesResult
 
UNSUPPORTED - org.apache.tika.pipes.pipesiterator.TotalCountResult.STATUS
 
UNSUPPORTED - Static variable in class org.apache.tika.pipes.pipesiterator.TotalCountResult
 
UnsupportedFormatException - Exception in org.apache.tika.exception

Parsers should throw this exception when they encounter
 a file format that they do not support.

UnsupportedFormatException(String) - Constructor for exception org.apache.tika.exception.UnsupportedFormatException
 
update(Map<PipesResult.STATUS, Long>, TotalCountResult, AsyncStatus.ASYNC_STATUS) - Method in class org.apache.tika.pipes.async.AsyncStatus
 
updateCrash(String) - Method in class org.apache.tika.pipes.async.AsyncStatus
 
URGENCY - Static variable in interface org.apache.tika.metadata.IPTC

Deprecated. 

URGENCY - Static variable in interface org.apache.tika.metadata.Photoshop
 
URI - org.apache.tika.metadata.Property.ValueType
 
URL - org.apache.tika.metadata.Property.ValueType
 
UrlFetcher - Class in org.apache.tika.pipes.fetcher.url

Simple fetcher for URLs.

UrlFetcher() - Constructor for class org.apache.tika.pipes.fetcher.url.UrlFetcher
 
USAGE_TERMS - Static variable in interface org.apache.tika.metadata.XMPRights

A word or short phrase that identifies a resource as a member of a userdefined collection.

USER_DEFINED_METADATA_NAME_PREFIX - Static variable in interface org.apache.tika.metadata.Office

For user defined metadata entries in the document,
 what prefix should be attached to the key names.

UTC - Static variable in class org.apache.tika.utils.DateUtils

The UTC time zone.





V

valueOf(String) - Static method in enum org.apache.tika.config.TikaConfigSerializer.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.language.detect.LanguageConfidence

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.metadata.Property.PropertyType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.metadata.Property.ValueType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.parser.multiple.AbstractMultipleParser.MetadataPolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.async.AsyncStatus.ASYNC_STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.FetchEmitTuple.ON_PARSE_EXCEPTION

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.HandlerConfig.PARSE_MODE

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.pipesiterator.TotalCountResult.STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.PipesResult.STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.pipes.PipesServer.STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.renderer.RenderResult.STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.tika.config.TikaConfigSerializer.Mode

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.language.detect.LanguageConfidence

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.metadata.Property.PropertyType

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.metadata.Property.ValueType

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.parser.multiple.AbstractMultipleParser.MetadataPolicy

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.async.AsyncStatus.ASYNC_STATUS

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.extractor.EmbeddedDocumentBytesConfig.SUFFIX_STRATEGY

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.FetchEmitTuple.ON_PARSE_EXCEPTION

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.HandlerConfig.PARSE_MODE

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.pipesiterator.TotalCountResult.STATUS

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.PipesResult.STATUS

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.pipes.PipesServer.STATUS

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.renderer.RenderResult.STATUS

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE

Returns an array containing the constants of this enum type, in
the order they are declared.

VERSION - org.apache.tika.metadata.TikaCoreProperties.EmbeddedResourceType
 
VERSION - Static variable in interface org.apache.tika.metadata.Epub
 
VERSION - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLCore

The version number.

VERSION - Static variable in interface org.apache.tika.metadata.QuattroPro

Version.

VERSION_COUNT - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

General metadata key for the count of non-final versions available within a file.

VERSION_NUMBER - Static variable in interface org.apache.tika.metadata.TikaCoreProperties

General metadata key for the version number of a given file that contains
 earlier versions within it.

VERY_HIDDEN_SHEET_NAMES - Static variable in interface org.apache.tika.metadata.Office
 
video(String) - Static method in class org.apache.tika.mime.MediaType
 
VIDEO_ALPHA_MODE - Static variable in interface org.apache.tika.metadata.XMPDM

"The alpha mode."

VIDEO_ALPHA_UNITY_IS_TRANSPARENT - Static variable in interface org.apache.tika.metadata.XMPDM

"When true, unity is clear, when false, it is opaque."

VIDEO_COLOR_SPACE - Static variable in interface org.apache.tika.metadata.XMPDM

"The color space."

VIDEO_COMPRESSOR - Static variable in interface org.apache.tika.metadata.XMPDM

"Video compression used.

VIDEO_FIELD_ORDER - Static variable in interface org.apache.tika.metadata.XMPDM

"The field order for video."

VIDEO_FRAME_RATE - Static variable in interface org.apache.tika.metadata.XMPDM

"The video frame rate."

VIDEO_MOD_DATE - Static variable in interface org.apache.tika.metadata.XMPDM

"The date and time when the video was last modified."

VIDEO_PIXEL_ASPECT_RATIO - Static variable in interface org.apache.tika.metadata.XMPDM

"The aspect ratio, expressed as wd/ht.

VIDEO_PIXEL_DEPTH - Static variable in interface org.apache.tika.metadata.XMPDM

"The size in bits of each color component of a pixel.





W

WARC - Interface in org.apache.tika.metadata
 
WARC_PAYLOAD_CONTENT_TYPE - Static variable in interface org.apache.tika.metadata.WARC
 
WARC_RECORD_CONTENT_TYPE - Static variable in interface org.apache.tika.metadata.WARC
 
WARC_RECORD_ID - Static variable in interface org.apache.tika.metadata.WARC
 
WARC_WARNING - Static variable in interface org.apache.tika.metadata.WARC
 
WARN - Static variable in interface org.apache.tika.config.InitializableProblemHandler

Strategy that logs warnings of all problems using a Logger
 created using the given class name.

WARN - Static variable in interface org.apache.tika.config.LoadErrorHandler

Strategy that logs warnings of all problems using a Logger
 created using the given class name.

warning(SAXParseException) - Method in class org.apache.tika.sax.ContentHandlerDecorator
 
WEB_STATEMENT - Static variable in interface org.apache.tika.metadata.XMPRights

A Web URL for a statement of the ownership and usage rights for this resource.

withFallbacks(Collection<? extends Parser>, Set<MediaType>) - Static method in class org.apache.tika.parser.ParserDecorator

Deprecated.
This has been replaced by FallbackParser


withoutTypes(Parser, Set<MediaType>) - Static method in class org.apache.tika.parser.ParserDecorator

Decorates the given parser so that it never claims to support
 parsing of the given media types, but will work for all others.

withTypes(Parser, Set<MediaType>) - Static method in class org.apache.tika.parser.ParserDecorator

Decorates the given parser so that it always claims to support
 parsing of the given media types.

WORD_COUNT - Static variable in interface org.apache.tika.metadata.Office

The number of Words in the document

WORD_PROCESSING_NAMESPACE_URI - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
WORD_PROCESSING_PREFIX - Static variable in interface org.apache.tika.metadata.OfficeOpenXMLExtended
 
WordPerfect - Interface in org.apache.tika.metadata

WordPerfect properties collection.

WORDPERFECT_METADATA_NAME_PREFIX - Static variable in interface org.apache.tika.metadata.WordPerfect
 
WORK_TYPE - Static variable in interface org.apache.tika.metadata.CreativeCommons
 
WORKBOOK_CODENAME - Static variable in interface org.apache.tika.metadata.Office
 
write(char) - Method in class org.apache.tika.sax.ToXMLContentHandler

Writes the given character as-is.

write(char[], int, int) - Method in class org.apache.tika.language.detect.LanguageWriter
 
write(char[], int, int) - Method in interface org.apache.tika.sax.SafeContentHandler.Output
 
write(String) - Method in class org.apache.tika.sax.ToXMLContentHandler

Writes the given string of character as-is.

WRITE_LIMIT_REACHED - Static variable in interface org.apache.tika.metadata.TikaCoreProperties
 
WriteLimiter - Interface in org.apache.tika.sax
 
WriteLimitReachedException - Exception in org.apache.tika.exception
 
WriteLimitReachedException(int) - Constructor for exception org.apache.tika.exception.WriteLimitReachedException
 
WriteOutContentHandler - Class in org.apache.tika.sax

SAX event handler that writes content up to an optional write
 limit out to a character stream or other decorated handler.

WriteOutContentHandler() - Constructor for class org.apache.tika.sax.WriteOutContentHandler

Creates a content handler that writes character events
 to an internal string buffer.

WriteOutContentHandler(int) - Constructor for class org.apache.tika.sax.WriteOutContentHandler

Creates a content handler that writes character events
 to an internal string buffer.

WriteOutContentHandler(Writer) - Constructor for class org.apache.tika.sax.WriteOutContentHandler

Creates a content handler that writes character events to
 the given writer.

WriteOutContentHandler(Writer, int) - Constructor for class org.apache.tika.sax.WriteOutContentHandler

Creates a content handler that writes content up to the given
 write limit to the given character stream.

WriteOutContentHandler(ContentHandler, int) - Constructor for class org.apache.tika.sax.WriteOutContentHandler

Creates a content handler that writes content up to the given
 write limit to the given content handler.

WriteOutContentHandler(ContentHandler, int, boolean, ParseContext) - Constructor for class org.apache.tika.sax.WriteOutContentHandler

The default is to throw a WriteLimitReachedException

writeReplacement(SafeContentHandler.Output) - Method in class org.apache.tika.sax.SafeContentHandler

Outputs the replacement for an invalid character.





X

XHTML - Static variable in class org.apache.tika.sax.XHTMLContentHandler

The XHTML namespace URI

XHTMLContentHandler - Class in org.apache.tika.sax

Content handler decorator that simplifies the task of producing XHTML
 events for Tika content parsers.

XHTMLContentHandler(ContentHandler, Metadata) - Constructor for class org.apache.tika.sax.XHTMLContentHandler
 
XML - org.apache.tika.sax.BasicContentHandlerFactory.HANDLER_TYPE
 
XML - Static variable in class org.apache.tika.mime.MimeTypes

Name of the xml type, application/xml.

XMLReaderUtils - Class in org.apache.tika.utils

Utility functions for reading XML.

XMLReaderUtils() - Constructor for class org.apache.tika.utils.XMLReaderUtils
 
XmlRootExtractor - Class in org.apache.tika.detect

Utility class that uses a SAXParser to determine
 the namespace URI and local name of the root element of an XML file.

XmlRootExtractor() - Constructor for class org.apache.tika.detect.XmlRootExtractor
 
XMP - Interface in org.apache.tika.metadata

Metadata keys for the XMP Basic Schema

XMP - Static variable in class org.apache.tika.sax.XMPContentHandler

The XMP namespace URI

XMP_LOCATION - Static variable in interface org.apache.tika.metadata.PDF

If xmp is extracted by, e.g. the XMLProfiler, where did it come from?

XMPContentHandler - Class in org.apache.tika.sax

Content handler decorator that simplifies the task of producing XMP output.

XMPContentHandler(ContentHandler) - Constructor for class org.apache.tika.sax.XMPContentHandler
 
XMPDC - Interface in org.apache.tika.metadata

Metadata keys for the XMP DublinCore schema.

XMPDM - Interface in org.apache.tika.metadata

XMP Dynamic Media schema.

XMPDM.ChannelTypePropertyConverter - Class in org.apache.tika.metadata

Deprecated.
Experimental method, will change shortly


XMPIdq - Interface in org.apache.tika.metadata
 
XMPMM - Interface in org.apache.tika.metadata
 
XMPPDF - Interface in org.apache.tika.metadata

Metadata keys for the XMP PDF Schema

XMPRights - Interface in org.apache.tika.metadata

XMP Rights management schema.

XPATH - org.apache.tika.metadata.Property.ValueType
 
XPathParser - Class in org.apache.tika.sax.xpath

Parser for a very simple XPath subset.

XPathParser() - Constructor for class org.apache.tika.sax.xpath.XPathParser
 
XPathParser(String, String) - Constructor for class org.apache.tika.sax.xpath.XPathParser
 




Z

ZeroByteFileException - Exception in org.apache.tika.exception

Exception thrown by the AutoDetectParser when a file contains zero-bytes.

ZeroByteFileException(String) - Constructor for exception org.apache.tika.exception.ZeroByteFileException
 
ZeroByteFileException.IgnoreZeroByteFileException - Class in org.apache.tika.exception
 
ZeroSizeFileDetector - Class in org.apache.tika.detect

Detector to identify zero length files as application/x-zerovalue

ZeroSizeFileDetector() - Constructor for class org.apache.tika.detect.ZeroSizeFileDetector
 




_

_COLOR_MODE_CHOICES_INDEXED - Static variable in interface org.apache.tika.metadata.Photoshop
 

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