com.exalead.papi.framework.operations.folder

Class EnumeratesFolderOperation<SKey extends Key>

java.lang.Object

com.exalead.papi.framework.operations.Operation<SKey>

com.exalead.papi.framework.operations.FolderOperation<SKey>

com.exalead.papi.framework.operations.folder.EnumeratesFolderOperation<SKey>

Direct Known Subclasses:

EnumeratesFolderContainerOperation

public class EnumeratesFolderOperation<SKey extends Key>
extends FolderOperation<SKey>

The operation in charge of the treatment of a Folder. It enumerates the content, decides to skip or not folder/document, transform the Key into an Operation, and store it into the Pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EnumeratesFolderOperation.EnumeratesFolderDeletionHelperClient

Field Summary

Fields

Modifier and Type	Field and Description
EnumerableOperationBuilder<SKey>	m_OperationBuilder The OperationBuilder used to translate the Key into Operation
EnumerableOperationBuilder<SKey>	m_OperationBuilderNotModified The OperationBuilder used to translate the Key into Operation during an noop operation (ie.
EnumerableOperationBuilder<SKey>	m_OperationBuilderUpdate The OperationBuilder used to translate the Key into Operation during an update (ie.
SourceEnumerator<SKey>	m_SourceEnumerator The SourceEnumerator associated to this FolderOperation
static java.lang.String	NAME The name of the operation

Fields inherited from class com.exalead.papi.framework.operations.FolderOperation

folderKey

Fields inherited from class com.exalead.papi.framework.operations.Operation

m_OperationName

Constructor Summary

Constructors

Constructor and Description
EnumeratesFolderOperation(SKey folderKey, SourceEnumerator<SKey> sourceEnumerator, EnumerableOperationBuilder<SKey> operationBuilder, EnumerableOperationBuilder<SKey> operationBuilderUpdate, EnumerableOperationBuilder<SKey> operationBuilderNotModified)

Method Summary

Modifier and Type	Method and Description
void	execute_code(GenericMultiThreadedConnector<SKey> connector)
static <SKey extends Key> java.lang.String	getStamp(GenericMultiThreadedConnector<SKey> connector, SKey key)

Methods inherited from class com.exalead.papi.framework.operations.FolderOperation

execute

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

The name of the operation

See Also:

Constant Field Values

m_SourceEnumerator

public final SourceEnumerator<SKey extends Key> m_SourceEnumerator

The SourceEnumerator associated to this FolderOperation

m_OperationBuilder

public final EnumerableOperationBuilder<SKey extends Key> m_OperationBuilder

The OperationBuilder used to translate the Key into Operation

m_OperationBuilderUpdate

public final EnumerableOperationBuilder<SKey extends Key> m_OperationBuilderUpdate

The OperationBuilder used to translate the Key into Operation during an update (ie. the document URI already exists)

m_OperationBuilderNotModified

public final EnumerableOperationBuilder<SKey extends Key> m_OperationBuilderNotModified

The OperationBuilder used to translate the Key into Operation during an noop operation (ie. the document URI has not been modified). The default is generally null.

Constructor Detail

EnumeratesFolderOperation

public EnumeratesFolderOperation(SKey folderKey,
                                 SourceEnumerator<SKey> sourceEnumerator,
                                 EnumerableOperationBuilder<SKey> operationBuilder,
                                 EnumerableOperationBuilder<SKey> operationBuilderUpdate,
                                 EnumerableOperationBuilder<SKey> operationBuilderNotModified)
                          throws java.lang.Exception

Parameters:

initialStartFolder -

folderKey -

sourceEnumerator -

operationBuilder -

fatherOperation -

Throws:

java.lang.Exception

Method Detail

execute_code

public void execute_code(GenericMultiThreadedConnector<SKey> connector)
                  throws java.lang.Exception

Specified by:

execute_code in class Operation<SKey extends Key>

Parameters:

initialStartFolder -

folderKey -

sourceEnumerator -

operationBuilder -

fatherOperation -

Throws:

java.lang.Exception

getStamp

public static <SKey extends Key> java.lang.String getStamp(GenericMultiThreadedConnector<SKey> connector,
                                                           SKey key)
                                                    throws java.io.IOException

Throws:

java.io.IOException