com.exalead.papi.connectors.filesystem.xml

Class XmlFolderDeletionHelper

java.lang.Object

com.exalead.papi.connectors.filesystem.xml.XmlFolderDeletionHelper

All Implemented Interfaces:

FolderDeletionHelper

public class XmlFolderDeletionHelper
extends java.lang.Object
implements FolderDeletionHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XmlFolderDeletionHelper.SyncedEntryComparator

Nested classes/interfaces inherited from interface com.exalead.papi.framework.operations.folder.FolderDeletionHelper

FolderDeletionHelper.FolderDeletionHelperClient

Field Summary

Fields

Modifier and Type	Field and Description
protected FolderDeletionHelper.FolderDeletionHelperClient	client
protected XMLConnector	connector
protected java.util.Set<java.lang.String>	keys
protected java.util.Map<java.lang.String,java.util.Collection<SyncedEntry>>	syncedEntries
protected java.util.Map<java.lang.String,SyncedEntry>	syncedEntriesFolders
protected java.util.Set<SyncedEntry>	toDeleteEntrySet

Constructor Summary

Constructors

Constructor and Description
XmlFolderDeletionHelper(XMLConnector connector, FolderDeletionHelper.FolderDeletionHelperClient client, java.lang.String rootPathUri)

Method Summary

Modifier and Type	Method and Description
long	commitDeletes() Commit deletes, based on root prefix and seen URIs (@see put)
SyncedEntry	getSynchedEntry(Key key)
void	markForDeletionAllEntriesAlike(SyncedEntry toDelete) Delete all the previously synchronized entries that belong to the same XML file.
void	put(Key key) Add (register) an entry.

Methods inherited from class java.lang.Object

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

Field Detail

connector

protected final XMLConnector connector

client

protected final FolderDeletionHelper.FolderDeletionHelperClient client

syncedEntries

protected final java.util.Map<java.lang.String,java.util.Collection<SyncedEntry>> syncedEntries

syncedEntriesFolders

protected final java.util.Map<java.lang.String,SyncedEntry> syncedEntriesFolders

keys

protected final java.util.Set<java.lang.String> keys

toDeleteEntrySet

protected final java.util.Set<SyncedEntry> toDeleteEntrySet

Constructor Detail

XmlFolderDeletionHelper

public XmlFolderDeletionHelper(XMLConnector connector,
                               FolderDeletionHelper.FolderDeletionHelperClient client,
                               java.lang.String rootPathUri)
                        throws PushAPIException

Throws:

PushAPIException

Method Detail

getSynchedEntry

public SyncedEntry getSynchedEntry(Key key)

Specified by:

getSynchedEntry in interface FolderDeletionHelper

markForDeletionAllEntriesAlike

public void markForDeletionAllEntriesAlike(SyncedEntry toDelete)

Delete all the previously synchronized entries that belong to the same XML file.

Parameters:

toDelete - The entry which all other entries originating from the same XML file will be deleted

put

public void put(Key key)

Description copied from interface: FolderDeletionHelper

Add (register) an entry.

Specified by:

put in interface FolderDeletionHelper

Parameters:

key - The key to register

commitDeletes

public long commitDeletes()
                   throws PushAPIException

Description copied from interface: FolderDeletionHelper

Commit deletes, based on root prefix and seen URIs (@see put)

Specified by:

commitDeletes in interface FolderDeletionHelper

Returns:

the number of deletes issued, either document, or root path

Throws:

PushAPIException