de.xima.fc.bl.fdv.file

Class ConsumingFileHandlerImpl

java.lang.Object

de.xima.fc.bl.fdv.file.ConsumingFileHandlerImpl

All Implemented Interfaces:

IConsumingFileHandler

public class ConsumingFileHandlerImpl
extends Object
implements IConsumingFileHandler

Constructor Summary

Constructors

Constructor and Description
ConsumingFileHandlerImpl(IWorkflowProcessingContext wfpc)

Method Summary

Modifier and Type	Method and Description
List<Attachment>	getAttachmentsFromUploadElements(IUploadConsuming consuming, Aktion action) Same as #getAttachmentsFromUploadElements(List, Aktion, IWorkflowProcessingContext), but takes the arguments from the given IUploadConsuming belonging to the given action.
List<Attachment>	getAttachmentsFromUploadElements(List<String> uploadElements, Aktion action) Returns a list of all attachments for the given upload elements.
File	getDirWithUploadElements(IUploadConsuming consuming, Aktion action) Same as #getDirWithUploadElements(List, Aktion, IWorkflowProcessingContext), but takes the parameters from the given IUploadConsuming corresponding to the given action.
File	getDirWithUploadElements(List<String> uploadElements, Aktion action) Similar to #getFilesFromUploadElements(List, Aktion, IWorkflowProcessingContext), but returns a File for the directory which contains all the uploaded elements.
Map<? super Object,File>	getFileOrDirsFromPreviousActions(IConsuming consuming, Aktion action) For each previous action as specified by IConsuming.getAktionsIdErgebnisse(), find the file or directory created by that action and returns them.
List<File>	getFilesFromPreviousActions(IConsuming consuming, Aktion action) Returns all files from previous actions as specified by the IConsuming.getAktionsIdErgebnisse().
List<File>	getFilesFromUploadElements(IUploadConsuming consuming, Aktion action) Same as #getFilesFromUploadElements(List, Aktion, IWorkflowProcessingContext), but takes the parameters from the given IUploadConsuming corresponding to the given action.
List<File>	getFilesFromUploadElements(List<String> uploadElements, Aktion action) Returns a list of all files from the given upload elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsumingFileHandlerImpl

public ConsumingFileHandlerImpl(IWorkflowProcessingContext wfpc)

Method Detail

getFileOrDirsFromPreviousActions

public Map<? super Object,File> getFileOrDirsFromPreviousActions(IConsuming consuming,
                                                                 Aktion action)

Description copied from interface: IConsumingFileHandler

For each previous action as specified by IConsuming.getAktionsIdErgebnisse(), find the file or directory created by that action and returns them. Actions that did not create a file or directory are omitted.

Specified by:

getFileOrDirsFromPreviousActions in interface IConsumingFileHandler

Parameters:

consuming - The IConsuming belonging to the given action.

action - A file consuming action whose files to get.

Returns:

A map from the ID of each previous action to the file or directory created by that action.

getFilesFromPreviousActions

public List<File> getFilesFromPreviousActions(IConsuming consuming,
                                              Aktion action)

Description copied from interface: IConsumingFileHandler

Returns all files from previous actions as specified by the IConsuming.getAktionsIdErgebnisse(). This method does not return any File.isDirectory()s. Instead, it recursively walks all directories and only returns the files they contain.

Specified by:

getFilesFromPreviousActions in interface IConsumingFileHandler

Parameters:

consuming - The IProcessing for the given action.

action - Action for which to get the files.

Returns:

All files without directories from the specified previous actions.

getAttachmentsFromUploadElements

public List<Attachment> getAttachmentsFromUploadElements(IUploadConsuming consuming,
                                                         Aktion action)
                                                  throws Exception

Description copied from interface: IConsumingFileHandler

Same as #getAttachmentsFromUploadElements(List, Aktion, IWorkflowProcessingContext), but takes the arguments from the given IUploadConsuming belonging to the given action.

Specified by:

getAttachmentsFromUploadElements in interface IConsumingFileHandler

Throws:

Exception

See Also:

#getAttachmentsFromUploadElements(List, Aktion, IWorkflowProcessingContext)

getAttachmentsFromUploadElements

public List<Attachment> getAttachmentsFromUploadElements(List<String> uploadElements,
                                                         Aktion action)
                                                  throws Exception

Description copied from interface: IConsumingFileHandler

Returns a list of all attachments for the given upload elements. If no file was uploaded for a certain upload element, the attachment is omitted in the returned list.

Specified by:

getAttachmentsFromUploadElements in interface IConsumingFileHandler

Parameters:

uploadElements - Upload elements the given action required. Must contain the FormElement.getAlias() of the form upload element.

action - The current action that is being processed.

Returns:

List of attachments.

Throws:

Exception

getFilesFromUploadElements

public List<File> getFilesFromUploadElements(IUploadConsuming consuming,
                                             Aktion action)
                                      throws Exception

Description copied from interface: IConsumingFileHandler

Same as #getFilesFromUploadElements(List, Aktion, IWorkflowProcessingContext), but takes the parameters from the given IUploadConsuming corresponding to the given action.

Specified by:

getFilesFromUploadElements in interface IConsumingFileHandler

Throws:

Exception

See Also:

#getFilesFromUploadElements(List, Aktion, IWorkflowProcessingContext)

getFilesFromUploadElements

public List<File> getFilesFromUploadElements(List<String> uploadElements,
                                             Aktion action)
                                      throws Exception

Description copied from interface: IConsumingFileHandler

Returns a list of all files from the given upload elements. Upload elements with no uploaded file are skipped.

Specified by:

getFilesFromUploadElements in interface IConsumingFileHandler

Parameters:

uploadElements - Upload elements the given action required. Must contain the FormElement.getAlias() of the form upload element.

action - The current action that is being processed.

Returns:

List of uploaded files.

Throws:

Exception

getDirWithUploadElements

public File getDirWithUploadElements(IUploadConsuming consuming,
                                     Aktion action)
                              throws Exception

Description copied from interface: IConsumingFileHandler

Same as #getDirWithUploadElements(List, Aktion, IWorkflowProcessingContext), but takes the parameters from the given IUploadConsuming corresponding to the given action.

Specified by:

getDirWithUploadElements in interface IConsumingFileHandler

Throws:

Exception

See Also:

#getDirWithUploadElements(List, Aktion, IWorkflowProcessingContext)

getDirWithUploadElements

public File getDirWithUploadElements(List<String> uploadElements,
                                     Aktion action)
                              throws Exception

Description copied from interface: IConsumingFileHandler

Similar to #getFilesFromUploadElements(List, Aktion, IWorkflowProcessingContext), but returns a File for the directory which contains all the uploaded elements.

Specified by:

getDirWithUploadElements in interface IConsumingFileHandler

Parameters:

uploadElements - Upload elements the given action required. Must contain the FormElement.getAlias() of the form upload element.

action - The current action that is being processed.

Returns:

Directory with all the uploaded files.

Throws:

Exception