- All Superinterfaces:
- All Known Implementing Classes:
public interface ValidationAction extends ActionAction for validating and metadata extraction from files in a file set. This action is used in two different contexts:
- For validating the files when
FileSet.validate(DbControl). This action is supposed to validated the entire file set as a whole. The
ClientContextparameter passed to the factory has the owner of the file set (eg. the
FileStoreEnabled) item as the current item.
- For removing metadata when a file in a file set is removed or replaced
with another file. For example, when the
FileSet.setMember(File, DataFileType)or any other method that removs a file from the fileset is called. The
ClientContextin this case also has the owner of the file set as the current item, but the action will only be asked to accept the file(s) that are actually removed/modified.
Tip! For validators that works on a single file at a time the
SingleFileValidationActioncan be used as a base class.
- Last modified
- $Date: 2011-10-21 13:15:41 +0200 (fr, 21 okt 2011) $
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
acceptFile(FileSetMember member)Check if the given file is handled by this validator implementation or not?
resetMetadata()Reset all metadata that this class normally can set.
validateAndExtractMetadata()Validate and extract metadata from the file(s) that has been added to this validator.
Accept acceptFile(FileSetMember member)Check if the given file is handled by this validator implementation or not? No validation of the actual file data should take place in this method. This method is called by the core for all members of the file set that are still considered as valid. If another validator has marked a file as invalid it will not be offered to the remaining validators.
The file can either be validated immediately or later when this method has been called for all files in the file set. If the file is accepted for immediate validation the
validateAndExtractMetadata()is called before the next file is processed. When all files have been processed the
validateAndExtractMetadata()method is called again if at least one was accepted for later validation.
member- A member of the current file set
- A value from the Accept enumeration to accept the file for validation or null to not accept the file for validatio
void validateAndExtractMetadata() throws InvalidDataException, InvalidRelationExceptionValidate and extract metadata from the file(s) that has been added to this validator. If the
Accept.VALIDATE_IMMEDIATELYthis method is called and the validator should work on the last accepted file.
This method is also called after all files has been processed if at least one file returned
This method is recommended to throw an
InvalidDataExceptionor a subclass if the file is not a valid file.
PermissionDeniedException:s are ignored by the core and will not change the validation status. An exception of type
InvalidRelationExceptioncan be thrown if the file itself is valid, but a related file that it depends on is not. The core will still mark the file as invalid and store the error message, but extracted metadata will not be reset.
void resetMetadata()Reset all metadata that this class normally can set. This method is called if the validation of a file failed or if a file is removed from the file set. Any previous metadata that may signal that a valid file is present should be reset.