org.apache.solr.handler.dataimport
Class MailEntityProcessor

java.lang.Object
  org.apache.solr.handler.dataimport.EntityProcessor
      org.apache.solr.handler.dataimport.EntityProcessorBase
          org.apache.solr.handler.dataimport.MailEntityProcessor

public class MailEntityProcessor
extends EntityProcessorBase

An EntityProcessor instance which can index emails along with their attachments from POP3 or IMAP sources. Refer to http://wiki.apache.org/solr/DataImportHandler for more details. This API is experimental and subject to change

Since:

solr 1.4

Nested Class Summary

static interface

MailEntityProcessor.CustomFilter

Field Summary

Fields inherited from class org.apache.solr.handler.dataimport.EntityProcessorBase

ABORT, cacheSupport, context, CONTINUE, entityName, isFirstInit, ON_ERROR, onError, query, rowIterator, SKIP, SKIP_DOC, TRANSFORM_ROW, TRANSFORMER

Constructor Summary

MailEntityProcessor()

Method Summary

void	addPartToDocument(javax.mail.Part part, Map<String,Object> row, boolean outerMost)
void	init(Context context) This method is called when it starts processing an entity.
Map<String,Object>	nextRow() For a simple implementation, this is the only method that the sub-class should implement.

Methods inherited from class org.apache.solr.handler.dataimport.EntityProcessorBase

destroy, firstInit, getNext, initCache, nextDeletedRowKey, nextModifiedParentRowKey, nextModifiedRowKey

Methods inherited from class org.apache.solr.handler.dataimport.EntityProcessor

close, postTransform

Methods inherited from class java.lang.Object

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

Constructor Detail

MailEntityProcessor

public MailEntityProcessor()

Method Detail

init

public void init(Context context)

Description copied from class: EntityProcessor

This method is called when it starts processing an entity. When it comes back to the entity it is called again. So it can reset anything at that point. For a rootmost entity this is called only once for an ingestion. For sub-entities , this is called multiple once for each row from its parent entity

Overrides:

init in class EntityProcessorBase

Parameters:

context - The current context

nextRow

public Map<String,Object> nextRow()

Description copied from class: EntityProcessorBase

For a simple implementation, this is the only method that the sub-class should implement. This is intended to stream rows one-by-one. Return null to signal end of rows

Overrides:

nextRow in class EntityProcessorBase

Returns:

a row where the key is the name of the field and value can be any Object or a Collection of objects. Return null to signal end of rows

addPartToDocument

public void addPartToDocument(javax.mail.Part part,
                              Map<String,Object> row,
                              boolean outerMost)
                       throws Exception

Throws:

Exception