org.apache.tika.parser.jdbc

Class AbstractDBParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.jdbc.AbstractDBParser

All Implemented Interfaces:

Serializable, org.apache.tika.parser.Parser

public abstract class AbstractDBParser
extends org.apache.tika.parser.AbstractParser

Abstract class that handles iterating through tables within a database.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractDBParser()

Method Summary

Modifier and Type	Method and Description
protected void	close() Override this for any special handling of closing the connection.
protected Connection	getConnection(InputStream stream, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context) Override this for special configuration of the connection, such as limiting the number of rows to be held in memory.
protected abstract String	getConnectionString(InputStream stream, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext parseContext) Implement for db specific connection information, e.g.
protected abstract String	getJDBCClassName() JDBC class name, e.g.
Set<org.apache.tika.mime.MediaType>	getSupportedTypes(org.apache.tika.parser.ParseContext context)
protected abstract List<String>	getTableNames(Connection connection, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context) Returns the names of the tables to process
protected abstract JDBCTableReader	getTableReader(Connection connection, String tableName, org.apache.tika.extractor.EmbeddedDocumentUtil embeddedDocumentUtil) Given a connection and a table name, return the JDBCTableReader for this db.
protected abstract JDBCTableReader	getTableReader(Connection connection, String tableName, org.apache.tika.parser.ParseContext parseContext) Deprecated. use getTableReader(Connection, String, EmbeddedDocumentUtil)
void	parse(InputStream stream, ContentHandler handler, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext context)

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

parse

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDBParser

public AbstractDBParser()

Method Detail

getSupportedTypes

public Set<org.apache.tika.mime.MediaType> getSupportedTypes(org.apache.tika.parser.ParseContext context)

parse

public void parse(InputStream stream,
                  ContentHandler handler,
                  org.apache.tika.metadata.Metadata metadata,
                  org.apache.tika.parser.ParseContext context)
           throws IOException,
                  SAXException,
                  org.apache.tika.exception.TikaException

Throws:

IOException

SAXException

org.apache.tika.exception.TikaException

close

protected void close()
              throws SQLException,
                     IOException

Override this for any special handling of closing the connection.

Throws:

SQLException

IOException

getConnection

protected Connection getConnection(InputStream stream,
                                   org.apache.tika.metadata.Metadata metadata,
                                   org.apache.tika.parser.ParseContext context)
                            throws IOException,
                                   org.apache.tika.exception.TikaException

Override this for special configuration of the connection, such as limiting the number of rows to be held in memory.

Parameters:

stream - stream to use

metadata - metadata that could be used in parameterizing the connection

context - parsecontext that could be used in parameterizing the connection

Returns:

connection

Throws:

IOException

org.apache.tika.exception.TikaException

getConnectionString

protected abstract String getConnectionString(InputStream stream,
                                              org.apache.tika.metadata.Metadata metadata,
                                              org.apache.tika.parser.ParseContext parseContext)
                                       throws IOException

Implement for db specific connection information, e.g. "jdbc:sqlite:/docs/mydb.db"

Include any optimization settings, user name, password, etc.

Parameters:

stream - stream for processing

metadata - metadata might be useful in determining connection info

parseContext - context to use to help create connectionString

Returns:

connection string to be used by getConnection(java.io.InputStream, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext).

Throws:

IOException

getJDBCClassName

protected abstract String getJDBCClassName()

JDBC class name, e.g. org.sqlite.JDBC

Returns:

jdbc class name

getTableNames

protected abstract List<String> getTableNames(Connection connection,
                                              org.apache.tika.metadata.Metadata metadata,
                                              org.apache.tika.parser.ParseContext context)
                                       throws SQLException

Returns the names of the tables to process

Parameters:

connection - Connection to use to make the sql call(s) to get the names of the tables

metadata - Metadata to use (potentially) in decision about which tables to extract

context - ParseContext to use (potentially) in decision about which tables to extract

Returns:

Throws:

SQLException

getTableReader

@Deprecated
protected abstract JDBCTableReader getTableReader(Connection connection,
                                                              String tableName,
                                                              org.apache.tika.parser.ParseContext parseContext)

Deprecated. use getTableReader(Connection, String, EmbeddedDocumentUtil)

Given a connection and a table name, return the JDBCTableReader for this db.

Parameters:

connection -

tableName -

Returns:

a reader

getTableReader

protected abstract JDBCTableReader getTableReader(Connection connection,
                                                  String tableName,
                                                  org.apache.tika.extractor.EmbeddedDocumentUtil embeddedDocumentUtil)

Given a connection and a table name, return the JDBCTableReader for this db.

Parameters:

connection -

tableName -

embeddedDocumentUtil - embedded doc util

Returns: