com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

Class SubDocumentHelper

java.lang.Object

com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.SubDocumentHelper

public class SubDocumentHelper
extends Object

Contains methods for assisting in the output of sub-documents.

Constructor Summary

Constructors

Constructor and Description
SubDocumentHelper()

Method Summary

Modifier and Type	Method and Description
static String	determineSubDocumentFolder(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document) Determines the appropriate folder path to output data about a sub document to.
static boolean	isSubDocument(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document) Determines if a provided document is a sub-document.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubDocumentHelper

public SubDocumentHelper()

Method Detail

determineSubDocumentFolder

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

Determines the appropriate folder path to output data about a sub document to.

Parameters:

document - Sub-document to determine folder path for.

Returns:

Built folder path that should be used for the sub-document. Should be appended to an existing directory.

isSubDocument

public static boolean isSubDocument(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document)

Determines if a provided document is a sub-document.

Parameters:

document - Document to check.

Returns:

True if this is a sub-document, otherwise false.