Package org.apache.tika.parser.recognition

Class ObjectRecognitionParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.recognition.ObjectRecognitionParser

All Implemented Interfaces:

java.io.Serializable, Initializable, Parser

public class ObjectRecognitionParser
extends AbstractParser
implements Initializable

This parser recognises objects from Images. The Object Recognition implementation can be switched using 'class' argument.

Example Usage :

 <properties>
  <parsers>
   <parser class="org.apache.tika.parser.recognition.ObjectRecognitionParser">
    <params>
      <param name="class" type="string">org.apache.tika.parser.recognition.tf.TensorflowRESTRecogniser</param>
      <param name="class" type="string">org.apache.tika.parser.captioning.tf.TensorflowRESTCaptioner</param>
    </params>
   </parser>
  </parsers>
 </properties>
 

Since:

Apache Tika 1.14

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MD_KEY_IMG_CAP
static java.lang.String	MD_KEY_OBJ_REC
static java.lang.String	MD_REC_IMPL_KEY

Constructor Summary

Constructors

Constructor	Description
ObjectRecognitionParser()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler handler)
java.util.Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	initialize(java.util.Map<java.lang.String,Param> params)
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.
void	setRecogniser(java.lang.String recogniserClass)

Methods inherited from class org.apache.tika.parser.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Field Detail

MD_KEY_OBJ_REC

public static final java.lang.String MD_KEY_OBJ_REC

See Also:

Constant Field Values

MD_KEY_IMG_CAP

public static final java.lang.String MD_KEY_IMG_CAP

See Also:

Constant Field Values

MD_REC_IMPL_KEY

public static final java.lang.String MD_REC_IMPL_KEY

Constructor Detail

ObjectRecognitionParser

public ObjectRecognitionParser()

Method Detail

setRecogniser

@Field(name="class")
public void setRecogniser(java.lang.String recogniserClass)

initialize

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

Specified by:

initialize in interface Initializable

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler handler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

handler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException

getSupportedTypes

public java.util.Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

Parameters:

stream - the document stream (input)

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

java.io.IOException - if the document stream could not be read

org.xml.sax.SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed