ddf.catalog.transformer.input.tika

Class TikaInputTransformer

java.lang.Object

ddf.catalog.transformer.input.tika.TikaInputTransformer

All Implemented Interfaces:

InputTransformer

public class TikaInputTransformer
extends Object
implements InputTransformer

Constructor Summary

Constructors

Constructor and Description
TikaInputTransformer(org.osgi.framework.BundleContext bundleContext, MetacardType metacardType)

Method Summary

Modifier and Type	Method and Description
void	addContentMetadataExtractor(org.osgi.framework.ServiceReference<ContentMetadataExtractor> contentMetadataExtractorRef)
void	addMetadataExtractor(org.osgi.framework.ServiceReference<MetadataExtractor> metadataExtractorRef)
protected void	enrichMetacard(TemporaryFileBackedOutputStream fileBackedOutputStream, String metacardContentType, long bytes, Metacard metacard)
Optional<MetacardType>	getMetacardTypeFromMimeType(String mimeType) Determines which MetacardType should be used to create a metacard for an input file of a given mime type
int	getPreviewMaxLength()
protected MetacardType	mergeAttributes(MetacardType metacardType)
void	populateMimeTypeMap() Populates the mimeTypeToMetacardMap for use in determining the MetacardType that corresponds to an ingested product's mimeType.
void	removeContentMetadataExtractor(org.osgi.framework.ServiceReference<ContentMetadataExtractor> contentMetadataExtractorRef)
void	removeMetadataExtractor(org.osgi.framework.ServiceReference<MetadataExtractor> metadataExtractorRef)
void	setCommonTikaMetacardType(MetacardType metacardType)
void	setFallbackExcelMetacardType(MetacardType metacardType)
void	setFallbackJpegMetacardType(MetacardType metacardType)
void	setFallbackMp4MetacardType(MetacardType metacardType)
void	setFallbackMpegMetacardType(MetacardType metacardType)
void	setFallbackOfficeDocMetacardType(MetacardType metacardType)
void	setFallbackPdfMetacardType(MetacardType metacardType)
void	setFallbackPowerpointMetacardType(MetacardType metacardType)
void	setMetadataMaxLength(int metadataMaxLength)
void	setPreviewMaxLength(int previewMaxLength)
void	setUseResourceTitleAsTitle(Boolean useResourceTitleAsTitle)
Metacard	transform(InputStream input) Transforms the input into a Metacard.
Metacard	transform(InputStream input, String id) Transforms the input into a Metacard and associates the id with the Metacard on creation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TikaInputTransformer

public TikaInputTransformer(org.osgi.framework.BundleContext bundleContext,
                            MetacardType metacardType)

Method Detail

getPreviewMaxLength

public int getPreviewMaxLength()

setPreviewMaxLength

public void setPreviewMaxLength(int previewMaxLength)

setMetadataMaxLength

public void setMetadataMaxLength(int metadataMaxLength)

setCommonTikaMetacardType

public void setCommonTikaMetacardType(MetacardType metacardType)

setFallbackExcelMetacardType

public void setFallbackExcelMetacardType(MetacardType metacardType)

setFallbackJpegMetacardType

public void setFallbackJpegMetacardType(MetacardType metacardType)

setFallbackMp4MetacardType

public void setFallbackMp4MetacardType(MetacardType metacardType)

setFallbackMpegMetacardType

public void setFallbackMpegMetacardType(MetacardType metacardType)

setFallbackOfficeDocMetacardType

public void setFallbackOfficeDocMetacardType(MetacardType metacardType)

setFallbackPdfMetacardType

public void setFallbackPdfMetacardType(MetacardType metacardType)

setFallbackPowerpointMetacardType

public void setFallbackPowerpointMetacardType(MetacardType metacardType)

populateMimeTypeMap

public void populateMimeTypeMap()

Populates the mimeTypeToMetacardMap for use in determining the MetacardType that corresponds to an ingested product's mimeType.

getMetacardTypeFromMimeType

public Optional<MetacardType> getMetacardTypeFromMimeType(String mimeType)

Determines which MetacardType should be used to create a metacard for an input file of a given mime type

Parameters:

mimeType - the String representing the mime type of the file

Returns:

a Optional of MetacardType that should be used to create a Metacard for the given mimeType. Returns empty Optional if no MetacardType matched the given mime type.

transform

public Metacard transform(InputStream input)
                   throws IOException,
                          CatalogTransformerException

Description copied from interface: InputTransformer

Transforms the input into a Metacard.

Specified by:

transform in interface InputTransformer

Parameters:

input - the binary InputStream to transform

Returns:

the generated Metacard

Throws:

IOException - if an I/O exception occurs when reading the InputStream

CatalogTransformerException - if an error occurs during transformation

transform

public Metacard transform(InputStream input,
                          String id)
                   throws IOException,
                          CatalogTransformerException

Description copied from interface: InputTransformer

Transforms the input into a Metacard and associates the id with the Metacard on creation.

Specified by:

transform in interface InputTransformer

Parameters:

input - the binary InputStream to transform

id - the attribute value for the Metacard.ID attribute that should be set in the generated Metacard

Returns:

the generated Metacard

Throws:

IOException - if an I/O exception occurs when reading the InputStream

CatalogTransformerException - if an error occurs during transformation

addContentMetadataExtractor

public void addContentMetadataExtractor(org.osgi.framework.ServiceReference<ContentMetadataExtractor> contentMetadataExtractorRef)

addMetadataExtractor

public void addMetadataExtractor(org.osgi.framework.ServiceReference<MetadataExtractor> metadataExtractorRef)

removeContentMetadataExtractor

public void removeContentMetadataExtractor(org.osgi.framework.ServiceReference<ContentMetadataExtractor> contentMetadataExtractorRef)

removeMetadataExtractor

public void removeMetadataExtractor(org.osgi.framework.ServiceReference<MetadataExtractor> metadataExtractorRef)

setUseResourceTitleAsTitle

public void setUseResourceTitleAsTitle(Boolean useResourceTitleAsTitle)

Parameters:

useResourceTitleAsTitle - must be non-null

mergeAttributes

protected MetacardType mergeAttributes(MetacardType metacardType)

enrichMetacard

protected void enrichMetacard(TemporaryFileBackedOutputStream fileBackedOutputStream,
                              String metacardContentType,
                              long bytes,
                              Metacard metacard)
                       throws IOException

Throws:

IOException