com.github.cafdataprocessing.utilities.initialization

Class ClassificationInitializer

java.lang.Object

com.github.cafdataprocessing.utilities.initialization.ClassificationInitializer

public class ClassificationInitializer
extends Object

Utility class used to initialize Classification using base data files.

Constructor Summary

Constructors

Constructor and Description
ClassificationInitializer()

Method Summary

Modifier and Type	Method and Description
static ClassificationWorkflowNameResolver	initializeClassificationWorkflowIfRequired(String classificationApiUrl, boolean createClassificationBaseData, String classificationBaseDataInputFile, String classificationBaseDataOutputFile, String projectId) Creates a classification workflow using the provided input file if configured and returns a ClassificationWorkflowNameResolver for use in matching Classification Workflow names to IDs.
static ClassificationWorkflowNameResolver	initializeClassificationWorkflowIfRequired(String classificationApiUrl, boolean createClassificationBaseData, String classificationBaseDataInputFile, String classificationBaseDataOutputFile, String projectId, boolean overwriteExisting) Creates a classification workflow using the provided input file if configured and returns a ClassificationWorkflowNameResolver for use in matching Classification Workflow names to IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassificationInitializer

public ClassificationInitializer()

Method Detail

initializeClassificationWorkflowIfRequired

public static ClassificationWorkflowNameResolver initializeClassificationWorkflowIfRequired(String classificationApiUrl,
                                                                                            boolean createClassificationBaseData,
                                                                                            String classificationBaseDataInputFile,
                                                                                            String classificationBaseDataOutputFile,
                                                                                            String projectId)

Creates a classification workflow using the provided input file if configured and returns a ClassificationWorkflowNameResolver for use in matching Classification Workflow names to IDs. If any existing classification workflow is found with the same name as the workflow to create then it will be removed before the workflow is created.

Parameters:

classificationApiUrl - URL of the classification API to contact. Used in workflow creation and by name resolver.

createClassificationBaseData - Whether a classification workflow should be created.

classificationBaseDataInputFile - If createClassificationBaseData is true then the file contents of the location specified by this parameter are read and used to create a classification workflow.

classificationBaseDataOutputFile - Destination file to output details of created classification workflow to. Pass null if no output file required.

projectId - ProjectId to create classification workflow under.

Returns:

A name resolver for resolving classification workflow names to IDs.

initializeClassificationWorkflowIfRequired

public static ClassificationWorkflowNameResolver initializeClassificationWorkflowIfRequired(String classificationApiUrl,
                                                                                            boolean createClassificationBaseData,
                                                                                            String classificationBaseDataInputFile,
                                                                                            String classificationBaseDataOutputFile,
                                                                                            String projectId,
                                                                                            boolean overwriteExisting)

Creates a classification workflow using the provided input file if configured and returns a ClassificationWorkflowNameResolver for use in matching Classification Workflow names to IDs.

Parameters:

classificationApiUrl - URL of the classification API to contact. Used in workflow creation and by name resolver.

createClassificationBaseData - Whether a classification workflow should be created.

classificationBaseDataInputFile - If createClassificationBaseData is true then the file contents of the location specified by this parameter are read and used to create a classification workflow.

classificationBaseDataOutputFile - Destination file to output details of created classification workflow to. Pass null if no output file required.

projectId - ProjectId to create classification workflow under.

overwriteExisting - Whether any existing workflows that match the name of the workflow specified in the input file should be removed before creation.

Returns:

A name resolver for resolving classification workflow names to IDs.