com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

Class FileNameHelper

java.lang.Object

com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

public class FileNameHelper
extends Object

Provides facilities to determine file names to use for documents.

Constructor Summary

Constructors

Constructor and Description
FileNameHelper()

Method Summary

Modifier and Type	Method and Description
static String	getDocumentOutputFilename(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document) Gets a name to use for the output file representing the original document passed in.
static String	getMetadataRefOutputFilename(Map.Entry<String,com.hpe.caf.util.ref.ReferencedData> metadataReference) Gets a file name to use for the provided metadata reference
static String	getRawTaskMessageFilename() Gets the name to give the file containing the raw task message as retrieved from the queue.
static String	getTaskMessageFilename() Gets the name to give the file containing the user-friendly version of the task message.
static String	sanitizeForFilesystem(String strToSanitize) Replaces illegal filesystem characters in provided string with '_'.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileNameHelper

public FileNameHelper()

Method Detail

sanitizeForFilesystem

public static String sanitizeForFilesystem(String strToSanitize)

Replaces illegal filesystem characters in provided string with '_'.

Parameters:

strToSanitize - String that should be sanitized.

Returns:

Version of the string parameter with any illegal filesystem characters replaced with '_'.

getMetadataRefOutputFilename

public static String getMetadataRefOutputFilename(Map.Entry<String,com.hpe.caf.util.ref.ReferencedData> metadataReference)

Gets a file name to use for the provided metadata reference

Parameters:

metadataReference - Metadata Reference to generate output filename for.

Returns:

Constructed metadata reference filename.

getDocumentOutputFilename

public static String getDocumentOutputFilename(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document)

Gets a name to use for the output file representing the original document passed in.

Parameters:

document - Document to generate filename for.

Returns:

Generated filename.

getRawTaskMessageFilename

public static String getRawTaskMessageFilename()

Gets the name to give the file containing the raw task message as retrieved from the queue.

Returns:

Filename for raw task message file.

getTaskMessageFilename

public static String getTaskMessageFilename()

Gets the name to give the file containing the user-friendly version of the task message.

Returns:

Filename for user-friendly task message file.