com.github.cafdataprocessing.utilities.initialization

Class ClassificationWorkflowNameResolver

java.lang.Object

com.github.cafdataprocessing.utilities.initialization.ClassificationWorkflowNameResolver

public class ClassificationWorkflowNameResolver
extends Object

Resolves the names of classification workflows used in actions to their IDs

Constructor Summary

Constructors

Constructor and Description
ClassificationWorkflowNameResolver(com.github.cafdataprocessing.classification.service.client.ApiClient apiClient) Create new instance of ClassificationWorkflowNameResolver using specified ApiClient.

Method Summary

Modifier and Type	Method and Description
void	populateFromCreationResult(com.github.cafdataprocessing.classification.service.creation.created.CreationResult creationResult) Populate map of classification workflow names to IDs using the Creation Result.
void	populateWorkflowsFromApiCall(String projectId) Populates the known mapping of workflow names to workflow IDs by querying the classification API for all existing workflows.
Long	resolveFromWorkflowName(String workflowName) Resolves provided classification workflow name to matching ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassificationWorkflowNameResolver

public ClassificationWorkflowNameResolver(com.github.cafdataprocessing.classification.service.client.ApiClient apiClient)

Create new instance of ClassificationWorkflowNameResolver using specified ApiClient.

Parameters:

apiClient - Used to create a Workflow API to contact for resolution. If null passed then name resolution via external API calls will not be possible.

Method Detail

populateFromCreationResult

public void populateFromCreationResult(com.github.cafdataprocessing.classification.service.creation.created.CreationResult creationResult)

Populate map of classification workflow names to IDs using the Creation Result.

Parameters:

creationResult - Classification Workflow Creation Result to populate from.

populateWorkflowsFromApiCall

public void populateWorkflowsFromApiCall(String projectId)
                                  throws com.github.cafdataprocessing.classification.service.client.ApiException

Populates the known mapping of workflow names to workflow IDs by querying the classification API for all existing workflows.

Parameters:

projectId - Project ID to use in workflow requests.

Throws:

com.github.cafdataprocessing.classification.service.client.ApiException - Thrown if there is an error communicating with the API or if error response received from API.

resolveFromWorkflowName

public Long resolveFromWorkflowName(String workflowName)

Resolves provided classification workflow name to matching ID.

Parameters:

workflowName - Classification workflow name to get ID for.

Returns:

Corresponding ID for provided name.