com.exalead.papi.framework.operations.container

Class ContainerRecursiveProcessor.ContainerHelper

java.lang.Object

com.exalead.papi.framework.connectors.container.ConnectorContainerHelper

com.exalead.papi.framework.operations.container.ContainerRecursiveProcessor.ContainerHelper

All Implemented Interfaces:

ConnectorInterface

Enclosing class:

ContainerRecursiveProcessor<SKey extends Key>

protected class ContainerRecursiveProcessor.ContainerHelper
extends ConnectorContainerHelper

Our ConnectorContainerHelper version, allowing to handle filtering and interactions between parent and child.

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.papi.framework.connectors.container.ConnectorContainerHelper

ConnectorContainerHelper.ContainerConnectorTarget, ConnectorContainerHelper.ContainerPushAPI, ConnectorContainerHelper.IsContainerInterface, ConnectorContainerHelper.NotFoundException, ConnectorContainerHelper.PushAPIHelper

Field Summary

Fields inherited from class com.exalead.papi.framework.connectors.container.ConnectorContainerHelper

connector, convertAddress, CONVERTED_MASTER_PART, indexNames, logger, STATUS_FRESH, STATUS_NEW, STATUS_UPDATE, timeoutMs

Constructor Summary

Constructors

Constructor and Description
ContainerHelper(ConnectorContainerHelper.ContainerConnectorTarget parent, java.lang.String convertAddress)

Method Summary

Modifier and Type	Method and Description
Document	buildDocument(java.lang.String uri, java.lang.String stamp, PartContainer partContainer, MetaContainer metaContainer) Build a Document.
protected boolean	filterItem(com.exalead.container.ContainerItem item, boolean isContainer) Filter container or item
protected Part	getMainPart(ConnectorRootStream co)
protected ContainerMainPartInfos	getMainPartInfo(ConnectorRootStream co, com.exalead.container.ContainerItem item)
protected Part	getMainPartInternal(ConnectorRootStream co)

Methods inherited from class com.exalead.papi.framework.connectors.container.ConnectorContainerHelper

checkAbortingOperation, fetch, fetch, getCollectionHelper, getDocumentSecurityTokens, getFirstPart, getMime, getRootItem, getTimeoutMs, isAvailable, isIndexNames, log, log, onScanAborted, onScanResumed, onScanSuspended, process, safeClose, scan, selfAbortScan, setConvertAddress, setIndexNames, setTimeoutMs, updateEnd, updateStart

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerHelper

public ContainerHelper(ConnectorContainerHelper.ContainerConnectorTarget parent,
                       java.lang.String convertAddress)

Method Detail

getMainPartInfo

protected ContainerMainPartInfos getMainPartInfo(ConnectorRootStream co,
                                                 com.exalead.container.ContainerItem item)

Overrides:

getMainPartInfo in class ConnectorContainerHelper

getMainPart

protected Part getMainPart(ConnectorRootStream co)

Overrides:

getMainPart in class ConnectorContainerHelper

getMainPartInternal

protected Part getMainPartInternal(ConnectorRootStream co)

filterItem

protected boolean filterItem(com.exalead.container.ContainerItem item,
                             boolean isContainer)

Description copied from class: ConnectorContainerHelper

Filter container or item

Overrides:

filterItem in class ConnectorContainerHelper

Parameters:

item - The item to check

isContainer - Is it a container ?

Returns:

true if the item should be accepted

buildDocument

public Document buildDocument(java.lang.String uri,
                              java.lang.String stamp,
                              PartContainer partContainer,
                              MetaContainer metaContainer)
                       throws PushAPIException

Description copied from class: ConnectorContainerHelper

Build a Document. This function is called by the framework each time a container document needs to be created.

Overrides:

buildDocument in class ConnectorContainerHelper

Parameters:

uri - Document URI

stamp - Document stamp

partContainer - Document parts container

metaContainer - Document meta container

Returns:

The created document

Throws:

PushAPIException - Upon error