org.apache.tika.parser.recognition

Interface ObjectRecogniser

All Superinterfaces:

Initializable

All Known Implementing Classes:

TensorflowImageRecParser, TensorflowRESTRecogniser

public interface ObjectRecogniser
extends Initializable

This is a contract for object recognisers used by ObjectRecognitionParser

See Also:

TensorflowImageRecParser} for an example

Method Summary

Methods

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

Method Detail

getSupportedMimes

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(Map<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

List<RecognisedObject> recognise(InputStream stream,
                               ContentHandler handler,
                               Metadata metadata,
                               ParseContext context)
                                 throws IOException,
                                        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:

IOException - when an I/O error occurs

SAXException - when an issue with XML occurs

TikaException - any generic error