Package org.apache.tika.detect

Class CompositeEncodingDetector

java.lang.Object

org.apache.tika.detect.CompositeEncodingDetector

All Implemented Interfaces:

Serializable, SelfConfiguring, EncodingDetector

Direct Known Subclasses:

DefaultEncodingDetector

public class CompositeEncodingDetector
extends Object
implements EncodingDetector, Serializable

A composite encoding detector that runs child detectors.

If a MetaEncodingDetector is among the children, this composite switches from first-match-wins to collect-all mode: all base detectors run first and their results are collected in an EncodingDetectorContext, then the meta detector runs last to arbitrate. Only one meta detector is supported.

If no meta detector is present, the first non-empty result wins (traditional behavior).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CompositeEncodingDetector(List<EncodingDetector> detectors)
CompositeEncodingDetector(List<EncodingDetector> detectors, Collection<Class<? extends EncodingDetector>> excludeEncodingDetectors)

Method Summary

Modifier and Type	Method	Description
List<EncodingResult>	detect(TikaInputStream tis, Metadata metadata, ParseContext parseContext)	Detects the character encoding of the given text document.
List<EncodingDetector>	getDetectors()

Methods inherited from class java.lang.Object

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

Constructor Details

CompositeEncodingDetector

public CompositeEncodingDetector(List<EncodingDetector> detectors,
 Collection<Class<? extends EncodingDetector>> excludeEncodingDetectors)

CompositeEncodingDetector

public CompositeEncodingDetector(List<EncodingDetector> detectors)

Method Details

detect

public List<EncodingResult> detect(TikaInputStream tis,
 Metadata metadata,
 ParseContext parseContext)
                            throws IOException

Description copied from interface: EncodingDetector

Detects the character encoding of the given text document.

Returns an empty list if the encoding cannot be determined. Returns a ranked list of candidates in descending confidence order otherwise. The first entry is always the best guess.

If the document input stream is not available, then the first argument may be null. Otherwise the detector may read bytes from the start of the stream to help in encoding detection. The given stream is guaranteed to support the mark feature and the detector is expected to mark the stream before reading any bytes from it, and to reset the stream before returning. The stream must not be closed by the detector.

The given input metadata is only read, not modified, by the detector.

Specified by:

detect in interface EncodingDetector

Parameters:

tis - text document input stream, or null

metadata - input metadata for the document

parseContext - the parse context

Returns:

ranked list of encoding results, empty if unknown; never null

Throws:

IOException - if the document input stream could not be read

getDetectors

public List<EncodingDetector> getDetectors()