public interface LoaderManager
The LoaderManager API provides a set of overloaded methods for performing the fixed operations on sets of Files and methods for processing XML formatted manifest files (that describe operations and other parameters on a per file basis.) It also provides methods for managing the Job objects it creates to process files.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
atg.repository.loader.JobId |
add(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
int pBatchSizeHint)
Adds the provided Files using data from the provided TypeMapper which must know how to
return an appropriate TypeMapping from getMapping() given a File object.
|
atg.repository.loader.JobId |
add(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
java.util.Properties pProperties)
Adds the provided Files using data from the provided TypeMapper which must know how to
return an appropriate TypeMapping from getMapping() given a File object.
|
atg.repository.loader.JobId |
add(java.io.File[] pFiles,
atg.repository.loader.TypeMapping[] pMappings,
int pBatchSizeHint)
Adds the provided Files using data from the matching TypeMappings as needed.
|
atg.repository.loader.JobId |
add(java.io.File[] pFiles,
atg.repository.loader.TypeMapping[] pMappings,
java.util.Properties pProperties)
Adds the provided Files using data from the matching TypeMappings as needed.
|
boolean |
cancelJob(atg.repository.loader.JobId pId)
Allows a Job that has not yet started running to be removed
from the queue.
|
void |
deleteJobs(atg.repository.loader.JobId[] pIds)
Deletes the jobs specified by the array of ID's.
|
Job |
getJob(atg.repository.loader.JobId pId)
Returns the Job matching the provided JobID.
|
java.util.Collection |
getJobs()
Returns a Collection of all the current Jobs.
|
boolean |
isRecordResultsForJob()
Returns whether jobs will record information about successfully
processed files as well as errors.
|
atg.repository.loader.JobId |
processManifest(java.io.File pManifestFile,
java.util.Properties pProperties)
Processes the files specified in the provided "manifest" file, adding, updating
or deleting as directed.
|
atg.repository.loader.JobId |
processManifest(java.io.File pManifestFile,
atg.repository.loader.TypeMapper pMapper,
java.util.Properties pProperties)
Processes the files specified in the provided "manifest" file, adding, updating
or deleting as directed.
|
atg.repository.loader.JobId |
remove(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
int pBatchSizeHint)
Removes repository items corresponding to the provided Files using
data from the matching TypeMappings as needed.
|
atg.repository.loader.JobId |
remove(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
java.util.Properties pProperties)
Removes repository items corresponding to the provided Files using
data from the matching TypeMappings as needed.
|
atg.repository.loader.JobId |
remove(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
java.util.Properties pProperties,
boolean pReverseOrder)
Removes repository items corresponding to the provided Files using
data from the matching TypeMappings as needed.
|
atg.repository.loader.JobId |
remove(java.io.File[] pFiles,
atg.repository.loader.TypeMapping[] pMappings,
int pBatchSizeHint)
Removes repository items corresponding to the provided Files using
data from the matching TypeMappings as needed.
|
atg.repository.loader.JobId |
remove(java.io.File[] pFiles,
atg.repository.loader.TypeMapping[] pMappings,
java.util.Properties pProperties)
Removes repository items corresponding to the provided Files using
data from the matching TypeMappings as needed.
|
void |
setRecordResultsForJob(boolean pRecordResultsForJob)
Sets whether jobs will record information about successfully
processed files as well as errors.
|
atg.repository.loader.JobId |
update(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
int pBatchSizeHint)
Updates the provided Files using data from the provided TypeMapper which must know how to
return an appropriate TypeMapping from getMapping() given a File object.
|
atg.repository.loader.JobId |
update(java.io.File[] pFiles,
atg.repository.loader.TypeMapper pMapper,
java.util.Properties pProperties)
Updates the provided Files using data from the provided TypeMapper which must know how to
return an appropriate TypeMapping from getMapping() given a File object.
|
atg.repository.loader.JobId |
update(java.io.File[] pFiles,
atg.repository.loader.TypeMapping[] pMappings,
int pBatchSizeHint)
Updates the provided Files using data from the matching TypeMappings as needed.
|
atg.repository.loader.JobId |
update(java.io.File[] pFiles,
atg.repository.loader.TypeMapping[] pMappings,
java.util.Properties pProperties)
Updates the provided Files using data from the matching TypeMappings as needed.
|
static final java.lang.String CLASS_VERSION
void setRecordResultsForJob(boolean pRecordResultsForJob)
boolean isRecordResultsForJob()
atg.repository.loader.JobId add(java.io.File[] pFiles, atg.repository.loader.TypeMapping[] pMappings, int pBatchSizeHint) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMappings
- the matching array of TypeMappingspBatchSizeHint
- the number of files that should be processed in a single transaction.
The backend is free to treat this as an approximation (due to relationships between items) or
ignore it altogether.atg.repository.loader.LoaderException
atg.repository.loader.JobId add(java.io.File[] pFiles, atg.repository.loader.TypeMapping[] pMappings, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMappings
- the matching array of TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId add(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, int pBatchSizeHint) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspBatchSizeHint
- specifies the number of files that should be processed in a single transaction.
The backend is free to treat this as an approximation (due to relationships between items) or
ignore it altogether.atg.repository.loader.LoaderException
atg.repository.loader.JobId add(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId update(java.io.File[] pFiles, atg.repository.loader.TypeMapping[] pMappings, int pBatchSizeHint) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMappings
- the matching array of TypeMappingspBatchSizeHint
- specifies the number of files that should be processed in a single transaction.
The backend is free to treat this as an approximation (due to relationships between items) or
ignore it altogether.atg.repository.loader.LoaderException
atg.repository.loader.JobId update(java.io.File[] pFiles, atg.repository.loader.TypeMapping[] pMappings, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMappings
- the matching array of TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId update(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, int pBatchSizeHint) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspBatchSizeHint
- specifies the number of files that should be processed in a single transaction.
The backend is free to treat this as an approximation (due to relationships between items) or
ignore it altogether.atg.repository.loader.LoaderException
atg.repository.loader.JobId update(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId remove(java.io.File[] pFiles, atg.repository.loader.TypeMapping[] pMappings, int pBatchSizeHint) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMappings
- the matching array of TypeMappingspBatchSize
- specifies the number of files that should be
processed in a single transaction. The backend is free to treat
this as an approximation (due to relationships between items) or
ignore it altogether.atg.repository.loader.LoaderException
atg.repository.loader.JobId remove(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, int pBatchSizeHint) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspBatchSize
- specifies the number of files that should be
processed in a single transaction. The backend is free to treat
this as an approximation (due to relationships between items) or
ignore it altogether.atg.repository.loader.LoaderException
atg.repository.loader.JobId remove(java.io.File[] pFiles, atg.repository.loader.TypeMapping[] pMappings, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMappings
- the matching array of TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId remove(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId remove(java.io.File[] pFiles, atg.repository.loader.TypeMapper pMapper, java.util.Properties pProperties, boolean pReverseOrder) throws atg.repository.loader.LoaderException
pFiles
- the array of input source FilespMapper
- the TypeMapper that should be used to provide TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.pReverseOrder
- should the file array be processed in reverse order possibly to deal
with foreign key constraints on parent folders?atg.repository.loader.LoaderException
atg.repository.loader.JobId processManifest(java.io.File pManifestFile, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pManifestFile
- the text file of file names to be processed.pProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
atg.repository.loader.JobId processManifest(java.io.File pManifestFile, atg.repository.loader.TypeMapper pMapper, java.util.Properties pProperties) throws atg.repository.loader.LoaderException
pManifestFile
- the text file of file names to be processed.pMapper
- the TypeMapper that should be used to provide TypeMappingspProperties
- a dictionary of properties which the LoaderManager can use as hints for
the load operation.atg.repository.loader.LoaderException
Job getJob(atg.repository.loader.JobId pId)
pId
- the JobId of the Job requested.java.util.Collection getJobs()
void deleteJobs(atg.repository.loader.JobId[] pIds)
pIds
- job ID'sboolean cancelJob(atg.repository.loader.JobId pId) throws atg.repository.loader.LoaderException
atg.repository.loader.LoaderException