public class CheckIDsModule extends Module
Constructor and Description |
---|
CheckIDsModule(java.io.File inputFile,
boolean isFile)
Constructor for this module.
|
CheckIDsModule(java.lang.String[] args)
Constructor for this module.
|
Modifier and Type | Method and Description |
---|---|
void |
execute()
Performs the actions provieded my the implementing module.
|
protected Options |
getActionOptions(java.lang.String actionName)
Required for the command line help system.
|
java.util.List<java.lang.String> |
getResultingDuplicateObjectIds()
A map of all IDs that were found that are asigned to more then one object.
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getResultingMissingObjectIds()
A map of all IDs that were found that do not have a corresponding object.
|
java.util.List<java.lang.String> |
getResultingOrphanedObjectIDs()
A map with the IDs of the object that were found that are not referenced anywhere.
|
static java.lang.String |
moduleDescription() |
protected void |
parseParams()
Method to handle parameter value parsing in subclasses.
|
boolean |
requiresConnection()
Tells the caller if this module requires connection to the repository.
|
getArgs, getCommandLine, getModuleName, getOptions, notifyListeners, notifyListeners, notifyListeners, notifyListeners, notifyListeners, parseArgs
public CheckIDsModule(java.lang.String[] args)
args
- (String[]) The current command line user input.public CheckIDsModule(java.io.File inputFile, boolean isFile)
inputFile
- (File) The file that should be checked.isFile
- (boolean) Is the input a file (true) or a directory (false).protected final void parseParams() throws java.lang.Exception
Module
parseParams
in class Module
java.lang.Exception
- Is thrown when command line values fail to pass the required validation.public final void execute() throws java.lang.Exception
Module
public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResultingMissingObjectIds()
public final java.util.List<java.lang.String> getResultingDuplicateObjectIds()
public final java.util.List<java.lang.String> getResultingOrphanedObjectIDs()
protected final Options getActionOptions(java.lang.String actionName) throws java.lang.Exception
Module
getActionOptions
in class Module
actionName
- (String) Name of the submodule called in the command line.java.lang.Exception
- Error retrieving the requestes informations.public static java.lang.String moduleDescription()
public final boolean requiresConnection()
Module
requiresConnection
in class Module