org.eclipse.smila.importing.compounds.compress

Class CommonsCompressCompoundExtractorService

java.lang.Object

org.eclipse.smila.importing.compounds.compress.CommonsCompressCompoundExtractorService

All Implemented Interfaces:

CompoundExtractor

public class CommonsCompressCompoundExtractorService
extends java.lang.Object
implements CompoundExtractor

Extractor service using commons compress.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.charset.Charset	_charset encoding.
protected static java.lang.String	APPLICATION_OCTETSTREAM mime type that can mean almost anything and therefore will be ommitted.
protected static java.lang.String	APPLICATION_ZIP mime type for ZIP.
protected static java.util.Map<java.lang.String,java.lang.String>	ARCHIVE_IDENTIFIERS map from mime type to archive stream factory identifier.
protected static java.util.Map<java.lang.String,java.lang.String>	COMPRESSION_IDENTIFIERS map from mime type to compressor stream factory identifier.
protected static java.nio.charset.Charset	DEFAULT_CHARSET the default encoding.
protected static java.lang.String	KEY_TMP_FILE_NAME key for temporary file name.
protected static java.lang.String	SUFFIX_TAR constant for "tar" suffix.
protected static java.lang.String	SUFFIX_TGZ constant for "tgz" suffix.

Fields inherited from interface org.eclipse.smila.importing.compounds.CompoundExtractor

KEY_COMMENT, KEY_COMPOUNDS, KEY_COMPRESSED_SIZE, KEY_FILE_NAME, KEY_IS_COMPOUND, KEY_IS_ROOT_COMPOUND_RECORD, KEY_SIZE, KEY_TIME

Constructor Summary

Constructors

Constructor and Description
CommonsCompressCompoundExtractorService()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate() service activation.
boolean	canExtract(java.io.File file) Can the file be extracted by the CompoundExtractor service?
boolean	canExtract(java.lang.String fileName, java.lang.String mimeType) Can the file be extracted by the CompoundExtractor service?
boolean	canExtract(java.net.URL url, java.lang.String mimeType) Can the file be extracted by the CompoundExtractor service?
protected void	deactivate() service deactivation.
java.util.Iterator<Record>	extract(java.io.InputStream compoundInputStream, java.lang.String fileName, java.lang.String contentAttachmentName) Extract the compounds (recursively) and return an iterator over the resulting records that have been created from the extracted compound.
java.util.Iterator<Record>	extract(java.io.InputStream compoundInputStream, java.lang.String fileName, java.lang.String mimeType, java.lang.String contentAttachmentName) Extract the compounds (recursively) and return an iterator over the resulting records that have been created from the extracted compound.
void	setMimeTypeIdentifier(MimeTypeIdentifier mimeTypeIdentifier) DS service reference injection method.
void	unsetMimeTypeIdentifier(MimeTypeIdentifier mimeTypeIdentifier) DS service reference injection method.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

protected static final java.nio.charset.Charset DEFAULT_CHARSET

the default encoding.

APPLICATION_OCTETSTREAM

protected static final java.lang.String APPLICATION_OCTETSTREAM

mime type that can mean almost anything and therefore will be ommitted.

See Also:

Constant Field Values

SUFFIX_TAR

protected static final java.lang.String SUFFIX_TAR

constant for "tar" suffix.

See Also:

Constant Field Values

SUFFIX_TGZ

protected static final java.lang.String SUFFIX_TGZ

constant for "tgz" suffix.

See Also:

Constant Field Values

APPLICATION_ZIP

protected static final java.lang.String APPLICATION_ZIP

mime type for ZIP. Zips must be handles specifically because of encoding issues.

See Also:

Constant Field Values

COMPRESSION_IDENTIFIERS

protected static final java.util.Map<java.lang.String,java.lang.String> COMPRESSION_IDENTIFIERS

map from mime type to compressor stream factory identifier.

ARCHIVE_IDENTIFIERS

protected static final java.util.Map<java.lang.String,java.lang.String> ARCHIVE_IDENTIFIERS

map from mime type to archive stream factory identifier.

KEY_TMP_FILE_NAME

protected static final java.lang.String KEY_TMP_FILE_NAME

key for temporary file name.

See Also:

Constant Field Values

_charset

protected java.nio.charset.Charset _charset

encoding.

Constructor Detail

CommonsCompressCompoundExtractorService

public CommonsCompressCompoundExtractorService()

Method Detail

activate

protected void activate()

service activation.

deactivate

protected void deactivate()

service deactivation.

canExtract

public boolean canExtract(java.io.File file)

Can the file be extracted by the CompoundExtractor service? The service may or may not invest the file more closely or may simply guess by the file extension. So a true result does not guarantee, that the file may be extracted without any exceptions.

Specified by:

canExtract in interface CompoundExtractor

Parameters:

file - the file in question.

Returns:

true if the given file can be extracted, false if not.

canExtract

public boolean canExtract(java.net.URL url,
                 java.lang.String mimeType)

Can the file be extracted by the CompoundExtractor service? The service may or may not invest the file more closely or may simply guess by the given mime type and the file extension. So a true result does not guarantee, that the file may be extracted without any exceptions.

Specified by:

canExtract in interface CompoundExtractor

Parameters:

url - URL in question

mimeType - mimetype (if any could be determined)

Returns:

canExtract

public boolean canExtract(java.lang.String fileName,
                 java.lang.String mimeType)

Can the file be extracted by the CompoundExtractor service? The service may or may not invest the file more closely or may simply guess by the given mime type and the file extension. So a true result does not guarantee, that the file may be extracted without any exceptions.

Specified by:

canExtract in interface CompoundExtractor

Parameters:

fileName - the name of the file in question.

mimeType - mimetype (if any could be determined)

Returns:

extract

public java.util.Iterator<Record> extract(java.io.InputStream compoundInputStream,
                                 java.lang.String fileName,
                                 java.lang.String contentAttachmentName)
                                   throws CompoundExtractorException

Extract the compounds (recursively) and return an iterator over the resulting records that have been created from the extracted compound. The Extractor should also return a Record for the compound itself, also if the content of that record might be empty.

Specified by:

extract in interface CompoundExtractor

Parameters:

compoundInputStream - the input stream of the compound object.

fileName - the name of the file in question.

contentAttachmentName - name of attachment to store content of extracted elements in.

Returns:

an iterator for the records that resulted from the entries included in the compound along with their content. The Iterator must not be null but empty if there are no records to be extracted.

Throws:

CompoundExtractorException - on errors while extracting the compound.

extract

public java.util.Iterator<Record> extract(java.io.InputStream compoundInputStream,
                                 java.lang.String fileName,
                                 java.lang.String mimeType,
                                 java.lang.String contentAttachmentName)
                                   throws CompoundExtractorException

Extract the compounds (recursively) and return an iterator over the resulting records that have been created from the extracted compound. The Extractor should also return a Record for the compound itself, also if the content of that record might be empty.

Specified by:

extract in interface CompoundExtractor

Parameters:

compoundInputStream - the input stream of the compound object.

fileName - the name of the file in question.

mimeType - mimetype (if any could be determined)

contentAttachmentName - name of attachment to store content of extracted elements in.

Returns:

an iterator for the records that resulted from the entries included in the compound along with their content. The Iterator must not be null but empty if there are no records to be extracted.

Throws:

CompoundExtractorException - on errors while extracting the compound.

setMimeTypeIdentifier

public void setMimeTypeIdentifier(MimeTypeIdentifier mimeTypeIdentifier)

DS service reference injection method.

unsetMimeTypeIdentifier

public void unsetMimeTypeIdentifier(MimeTypeIdentifier mimeTypeIdentifier)

DS service reference injection method.