org.apache.tika.parser.recognition

Interface ObjectRecogniser

All Superinterfaces:

Initializable

All Known Implementing Classes:

TensorflowImageRecParser, TensorflowRESTCaptioner, TensorflowRESTRecogniser, TensorflowRESTVideoRecogniser

public interface ObjectRecogniser
extends Initializable

This is a contract for object recognisers used by ObjectRecognitionParser

See Also:

TensorflowImageRecParser

Method Summary

Modifier and Type	Method and Description
java.util.Set<MediaType>	getSupportedMimes() The mimes supported by this recogniser
void	initialize(java.util.Map<java.lang.String,Param> params) This is the hook for configuring the recogniser
boolean	isAvailable() Is this service available
java.util.List<? extends RecognisedObject>	recognise(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context) Recognise the objects in the stream

Methods inherited from interface org.apache.tika.config.Initializable

checkInitialization

Method Detail

getSupportedMimes

java.util.Set<MediaType> getSupportedMimes()

The mimes supported by this recogniser

Returns:

set of mediatypes

isAvailable

boolean isAvailable()

Is this service available

Returns:

true when the service is available, false otherwise

initialize

void initialize(java.util.Map<java.lang.String,Param> params)
         throws TikaConfigException

This is the hook for configuring the recogniser

Specified by:

initialize in interface Initializable

Parameters:

params - configuration instance in the form of context

Throws:

TikaConfigException - when there is an issue with configuration

recognise

java.util.List<? extends RecognisedObject> recognise(java.io.InputStream stream,
                                                     org.xml.sax.ContentHandler handler,
                                                     Metadata metadata,
                                                     ParseContext context)
                                              throws java.io.IOException,
                                                     org.xml.sax.SAXException,
                                                     TikaException

Recognise the objects in the stream

Parameters:

stream - content stream

handler - tika's content handler

metadata - metadata instance

context - parser context

Returns:

List of RecognisedObjects

Throws:

java.io.IOException - when an I/O error occurs

org.xml.sax.SAXException - when an issue with XML occurs

TikaException - any generic error