Package org.apache.tika.pipes.reporters.jdbc

Class JDBCPipesReporter

java.lang.Object

org.apache.tika.pipes.PipesReporter

org.apache.tika.pipes.PipesReporterBase

org.apache.tika.pipes.reporters.jdbc.JDBCPipesReporter

All Implemented Interfaces:

Closeable, AutoCloseable, Initializable

public class JDBCPipesReporter
extends PipesReporterBase
implements Initializable

This is an initial draft of a JDBCPipesReporter. This will drop the tika_status table with each run. If you'd like different behavior, please open a ticket on our JIRA!

Field Summary

Fields

Modifier and Type	Field	Description
static String	TABLE_NAME

Fields inherited from class org.apache.tika.pipes.PipesReporter

NO_OP_REPORTER

Constructor Summary

Constructors

Constructor	Description
JDBCPipesReporter()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
void	close()	No-op implementation.
void	error(String msg)	This is called if the process has crashed.
void	error(Throwable t)	This is called if the process has crashed.
void	initialize(Map<String,Param> params)
void	report(FetchEmitTuple t, PipesResult result, long elapsed)
void	setCacheSize(int cacheSize)	Commit the reports if the cache is greater than or equal to this size.
void	setConnection(String connection)
void	setPostConnection(String postConnection)	This sql will be called immediately after the connection is made.
void	setReportWithinMs(long reportWithinMs)	Commit the reports if the amount of time elapsed since the last report commit exceeds this value.

Methods inherited from class org.apache.tika.pipes.PipesReporterBase

accept, setExcludes, setIncludes

Methods inherited from class org.apache.tika.pipes.PipesReporter

report, supportsTotalCount

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

Constructor Detail

JDBCPipesReporter

public JDBCPipesReporter()

Method Detail

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Specified by:

initialize in interface Initializable

Overrides:

initialize in class PipesReporterBase

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Overrides:

checkInitialization in class PipesReporterBase

Parameters:

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

Throws:

TikaConfigException

setConnection

@Field
public void setConnection(String connection)

setCacheSize

@Field
public void setCacheSize(int cacheSize)

Commit the reports if the cache is greater than or equal to this size.

Default is DEFAULT_CACHE_SIZE.

The reports will be committed if the cache size triggers reporting or if the amount of time since last reported (reportWithinMs) triggers reporting.

Parameters:

cacheSize -

setReportWithinMs

@Field
public void setReportWithinMs(long reportWithinMs)

Commit the reports if the amount of time elapsed since the last report commit exceeds this value.

Default is DEFAULT_REPORT_WITHIN_MS.

The reports will be committed if the cache size triggers reporting or if the amount of time since last reported triggers reporting.

Parameters:

reportWithinMs -

setPostConnection

@Field
public void setPostConnection(String postConnection)

This sql will be called immediately after the connection is made. This was initially added for setting pragmas on sqlite3, but may be used for other connection configuration in other dbs. Note: This is called before the table is created if it needs to be created.

Parameters:

postConnection -

report

public void report(FetchEmitTuple t,
                   PipesResult result,
                   long elapsed)

Specified by:

report in class PipesReporter

error

public void error(Throwable t)

Description copied from class: PipesReporter

This is called if the process has crashed. Implementers should not rely on close() to be called after this.

Specified by:

error in class PipesReporter

error

public void error(String msg)

Description copied from class: PipesReporter

This is called if the process has crashed. Implementers should not rely on close() to be called after this.

Specified by:

error in class PipesReporter

close

public void close()
           throws IOException

Description copied from class: PipesReporter

No-op implementation. Override for custom behavior

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class PipesReporter

Throws:

IOException