Package dekoh.portal.fwk.importer

Provides the classes help in importing files into Dekoh application's Database.

See:
Description

Interface Summary

ImportEvent	ImportEvent are emitted during an import process to indicate progress.
ImportProcessor	ImportProcessor provides methods to import files into Dekoh.
ImportProgressEventListener	An ImportProgressEventListener is notified of the progress of the Importing files into Dekoh.
ImportService	ImportService interface has ImportServce management methods.The ScanObserver registers itself with ImportServcie.
ImportSubProcess
ImportSubProcessObserver	ImportTaskObserver gets notifications while ImportSubProcess are executing a ImportRequest The callbacks can be used to monitor progress of import task execution and do pre aand post cleanup activities
ScanObserver

Class Summary

AbstractImportProcessor	Content application that intend to manage digital assets that are represented as files (like JPG, mp3, mov) can extend this class to import the metadata into Dekoh Database.
AggregatedImportedDirectories	AggregatedImportedDirectories represents the aggregated public and private directories user has imported.
DBOperationsSubProcess
ExecutorBackedImportSubProcess
FileUtil	Utility class to hold Utility methods for operations on file
FileUtil.DirectoryFilter	A FileFilter to list sub directories that are not hidden.
ImportConfig	ImportConfig stores the information required by ImportService for selecting files to import.
ImportContext	ImportContext represents the context in which the import is executed.
ImportedDirectories	ImportedDirectories is a log of directories imported.
ImportEventListenerImpl	ImportEventListenerImpl listens to progress events during the import to maintain a lists of new , modified, renamed and removed files.
ImportLogger
ImportProgressEventObject	ImportProgressEvent indicates result of importing one file among all the selected files to be imported.
ImportProgressObject	ImportProgressObject indicates the progress of current importing of Digital Objects.
ImportProgressObject.ProgressStatus	States of an import process.
ImportRequest	For each file to be imported a ExecutionRequest is created by ImportService.
ImportRequestCreator
ImportServiceFactory	Deprecated. no alternative : applications are expected to create instanaces of ImportService implementation
ImportServiceImpl	Implementation of ImportService that imports matching file types from selected directories in local file system.
ImportStatus	States a file as it is imported to Dekoh can be in.
ImportStatusInfo
ImportSubProcess.ExecutionPolicy
ImportTrasactionManager	PersistenceTransactionManager is used by DBOperationsSubProcess for managing transactions.Transaction policy followed is If transaction is not already active begin a transaction before persisting a file Commit transaction if end of a directory is reached OR Commit transaction if #ImportConfig.getNumberOfFilesInBatch has reached OR Commit transaction if all files scheduled for persistence have been persisted Commit transaction if transaction if active when import process is interrupted by user Rollback transaction if active when import process is completed PersistenceTransactionManager also has a instance of ProgressObjectWriter which it updates once a file has been persisted.
ProgressObjectWriter	ProgressObjectWriter instances track the progress of each Import Subprocess.
RootFolder

Exception Summary

ImportStoppedException

Package dekoh.portal.fwk.importer Description

Provides the classes help in importing files into Dekoh application's Database. Importing files into Dekoh involves extracting the metadata from the file and storing it as a DigitalObject.
Dekoh platform's Import Service API provides progress of the import process by emitting events whenver a file with matching datatype is found and is imported to Dekoh application. A started import process can be stopped at any time.
Dekoh's Import Service makes sure that only the changes made to a previously imported directory are imported.
During the import process many DigitalObjects are created. Each DigitalObject is a JPA entity. As the number of Java Persistence API (JPA) entities created in a persistence context increase, the heap usage also increases. To keep the runtime memory in check Import Service API batches the persists to Dekoh application's Database, and clears the persistence context periodically.