Uses of Class
org.apache.tika.config.Field

Packages that use Field

Package	Description
org.apache.tika.detect	Media type detection.
org.apache.tika.detect.zip
org.apache.tika.metadata.filter
org.apache.tika.parser.geo
org.apache.tika.parser.html
org.apache.tika.parser.html.charsetdetector
org.apache.tika.parser.image
org.apache.tika.parser.microsoft
org.apache.tika.parser.microsoft.rtf
org.apache.tika.parser.mp3
org.apache.tika.parser.ocr
org.apache.tika.parser.odf
org.apache.tika.parser.pdf
org.apache.tika.parser.pkg
org.apache.tika.parser.recognition
org.apache.tika.parser.recognition.tf
org.apache.tika.parser.strings
org.apache.tika.parser.transcribe.aws
org.apache.tika.parser.txt
org.apache.tika.parser.wordperfect
org.apache.tika.pipes.emitter.fs
org.apache.tika.pipes.emitter.gcs
org.apache.tika.pipes.emitter.opensearch
org.apache.tika.pipes.emitter.s3
org.apache.tika.pipes.emitter.solr
org.apache.tika.pipes.fetcher
org.apache.tika.pipes.fetcher.fs
org.apache.tika.pipes.fetcher.gcs
org.apache.tika.pipes.fetcher.http
org.apache.tika.pipes.fetcher.s3
org.apache.tika.pipes.pipesiterator
org.apache.tika.pipes.pipesiterator.csv
org.apache.tika.pipes.pipesiterator.filelist
org.apache.tika.pipes.pipesiterator.fs
org.apache.tika.pipes.pipesiterator.gcs
org.apache.tika.pipes.pipesiterator.jdbc
org.apache.tika.pipes.pipesiterator.s3
org.apache.tika.pipes.pipesiterator.solr

Uses of Field in org.apache.tika.detect

Methods in org.apache.tika.detect with annotations of type Field

Modifier and Type	Method and Description
void	FileCommandDetector.setFilePath(String fileCommandPath)
void	FileCommandDetector.setMaxBytes(int maxBytes) 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.
void	FileCommandDetector.setTimeoutMs(long timeoutMs)

Uses of Field in org.apache.tika.detect.zip

Methods in org.apache.tika.detect.zip with annotations of type Field

Modifier and Type	Method and Description
void	DefaultZipContainerDetector.setMarkLimit(int markLimit) If this is less than 0, the file will be spooled to disk, and detection will run on the full file.

Uses of Field in org.apache.tika.metadata.filter

Methods in org.apache.tika.metadata.filter with annotations of type Field

Modifier and Type	Method and Description
void	DateNormalizingMetadataFilter.setDefaultTimeZone(String timeZoneId)
void	ExcludeFieldMetadataFilter.setExclude(List<String> exclude)
void	FieldNameMappingFilter.setExcludeUnmapped(boolean excludeUnmapped) If this is true (default), this means that only the fields that have a "from" value in the mapper will be passed through.
void	IncludeFieldMetadataFilter.setInclude(List<String> include)
void	FieldNameMappingFilter.setMappings(Map<String,String> mappings)
void	ClearByMimeMetadataFilter.setMimes(List<String> mimes)

Uses of Field in org.apache.tika.parser.geo

Methods in org.apache.tika.parser.geo with annotations of type Field

Modifier and Type	Method and Description
void	GeoParser.setGazetteerRestEndpoint(String gazetteerRestEndpoint)
void	GeoParser.setNerModelUrl(String nerModelUrl)

Uses of Field in org.apache.tika.parser.html

Methods in org.apache.tika.parser.html with annotations of type Field

Modifier and Type	Method and Description
void	HtmlParser.setExtractScripts(boolean extractScripts) Whether or not to extract contents in script entities.
void	HtmlEncodingDetector.setMarkLimit(int markLimit) How far into the stream to read for charset detection.

Uses of Field in org.apache.tika.parser.html.charsetdetector

Methods in org.apache.tika.parser.html.charsetdetector with annotations of type Field

Modifier and Type	Method and Description
void	StandardHtmlEncodingDetector.setMarkLimit(int markLimit) How far into the stream to read for charset detection.

Uses of Field in org.apache.tika.parser.image

Methods in org.apache.tika.parser.image with annotations of type Field

Modifier and Type	Method and Description
void	PSDParser.setMaxDataLengthBytes(int maxDataLengthBytes)

Uses of Field in org.apache.tika.parser.microsoft

Methods in org.apache.tika.parser.microsoft with annotations of type Field

Modifier and Type	Method and Description
void	AbstractOfficeParser.setByteArrayMaxOverride(int maxOverride) WARNING: this sets a static variable in POI.
void	AbstractOfficeParser.setConcatenatePhoneticRuns(boolean concatenatePhoneticRuns)
void	AbstractOfficeParser.setDateFormatOverride(String format)
void	AbstractOfficeParser.setExtractAllAlternativesFromMSG(boolean extractAllAlternativesFromMSG) Some .msg files can contain body content in html, rtf and/or text.
void	AbstractOfficeParser.setExtractMacros(boolean extractMacros)
void	AbstractOfficeParser.setIncludeDeletedContent(boolean includeDeletedConent)
void	AbstractOfficeParser.setIncludeMoveFromContent(boolean includeMoveFromContent)
void	AbstractOfficeParser.setIncludeShapeBasedContent(boolean includeShapeBasedContent)
void	AbstractOfficeParser.setUseSAXDocxExtractor(boolean useSAXDocxExtractor)
void	AbstractOfficeParser.setUseSAXPptxExtractor(boolean useSAXPptxExtractor)

Uses of Field in org.apache.tika.parser.microsoft.rtf

Methods in org.apache.tika.parser.microsoft.rtf with annotations of type Field

Modifier and Type	Method and Description
void	RTFParser.setMemoryLimitInKb(int memoryLimitInKb)

Uses of Field in org.apache.tika.parser.mp3

Methods in org.apache.tika.parser.mp3 with annotations of type Field

Modifier and Type	Method and Description
void	Mp3Parser.setMaxRecordSize(int maxRecordSize) This statically sets the max record size in ID3v2Frame

Uses of Field in org.apache.tika.parser.ocr

Methods in org.apache.tika.parser.ocr with annotations of type Field

Modifier and Type	Method and Description
void	TesseractOCRParser.setApplyRotation(boolean applyRotation)
void	TesseractOCRParser.setColorspace(String colorspace)
void	TesseractOCRParser.setDensity(int density)
void	TesseractOCRParser.setDepth(int depth)
void	TesseractOCRParser.setEnableImagePreprocessing(boolean enableImagePreprocessing)
void	TesseractOCRParser.setFilter(String filter)
void	TesseractOCRParser.setImageMagickPath(String imageMagickPath) Set the path to the ImageMagick executable directory, needed if it is not on system path.
void	TesseractOCRParser.setLanguage(String language)
void	TesseractOCRParser.setMaxFileSizeToOcr(long maxFileSizeToOcr)
void	TesseractOCRParser.setMinFileSizeToOcr(long minFileSizeToOcr)
void	TesseractOCRParser.setOtherTesseractSettings(List<String> settings)
void	TesseractOCRParser.setOutputType(String outputType)
void	TesseractOCRParser.setPageSegMode(String pageSegMode)
void	TesseractOCRParser.setPreloadLangs(boolean preloadLangs) If set to true and if tesseract is found, this will load the langs that result from --list-langs.
void	TesseractOCRParser.setPreserveInterwordSpacing(boolean preserveInterwordSpacing)
void	TesseractOCRParser.setResize(int resize)
void	TesseractOCRParser.setSkipOCR(boolean skipOCR)
void	TesseractOCRParser.setTessdataPath(String tessdataPath) Set the path to the 'tessdata' folder, which contains language files and config files.
void	TesseractOCRParser.setTesseractPath(String tesseractPath) Set the path to the Tesseract executable's directory, needed if it is not on system path.
void	TesseractOCRParser.setTimeout(int timeout)

Uses of Field in org.apache.tika.parser.odf

Methods in org.apache.tika.parser.odf with annotations of type Field

Modifier and Type	Method and Description
void	FlatOpenDocumentParser.setExtractMacros(boolean extractMacros)
void	OpenDocumentParser.setExtractMacros(boolean extractMacros)

Uses of Field in org.apache.tika.parser.pdf

Methods in org.apache.tika.parser.pdf with annotations of type Field

Modifier and Type	Method and Description
void	PDFParser.setDropThreshold(float dropThreshold)
void	PDFParser.setEnableAutoSpace(boolean v) If true (the default), the parser should estimate where spaces should be inserted between words.
void	PDFParser.setExtractAnnotationText(boolean v) If true (the default), text in annotations will be extracted.
void	PDFParser.setMaxMainMemoryBytes(long maxMainMemoryBytes)
void	PDFParser.setOcrImageType(String imageType)
void	PDFParser.setOcrRenderingStrategy(String ocrRenderingStrategy)
void	PDFParser.setOcrStrategy(String ocrStrategyString)
void	PDFParser.setOcrStrategyAuto(String ocrStrategyAuto)
void	PDFParser.setSortByPosition(boolean v) If true, sort text tokens by their x/y position before extracting text.
void	PDFParser.setSuppressDuplicateOverlappingText(boolean v) If true, the parser should try to remove duplicated text over the same region.

Uses of Field in org.apache.tika.parser.pkg

Methods in org.apache.tika.parser.pkg with annotations of type Field

Modifier and Type	Method and Description
void	PackageParser.setDetectCharsetsInEntryNames(boolean detectCharsetsInEntryNames) Whether or not to run the default charset detector against entry names in ZipFiles.
void	CompressorParser.setMemoryLimitInKb(int memoryLimitInKb)

Uses of Field in org.apache.tika.parser.recognition

Methods in org.apache.tika.parser.recognition with annotations of type Field

Modifier and Type	Method and Description
void	ObjectRecognitionParser.setRecogniser(String recogniserClass)

Uses of Field in org.apache.tika.parser.recognition.tf

Fields in org.apache.tika.parser.recognition.tf with annotations of type Field

Modifier and Type	Field and Description
protected URI	TensorflowRESTRecogniser.apiBaseUri
protected double	TensorflowRESTRecogniser.minConfidence
protected int	TensorflowRESTRecogniser.topN

Uses of Field in org.apache.tika.parser.strings

Methods in org.apache.tika.parser.strings with annotations of type Field

Modifier and Type	Method and Description
void	StringsParser.setEncoding(String encoding)
void	StringsParser.setMinLength(int minLength)
void	StringsParser.setStringsPath(String path) Sets the "strings" installation folder.
void	StringsParser.setTimeoutSeconds(int timeoutSeconds)

Uses of Field in org.apache.tika.parser.transcribe.aws

Methods in org.apache.tika.parser.transcribe.aws with annotations of type Field

Modifier and Type	Method and Description
void	AmazonTranscribe.setBucket(String bucket) Sets the client secret for the transcriber API.
void	AmazonTranscribe.setClientId(String id) Sets the client Id for the transcriber API.
void	AmazonTranscribe.setClientSecret(String secret) Sets the client secret for the transcriber API.
void	AmazonTranscribe.setRegion(String region)

Uses of Field in org.apache.tika.parser.txt

Methods in org.apache.tika.parser.txt with annotations of type Field

Modifier and Type	Method and Description
void	Icu4jEncodingDetector.setIgnoreCharsets(List<String> charsetsToIgnore)
void	UniversalEncodingDetector.setMarkLimit(int markLimit) How far into the stream to read for charset detection.
void	Icu4jEncodingDetector.setMarkLimit(int markLimit) How far into the stream to read for charset detection.
void	Icu4jEncodingDetector.setStripMarkup(boolean stripMarkup) Whether or not to attempt to strip html-ish markup from the stream before sending it to the underlying detector.

Uses of Field in org.apache.tika.parser.wordperfect

Methods in org.apache.tika.parser.wordperfect with annotations of type Field

Modifier and Type	Method and Description
void	WordPerfectParser.setIncludeDeletedContent(boolean includeDeletedContent) Whether or not to include deleted content.

Uses of Field in org.apache.tika.pipes.emitter.fs

Methods in org.apache.tika.pipes.emitter.fs with annotations of type Field

Modifier and Type	Method and Description
void	FileSystemEmitter.setBasePath(String basePath)
void	FileSystemEmitter.setFileExtension(String fileExtension) If you want to customize the output file's file extension.
void	FileSystemEmitter.setOnExists(String onExists)

Uses of Field in org.apache.tika.pipes.emitter.gcs

Methods in org.apache.tika.pipes.emitter.gcs with annotations of type Field

Modifier and Type	Method and Description
void	GCSEmitter.setBucket(String bucket)
void	GCSEmitter.setFileExtension(String fileExtension) If you want to customize the output file's file extension.
void	GCSEmitter.setPrefix(String prefix)
void	GCSEmitter.setProjectId(String projectId)

Uses of Field in org.apache.tika.pipes.emitter.opensearch

Methods in org.apache.tika.pipes.emitter.opensearch with annotations of type Field

Modifier and Type	Method and Description
void	OpenSearchEmitter.setAttachmentStrategy(String attachmentStrategy) Options: SEPARATE_DOCUMENTS, PARENT_CHILD.
void	OpenSearchEmitter.setAuthScheme(String authScheme)
void	OpenSearchEmitter.setCommitWithin(int commitWithin)
void	OpenSearchEmitter.setConnectionTimeout(int connectionTimeout)
void	OpenSearchEmitter.setEmbeddedFileFieldName(String embeddedFileFieldName) If using the OpenSearchEmitter.AttachmentStrategy.PARENT_CHILD, this is the field name used to store the child documents.
void	OpenSearchEmitter.setIdField(String idField) Specify the field in the first Metadata that should be used as the id field for the document.
void	OpenSearchEmitter.setOpenSearchUrl(String openSearchUrl)
void	OpenSearchEmitter.setPassword(String password)
void	OpenSearchEmitter.setProxyHost(String proxyHost)
void	OpenSearchEmitter.setProxyPort(int proxyPort)
void	OpenSearchEmitter.setSocketTimeout(int socketTimeout)
void	OpenSearchEmitter.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.emitter.s3

Methods in org.apache.tika.pipes.emitter.s3 with annotations of type Field

Modifier and Type	Method and Description
void	S3Emitter.setBucket(String bucket)
void	S3Emitter.setCredentialsProvider(String credentialsProvider)
void	S3Emitter.setFileExtension(String fileExtension) If you want to customize the output file's file extension.
void	S3Emitter.setPrefix(String prefix)
void	S3Emitter.setProfile(String profile)
void	S3Emitter.setRegion(String region)
void	S3Emitter.setSpoolToTemp(boolean spoolToTemp) Whether or not to spool the metadatalist to a tmp file before putting object.

Uses of Field in org.apache.tika.pipes.emitter.solr

Methods in org.apache.tika.pipes.emitter.solr with annotations of type Field

Modifier and Type	Method and Description
void	SolrEmitter.setAttachmentStrategy(String attachmentStrategy) Options: SKIP, CONCATENATE_CONTENT, PARENT_CHILD.
void	SolrEmitter.setAuthScheme(String authScheme)
void	SolrEmitter.setCommitWithin(int commitWithin)
void	SolrEmitter.setConnectionTimeout(int connectionTimeout)
void	SolrEmitter.setEmbeddedFileFieldName(String embeddedFileFieldName) If using the SolrEmitter.AttachmentStrategy.PARENT_CHILD, this is the field name used to store the child documents.
void	SolrEmitter.setIdField(String idField) Specify the field in the first Metadata that should be used as the id field for the document.
void	SolrEmitter.setPassword(String password)
void	SolrEmitter.setProxyHost(String proxyHost)
void	SolrEmitter.setProxyPort(int proxyPort)
void	SolrEmitter.setSocketTimeout(int socketTimeout)
void	SolrEmitter.setSolrCollection(String solrCollection)
void	SolrEmitter.setSolrUrls(List<String> solrUrls)
void	SolrEmitter.setSolrZkChroot(String solrZkChroot)
void	SolrEmitter.setSolrZkHosts(List<String> solrZkHosts)
void	SolrEmitter.setUpdateStrategy(String updateStrategy)
void	SolrEmitter.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.fetcher

Methods in org.apache.tika.pipes.fetcher with annotations of type Field

Modifier and Type	Method and Description
void	AbstractFetcher.setName(String name)

Uses of Field in org.apache.tika.pipes.fetcher.fs

Methods in org.apache.tika.pipes.fetcher.fs with annotations of type Field

Modifier and Type	Method and Description
void	FileSystemFetcher.setBasePath(String basePath) If clients will send in relative paths, this must be set to allow this fetcher to fetch the full path.

Uses of Field in org.apache.tika.pipes.fetcher.gcs

Methods in org.apache.tika.pipes.fetcher.gcs with annotations of type Field

Modifier and Type	Method and Description
void	GCSFetcher.setBucket(String bucket)
void	GCSFetcher.setExtractUserMetadata(boolean extractUserMetadata) Whether or not to extract user metadata from the S3Object
void	GCSFetcher.setProjectId(String projectId)
void	GCSFetcher.setSpoolToTemp(boolean spoolToTemp)

Uses of Field in org.apache.tika.pipes.fetcher.http

Methods in org.apache.tika.pipes.fetcher.http with annotations of type Field

Modifier and Type	Method and Description
void	HttpFetcher.setAuthScheme(String authScheme)
void	HttpFetcher.setConnectTimeout(int connectTimeout)
void	HttpFetcher.setNtDomain(String domain)
void	HttpFetcher.setPassword(String password)
void	HttpFetcher.setProxyHost(String proxyHost)
void	HttpFetcher.setProxyPort(int proxyPort)
void	HttpFetcher.setRequestTimeout(int requestTimeout)
void	HttpFetcher.setSocketTimeout(int socketTimeout)
void	HttpFetcher.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.fetcher.s3

Methods in org.apache.tika.pipes.fetcher.s3 with annotations of type Field

Modifier and Type	Method and Description
void	S3Fetcher.setBucket(String bucket)
void	S3Fetcher.setCredentialsProvider(String credentialsProvider)
void	S3Fetcher.setExtractUserMetadata(boolean extractUserMetadata) Whether or not to extract user metadata from the S3Object
void	S3Fetcher.setProfile(String profile)
void	S3Fetcher.setRegion(String region)
void	S3Fetcher.setSpoolToTemp(boolean spoolToTemp)

Uses of Field in org.apache.tika.pipes.pipesiterator

Methods in org.apache.tika.pipes.pipesiterator with annotations of type Field

Modifier and Type	Method and Description
void	PipesIterator.setEmitterName(String emitterName)
void	PipesIterator.setFetcherName(String fetcherName)
void	PipesIterator.setHandlerType(String handlerType)
void	PipesIterator.setMaxEmbeddedResources(int maxEmbeddedResources)
void	PipesIterator.setMaxWaitMs(long maxWaitMs)
void	PipesIterator.setOnParseException(String onParseException)
void	PipesIterator.setParseMode(String parseModeString)
void	PipesIterator.setQueueSize(int queueSize)
void	PipesIterator.setWriteLimit(int writeLimit)

Uses of Field in org.apache.tika.pipes.pipesiterator.csv

Methods in org.apache.tika.pipes.pipesiterator.csv with annotations of type Field

Modifier and Type	Method and Description
void	CSVPipesIterator.setCsvPath(Path csvPath)
void	CSVPipesIterator.setCsvPath(String csvPath)
void	CSVPipesIterator.setEmitKeyColumn(String emitKeyColumn)
void	CSVPipesIterator.setFetchKeyColumn(String fetchKeyColumn)
void	CSVPipesIterator.setIdColumn(String idColumn)

Uses of Field in org.apache.tika.pipes.pipesiterator.filelist

Methods in org.apache.tika.pipes.pipesiterator.filelist with annotations of type Field

Modifier and Type	Method and Description
void	FileListPipesIterator.setFileList(String path)
void	FileListPipesIterator.setHasHeader(boolean hasHeader)

Uses of Field in org.apache.tika.pipes.pipesiterator.fs

Methods in org.apache.tika.pipes.pipesiterator.fs with annotations of type Field

Modifier and Type	Method and Description
void	FileSystemPipesIterator.setBasePath(String basePath)

Uses of Field in org.apache.tika.pipes.pipesiterator.gcs

Methods in org.apache.tika.pipes.pipesiterator.gcs with annotations of type Field

Modifier and Type	Method and Description
void	GCSPipesIterator.setBucket(String bucket)
void	GCSPipesIterator.setPrefix(String prefix)
void	GCSPipesIterator.setProjectId(String projectId)

Uses of Field in org.apache.tika.pipes.pipesiterator.jdbc

Methods in org.apache.tika.pipes.pipesiterator.jdbc with annotations of type Field

Modifier and Type	Method and Description
void	JDBCPipesIterator.setConnection(String connection)
void	JDBCPipesIterator.setEmitKeyColumn(String fetchKeyColumn)
void	JDBCPipesIterator.setFetchKeyColumn(String fetchKeyColumn)
void	JDBCPipesIterator.setIdColumn(String idColumn)
void	JDBCPipesIterator.setSelect(String select)

Uses of Field in org.apache.tika.pipes.pipesiterator.s3

Methods in org.apache.tika.pipes.pipesiterator.s3 with annotations of type Field

Modifier and Type	Method and Description
void	S3PipesIterator.setBucket(String bucket)
void	S3PipesIterator.setCredentialsProvider(String credentialsProvider)
void	S3PipesIterator.setPrefix(String prefix)
void	S3PipesIterator.setProfile(String profile)
void	S3PipesIterator.setRegion(String region)

Uses of Field in org.apache.tika.pipes.pipesiterator.solr

Methods in org.apache.tika.pipes.pipesiterator.solr with annotations of type Field

Modifier and Type	Method and Description
void	SolrPipesIterator.setAdditionalFields(List<String> additionalFields)
void	SolrPipesIterator.setAuthScheme(String authScheme)
void	SolrPipesIterator.setConnectionTimeout(int connectionTimeout)
void	SolrPipesIterator.setFailCountField(String failCountField)
void	SolrPipesIterator.setFilters(List<String> filters)
void	SolrPipesIterator.setIdField(String idField)
void	SolrPipesIterator.setParsingIdField(String parsingIdField)
void	SolrPipesIterator.setPassword(String password)
void	SolrPipesIterator.setProxyHost(String proxyHost)
void	SolrPipesIterator.setProxyPort(int proxyPort)
void	SolrPipesIterator.setRows(int rows)
void	SolrPipesIterator.setSizeFieldName(String sizeFieldName)
void	SolrPipesIterator.setSocketTimeout(int socketTimeout)
void	SolrPipesIterator.setSolrCollection(String solrCollection)
void	SolrPipesIterator.setSolrUrls(List<String> solrUrls)
void	SolrPipesIterator.setSolrZkChroot(String solrZkChroot)
void	SolrPipesIterator.setSolrZkHosts(List<String> solrZkHosts)
void	SolrPipesIterator.setUserName(String userName)