Package org.apache.tika.detect

Class TrainedModelDetector

java.lang.Object

org.apache.tika.detect.TrainedModelDetector

All Implemented Interfaces:

Serializable, Detector

Direct Known Subclasses:

NNExampleModelDetector

public abstract class TrainedModelDetector
extends Object
implements Detector

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TrainedModelDetector()

Method Summary

Modifier and Type	Method	Description
MediaType	detect(InputStream input, Metadata metadata)	Detects the content type of the given input document.
int	getMinLength()
void	loadDefaultModels(File modelFile)
abstract void	loadDefaultModels(InputStream modelStream)
abstract void	loadDefaultModels(ClassLoader classLoader)
void	loadDefaultModels(Path modelFile)
protected float[]	readByteFrequencies(InputStream input)	Read the inputstream and build a byte frequency histogram
protected void	registerModels(MediaType type, TrainedModel model)

Methods inherited from class java.lang.Object

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

Constructor Detail

TrainedModelDetector

public TrainedModelDetector()

Method Detail

getMinLength

public int getMinLength()

detect

public MediaType detect(InputStream input,
                        Metadata metadata)
                 throws IOException

Description copied from interface: Detector

Detects the content type of the given input document. Returns application/octet-stream if the type of the document can not be detected.

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 type 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 Detector

Parameters:

input - document input stream, or null

metadata - input metadata for the document

Returns:

detected media type, or application/octet-stream

Throws:

IOException - if the document input stream could not be read

readByteFrequencies

protected float[] readByteFrequencies(InputStream input)
                               throws IOException

Read the inputstream and build a byte frequency histogram

Parameters:

input - stream to read from

Returns:

byte frequencies array

Throws:

IOException

loadDefaultModels

public void loadDefaultModels(Path modelFile)

loadDefaultModels

public void loadDefaultModels(File modelFile)

loadDefaultModels

public abstract void loadDefaultModels(InputStream modelStream)

loadDefaultModels

public abstract void loadDefaultModels(ClassLoader classLoader)

registerModels

protected void registerModels(MediaType type,
                              TrainedModel model)