Package org.apache.tika.pipes.emitter.opensearch

Class OpenSearchEmitter

java.lang.Object

org.apache.tika.pipes.emitter.AbstractEmitter

org.apache.tika.pipes.emitter.opensearch.OpenSearchEmitter

All Implemented Interfaces:

Initializable, Emitter

public class OpenSearchEmitter
extends AbstractEmitter
implements Initializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenSearchEmitter.AttachmentStrategy
static enum	OpenSearchEmitter.UpdateStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_EMBEDDED_FILE_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
OpenSearchEmitter()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
void	emit(String emitKey, List<Metadata> metadataList)
void	emit(List<? extends EmitData> emitData)	The default behavior is to call Emitter.emit(String, List) on each item.
int	getCommitWithin()
void	initialize(Map<String,Param> params)
void	setAttachmentStrategy(String attachmentStrategy)	Options: SEPARATE_DOCUMENTS, PARENT_CHILD.
void	setAuthScheme(String authScheme)
void	setCommitWithin(int commitWithin)
void	setConnectionTimeout(int connectionTimeout)
void	setEmbeddedFileFieldName(String embeddedFileFieldName)	If using the OpenSearchEmitter.AttachmentStrategy.PARENT_CHILD, this is the field name used to store the child documents.
void	setIdField(String idField)	Specify the field in the first Metadata that should be used as the id field for the document.
void	setOpenSearchUrl(String openSearchUrl)
void	setPassword(String password)
void	setProxyHost(String proxyHost)
void	setProxyPort(int proxyPort)
void	setSocketTimeout(int socketTimeout)
void	setUpdateStrategy(String strategy)
void	setUpdateStrategy(OpenSearchEmitter.UpdateStrategy updateStrategy)
void	setUserName(String userName)

Methods inherited from class org.apache.tika.pipes.emitter.AbstractEmitter

getName, setName

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EMBEDDED_FILE_FIELD_NAME

public static String DEFAULT_EMBEDDED_FILE_FIELD_NAME

Constructor Details

OpenSearchEmitter

public OpenSearchEmitter()
                  throws TikaConfigException

Throws:

TikaConfigException

Method Details

emit

public void emit(List<? extends EmitData> emitData)
          throws IOException,
TikaEmitterException

Description copied from class: AbstractEmitter

The default behavior is to call Emitter.emit(String, List) on each item. Some implementations, e.g. Solr/ES/vespa, can benefit from subclassing this and emitting a bunch of docs at once.

Specified by:

emit in interface Emitter

Overrides:

emit in class AbstractEmitter

Throws:

IOException

TikaEmitterException

emit

public void emit(String emitKey,
 List<Metadata> metadataList)
          throws IOException,
TikaEmitterException

Specified by:

emit in interface Emitter

Throws:

IOException

TikaEmitterException

setAttachmentStrategy

@Field
public void setAttachmentStrategy(String attachmentStrategy)

Options: SEPARATE_DOCUMENTS, PARENT_CHILD. Default is "SEPARATE_DOCUMENTS". All embedded documents are treated as independent documents. PARENT_CHILD requires a schema to be set up for the relationship type; all embedded objects (no matter how deeply nested) will have a single parent of the main container document. If you want to concatenate the content of embedded files and ignore the metadata of embedded files, set HandlerConfig's parseMode to HandlerConfig.PARSE_MODE.CONCATENATE in your FetchEmitTuple or in the <parseMode> element in your PipesIterator configuration.

setConnectionTimeout

@Field
public void setConnectionTimeout(int connectionTimeout)

setSocketTimeout

@Field
public void setSocketTimeout(int socketTimeout)

getCommitWithin

public int getCommitWithin()

setCommitWithin

@Field
public void setCommitWithin(int commitWithin)

setIdField

@Field
public void setIdField(String idField)

Specify the field in the first Metadata that should be used as the id field for the document.

Parameters:

idField -

setOpenSearchUrl

@Field
public void setOpenSearchUrl(String openSearchUrl)

setUserName

@Field
public void setUserName(String userName)

setPassword

@Field
public void setPassword(String password)

setAuthScheme

@Field
public void setAuthScheme(String authScheme)

setProxyHost

@Field
public void setProxyHost(String proxyHost)

setProxyPort

@Field
public void setProxyPort(int proxyPort)

setUpdateStrategy

public void setUpdateStrategy(OpenSearchEmitter.UpdateStrategy updateStrategy)

setUpdateStrategy

public void setUpdateStrategy(String strategy)
                       throws TikaConfigException

Throws:

TikaConfigException

setEmbeddedFileFieldName

@Field
public void setEmbeddedFileFieldName(String embeddedFileFieldName)

If using the OpenSearchEmitter.AttachmentStrategy.PARENT_CHILD, this is the field name used to store the child documents. Note that we artificially flatten all embedded documents, no matter how nested in the container document, into direct children of the root document.

Parameters:

embeddedFileFieldName -

initialize

public void initialize(Map<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 problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

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

Throws:

TikaConfigException