Package com.attivio.sdk.scanner
Interface IncrementalDataSourceScanner
-
public interface IncrementalDataSourceScannerInterface for scanners to implement if they want to support incremental scanning. The implementation of the interface provides standard configuration andreset()in the Administration UI. However, the scanner must implement incremental logic usingIngestionHistoryApito persist the state of the scan between runs. See theSampleIncrementalDataSourceScannerSDK example.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanisIncrementalDeletes()booleanisIncrementalModeActivated()Whether or not this scanner should run in incremental mode.voidreset()Resets any state being maintained by this scanner.voidsetIncrementalDeletes(boolean autoDelete)Specifies whether to delete Attivio documents when their underlying data source documents were deleted.voidsetIncrementalModeActivated(boolean incrementalModeActivated)Specifies whether or not this scanner should run in incremental mode.
-
-
-
Method Detail
-
isIncrementalDeletes
boolean isIncrementalDeletes()
- Returns:
- true if document auto delete is enabled.
-
setIncrementalDeletes
void setIncrementalDeletes(boolean autoDelete)
Specifies whether to delete Attivio documents when their underlying data source documents were deleted. This setting is only valid ifsetIncrementalModeActivated(boolean)is set to true.- Parameters:
autoDelete- if true, will automatically delete documents that no longer exist.
-
reset
void reset() throws AttivioExceptionResets any state being maintained by this scanner.- Throws:
AttivioException
-
isIncrementalModeActivated
boolean isIncrementalModeActivated()
Whether or not this scanner should run in incremental mode.- Returns:
- current state of incremental mode activation.
-
setIncrementalModeActivated
void setIncrementalModeActivated(boolean incrementalModeActivated)
Specifies whether or not this scanner should run in incremental mode.- Parameters:
incrementalModeActivated- a toggle value indicating whether or not this scanner should run in incremental mode.
-
-