com.liferay.portlet.documentlibrary.util
Interface RawMetadataProcessor

All Known Implementing Classes:

RawMetadataProcessorImpl

public interface RawMetadataProcessor

Document library processor responsible for the generation of raw metadata associated with all of the the files stored in the document library.

This processor automatically and assynchronously extracts the metadata from all of the files stored in the document library. The metadata extraction is done with the help of TikaRawMetadataProcessor

Method Summary

void	cleanUp(FileEntry fileEntry)
void	cleanUp(FileVersion fileVersion)
void	generateMetadata(FileVersion fileVersion) Generates the raw metadata associated with the file entry.
boolean	isSupported(FileVersion fileVersion)
boolean	isSupported(String mimeType)
void	saveMetadata(FileVersion fileVersion) Saves the raw metadata present in the file version.
void	trigger(FileVersion fileVersion) Launches extraction of raw metadata from the file version.

Method Detail

cleanUp

void cleanUp(FileEntry fileEntry)

cleanUp

void cleanUp(FileVersion fileVersion)

generateMetadata

void generateMetadata(FileVersion fileVersion)
                      throws PortalException,
                             SystemException

Generates the raw metadata associated with the file entry.

Parameters:

fileVersion - the file version from which the raw metatada is to be generated

Throws:

PortalException - if an error occurred in the metadata extraction

SystemException - if a system exception occurred

isSupported

boolean isSupported(FileVersion fileVersion)

isSupported

boolean isSupported(String mimeType)

saveMetadata

void saveMetadata(FileVersion fileVersion)
                  throws PortalException,
                         SystemException

Saves the raw metadata present in the file version.

The raw metadata present in the file version is extracted and persisted using TikaRawMetadataProcessor.

Parameters:

fileVersion - the file version from which the raw metatada is to be extracted and persisted

Throws:

PortalException - if an error occurred in the metadata extraction

SystemException - if a system exception occurred

trigger

void trigger(FileVersion fileVersion)

Launches extraction of raw metadata from the file version.

The raw metadata extraction is done asynchronously.

Parameters:

fileVersion - the latest file version from which the raw metadata is to be generated