com.exalead.indexing.analysis.v10

Class MIMEDetector

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MIMEDetector

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class MIMEDetector
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

The MIME detector operates on each DocumentPart for which a MIME-type is not available.
The MIME-type can be specified for each DocumentPart in the PAPI.
For DocumentPart, the 'bytes' and the 'filename' are used to guess the real MIME-type and charset.
The guessed MIME-type and the charset are then set as attributes of the DocumentPart.
Input: The DocumentPart of the document.
Output: 'mime' and 'encodingToUse' attributes of DocumentParts.
This document processor does not create any document chunks.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	defaultCharset
java.lang.String	defaultValue

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
MIMEDetector()
MIMEDetector(MIMEDetector o) Copy constructor
MIMEDetector(java.lang.String defaultCharset)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this MIMEDetector.
static MIMEDetector	fromString(java.lang.String s) String representation of this MIMEDetector.
java.lang.String	getDefaultCharset() On text or HTML files, the MIME detector tries to detect charset encoding automatically. If the encoding cannot be detected, this 'defaultCharset' is used.
java.lang.String	getDefaultValue() Default mime to use if not detected.
MIMEDetector	makeCopy() Creates and returns a deep copy of this MIMEDetector.
static MIMEDetector	readFrom(java.io.InputStream is) Read this MIMEDetector from an XML fragment.
void	setDefaultCharset(java.lang.String defaultCharset) On text or HTML files, the MIME detector tries to detect charset encoding automatically. If the encoding cannot be detected, this 'defaultCharset' is used.
void	setDefaultValue(java.lang.String defaultValue) Default mime to use if not detected.
java.lang.String	toString() String representation of this MIMEDetector.
MIMEDetector	withAcceptCondition(AcceptCondition acceptCondition)
MIMEDetector	withDataModelClass(java.lang.String dataModelClass)
MIMEDetector	withDataModelProperty(java.lang.String dataModelProperty)
MIMEDetector	withDataModelState(java.lang.String dataModelState)
MIMEDetector	withDefaultCharset(java.lang.String defaultCharset)
MIMEDetector	withDefaultValue(java.lang.String defaultValue)
MIMEDetector	withDisabled(boolean disabled)
MIMEDetector	withDisabled(java.lang.Boolean disabled)
MIMEDetector	withFromDataModel(DocumentProcessor fromDataModel)
MIMEDetector	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this MIMEDetector as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

defaultValue

public java.lang.String defaultValue

defaultCharset

public java.lang.String defaultCharset

Constructor Detail

MIMEDetector

public MIMEDetector()

MIMEDetector

public MIMEDetector(java.lang.String defaultCharset)

MIMEDetector

public MIMEDetector(MIMEDetector o)

Copy constructor

Method Detail

withAcceptCondition

public MIMEDetector withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public MIMEDetector withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public MIMEDetector withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public MIMEDetector withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public MIMEDetector withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public MIMEDetector withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public MIMEDetector withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public MIMEDetector withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Default mime to use if not detected.

getDefaultValue

public java.lang.String getDefaultValue()

Default mime to use if not detected.

withDefaultValue

public MIMEDetector withDefaultValue(java.lang.String defaultValue)

setDefaultCharset

public void setDefaultCharset(java.lang.String defaultCharset)

On text or HTML files, the MIME detector tries to detect charset encoding automatically.
If the encoding cannot be detected, this 'defaultCharset' is used.

getDefaultCharset

public java.lang.String getDefaultCharset()

On text or HTML files, the MIME detector tries to detect charset encoding automatically.
If the encoding cannot be detected, this 'defaultCharset' is used.

withDefaultCharset

public MIMEDetector withDefaultCharset(java.lang.String defaultCharset)

makeCopy

public MIMEDetector makeCopy()

Creates and returns a deep copy of this MIMEDetector.

Overrides:

makeCopy in class DocumentProcessor

readFrom

public static MIMEDetector readFrom(java.io.InputStream is)
                             throws javax.xml.bind.JAXBException

Read this MIMEDetector from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this MIMEDetector as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static MIMEDetector fromString(java.lang.String s)
                               throws javax.xml.bind.JAXBException,
                                      java.io.UnsupportedEncodingException

String representation of this MIMEDetector.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MIMEDetector.

Overrides:

toString in class DocumentProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this MIMEDetector.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException