Index (data-processing-initialization 1.3.0-70 API)

A B C D E F G I M N O P R S T V W

A

actionConditions - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
ActionJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects: JSON representation of a data processing action for use with task submitter application
ActionJson(String, String, Integer, LinkedHashMap<String, Object>, List<ConditionJson>, String, Long, MergeMode) - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
actions - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
ActionTypeNameResolver - Class in com.github.cafdataprocessing.utilities.initialization: Resolves action type IDs from names and vice-versa.
ActionTypeNameResolver() - Constructor for class com.github.cafdataprocessing.utilities.initialization.ActionTypeNameResolver
additional - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionJson

B

BoilerplateInitializer - Class in com.github.cafdataprocessing.utilities.initialization: Utility class used to initialize Boilerplate using base data file.
BoilerplateInitializer() - Constructor for class com.github.cafdataprocessing.utilities.initialization.BoilerplateInitializer
BoilerplateInvoker - Class in com.github.cafdataprocessing.utilities.initialization.boilerplate: Invokes the Boilerplate Creation utility, setting up the environment it requires to run.
BoilerplateInvoker(String, String, String) - Constructor for class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateInvoker: Create a new configured instance of Boilerplate Invoker.
BoilerplateNameResolver - Class in com.github.cafdataprocessing.utilities.initialization.boilerplate: Resolves boilerplate expression and tag names to their IDs
BoilerplateNameResolver(ApiClient) - Constructor for class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Creates new instance of BoilerplateNameResolver
BooleanConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing boolean condition 'additional' property for use with task submitter application
BooleanConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.BooleanConditionAdditionalJson

C

children - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.BooleanConditionAdditionalJson
ClassificationInitializer - Class in com.github.cafdataprocessing.utilities.initialization: Utility class used to initialize Classification using base data files.
ClassificationInitializer() - Constructor for class com.github.cafdataprocessing.utilities.initialization.ClassificationInitializer
ClassificationWorkflowNameResolver - Class in com.github.cafdataprocessing.utilities.initialization: Resolves the names of classification workflows used in actions to their IDs
ClassificationWorkflowNameResolver(ApiClient) - Constructor for class com.github.cafdataprocessing.utilities.initialization.ClassificationWorkflowNameResolver: Create new instance of ClassificationWorkflowNameResolver using specified ApiClient.
com.github.cafdataprocessing.utilities.initialization - package com.github.cafdataprocessing.utilities.initialization
com.github.cafdataprocessing.utilities.initialization.boilerplate - package com.github.cafdataprocessing.utilities.initialization.boilerplate
com.github.cafdataprocessing.utilities.initialization.jsonobjects - package com.github.cafdataprocessing.utilities.initialization.jsonobjects
com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions - package com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions
combineWorkflows(WorkflowJson, WorkflowJson) - Static method in class com.github.cafdataprocessing.utilities.initialization.WorkflowCombiner: Combines (merges) two workflow objects.
condition - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.NotConditionAdditionalJson
ConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: Base class of common condition properties
ConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionAdditionalJson
ConditionJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing condition for use with task submitter application
ConditionJson(String, ConditionAdditionalJson) - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionJson
createWorkflow(WorkflowJson, WorkflowJson, String) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Creates a processing workflow derived from the information in the workflow object.
createWorkflow(WorkflowJson, WorkflowJson, String, boolean) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Creates a processing workflow derived from the information in the workflow object.
createWorkflowInitializer(String, String, String) - Static method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer
createWorkflowOnlyInitializer(String) - Static method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer
CreationResultJson - Class in com.github.cafdataprocessing.utilities.initialization.boilerplate: Deserializable version of Boilerplate Creation Utility CreationResult class, providing default constructor.
CreationResultJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultJson
CreationResultOutputJson - Class in com.github.cafdataprocessing.utilities.initialization.boilerplate: Deserializable version of Boilerplate Creation Utility CreationResultOutput class, providing default constructor.
CreationResultOutputJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultOutputJson

D

DateConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing date condition 'additional' property for use with task submitter application
DateConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.DateConditionAdditionalJson
description - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
description - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
description - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson

E

enabled - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
ExistsConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing exists condition 'additional' property for use with task submitter application
ExistsConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ExistsConditionAdditionalJson
expressions - Variable in class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultJson

F

field - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.DateConditionAdditionalJson
field - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ExistsConditionAdditionalJson
field - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.NumberConditionAdditionalJson
field - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.RegexConditionAdditionalJson
field - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.StringConditionAdditionalJson

G

getActionConditionsApi() - Method in class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider
getActionsApi() - Method in class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider
getActionTypesApi() - Method in class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider
getActionTypesIdsToNames() - Method in class com.github.cafdataprocessing.utilities.initialization.ActionTypeNameResolver: Get the map of action type IDs to names.
getActionTypesNamesToIds() - Method in class com.github.cafdataprocessing.utilities.initialization.ActionTypeNameResolver: Get the map of action type names to IDs.
getOverwriteExisting() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Get whether existing workflows under the projectId with the same name as the provided workflow should be removed.
getProcessingRulesApi() - Method in class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider
getProjectId() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams
getRulesConditionsApi() - Method in class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider
getWorkflowBaseDataFileName() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams
getWorkflowBaseDataJson() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Builds a WorkflowJson object using the workflowBaseDataStream if set or the workflowBaseDataFileName.
getWorkflowBaseDataStream() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams
getWorkflowOverlayFileName() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams
getWorkflowOverlayJson() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Builds a WorkflowJson object using the workflowOverlayStream if set or the workflowOverlayFileName.
getWorkflowOverlayStream() - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Get InputStream containing extensions / overrides to merge with the base workflow.
getWorkflowsApi() - Method in class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider

I

id - Variable in class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultOutputJson
initializeBoilerplateIfRequired(String, String, String, String, boolean) - Static method in class com.github.cafdataprocessing.utilities.initialization.BoilerplateInitializer
initializeBoilerplateIfRequired(String, String, String, String, boolean, boolean) - Static method in class com.github.cafdataprocessing.utilities.initialization.BoilerplateInitializer
initializeClassificationWorkflowIfRequired(String, boolean, String, String, String) - Static method in class com.github.cafdataprocessing.utilities.initialization.ClassificationInitializer: Creates a classification workflow using the provided input file if configured and returns a ClassificationWorkflowNameResolver for use in matching Classification Workflow names to IDs.
initializeClassificationWorkflowIfRequired(String, boolean, String, String, String, boolean) - Static method in class com.github.cafdataprocessing.utilities.initialization.ClassificationInitializer: Creates a classification workflow using the provided input file if configured and returns a ClassificationWorkflowNameResolver for use in matching Classification Workflow names to IDs.
initializeWorkflowBaseData(String, String) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Creates a processing workflow derived from the information in the input file provided.
initializeWorkflowBaseData(String, String, String) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Creates a processing workflow derived from the information in the input file provided.
initializeWorkflowBaseData(InputStream, InputStream, String) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Creates a processing workflow derived from the information in the input file provided.
initializeWorkflowBaseData(WorkflowInitializationParams) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Creates a processing workflow derived from the information in the initializationParams object.

M

mergeMode - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
MergeMode - Enum in com.github.cafdataprocessing.utilities.initialization.jsonobjects: Specifies behaviour when merging workflow processing rules and actions.
mergeMode - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson

N

name - Variable in class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultOutputJson
name - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
name - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionJson
name - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
name - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson
NotConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing not condition 'additional' property for use with task submitter application
NotConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.NotConditionAdditionalJson
notes - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionAdditionalJson
notes - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson
NumberConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing number condition 'additional' property for use with task submitter application
NumberConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.NumberConditionAdditionalJson

O

operator - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.BooleanConditionAdditionalJson
operator - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.DateConditionAdditionalJson
operator - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.NumberConditionAdditionalJson
operator - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.StringConditionAdditionalJson
order - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
order - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionAdditionalJson

P

populateActionTypesFromApi(ActionTypesApi, String) - Method in class com.github.cafdataprocessing.utilities.initialization.ActionTypeNameResolver: Records action type name and ID information for future resolution by querying provided action type API with the project ID.
populateExpressionsFromApiCall(String) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver
populateExpressionsFromApiCall() - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Populates the known mapping of expression names to expression IDs by querying the boilerplate API for all existing expressions.
populateFromCreationResult(CreationResultJson) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Records the names and IDs from the provided creation result for use in later resolution.
populateFromCreationResult(CreationResult) - Method in class com.github.cafdataprocessing.utilities.initialization.ClassificationWorkflowNameResolver: Populate map of classification workflow names to IDs using the Creation Result.
populateTagsFromApiCall() - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Populates the known mapping of tag names to tag IDs by querying the boilerplate API for all existing tags.
populateWorkflowsFromApiCall(String) - Method in class com.github.cafdataprocessing.utilities.initialization.ClassificationWorkflowNameResolver: Populates the known mapping of workflow names to workflow IDs by querying the classification API for all existing workflows.
priority - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
ProcessingApisProvider - Class in com.github.cafdataprocessing.utilities.initialization: Wrapper class allowing easy passing of multiple instantiated processing API classes
ProcessingApisProvider(ApiClient) - Constructor for class com.github.cafdataprocessing.utilities.initialization.ProcessingApisProvider
ProcessingRuleJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects: JSON representation of a data processing processing rule for use with task submitter application
ProcessingRuleJson(String, String, Boolean, Integer, List<ActionJson>, List<ConditionJson>, MergeMode) - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
processingRules - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson
projectId - Variable in class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultJson

R

readInputFile(String) - Static method in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson: Reads the contents of the file at the specified location and converts them to a WorkflowJson representation
readInputStream(InputStream) - Static method in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson: Reads the the input stream and converts to a WorkflowJson representation
RegexConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing regex condition 'additional' property for use with task submitter application
RegexConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.RegexConditionAdditionalJson
removeMatchingWorkflows(ProcessingApisProvider, String, String) - Static method in class com.github.cafdataprocessing.utilities.initialization.WorkflowRemover: Removes any existing processing workflows (including processing rules etc under the workflow) under the specified projectId that match the name provided.
resolveExpressionIds(ArrayList) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Takes in an array of expression IDs, with each ID being either the expression ID or the name of the expression, and returns an array of resovled expression IDs.
resolveFromExpressionName(String) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Returns the boilerplate expression ID matching the provided name.
resolveFromTagName(String) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Returns the tag ID matching the provided name.
resolveFromWorkflowName(String) - Method in class com.github.cafdataprocessing.utilities.initialization.ClassificationWorkflowNameResolver: Resolves provided classification workflow name to matching ID.
resolveTagId(Object) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver: Takes an object which may be either a String (containing name of a tag) or an Integer/Long (containing ID of tag) and returns the appropriate tag ID.
ruleConditions - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
run() - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateInvoker: Run the configured boilerplate creation.
run(boolean) - Method in class com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateInvoker: Run the configured boilerplate creation.

S

setOverwriteExisting(boolean) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Set whether existing workflows under the projectId with the same name as the provided workflow should be removed.
settings - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
setWorkflowOverlayFileName(String) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Set Path to file containing extensions / overrides to merge with the base workflow.
setWorkflowOverlayStream(InputStream) - Method in class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Set InputStream containing extensions / overrides to merge with the base workflow.
StringConditionAdditionalJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions: JSON representation of a data processing string condition 'additional' property for use with task submitter application
StringConditionAdditionalJson() - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.StringConditionAdditionalJson

T

tags - Variable in class com.github.cafdataprocessing.utilities.initialization.boilerplate.CreationResultJson
toApiAction(Map<String, Long>) - Method in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
toApiBaseProcessingRule() - Method in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ProcessingRuleJson
toApiBaseWorkflow() - Method in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson
toApiCondition() - Method in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionJson
type - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.ConditionAdditionalJson
typeId - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson
typeName - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.ActionJson

V

value - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.DateConditionAdditionalJson
value - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.NumberConditionAdditionalJson
value - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.RegexConditionAdditionalJson
value - Variable in class com.github.cafdataprocessing.utilities.initialization.jsonobjects.conditions.StringConditionAdditionalJson
valueOf(String) - Static method in enum com.github.cafdataprocessing.utilities.initialization.jsonobjects.MergeMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.cafdataprocessing.utilities.initialization.jsonobjects.MergeMode: Returns an array containing the constants of this enum type, in the order they are declared.

W

WorkflowCombiner - Class in com.github.cafdataprocessing.utilities.initialization: Class responsible for merging of two workflow objects - a base one and other one with overrides and / or extensions.
WorkflowCombiner() - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowCombiner
WorkflowInitializationParams - Class in com.github.cafdataprocessing.utilities.initialization: Parameters to use for method calls to the WorkflowInitializer class.
WorkflowInitializationParams(String, String) - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Create the parameter object with required properties.
WorkflowInitializationParams(String, String, String) - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Create the parameter object with required properties.
WorkflowInitializationParams(InputStream, String) - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Create the parameter object with required properties.
WorkflowInitializationParams(InputStream, InputStream, String) - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams: Create the parameter object with required properties.
WorkflowInitializer - Class in com.github.cafdataprocessing.utilities.initialization: Responsible for creation of a data processing workflow using defined base data.
WorkflowInitializer(String, BoilerplateNameResolver, ActionTypeNameResolver, ClassificationWorkflowNameResolver) - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowInitializer: Create instance of WorkflowInitializer with provided parameters.
WorkflowJson - Class in com.github.cafdataprocessing.utilities.initialization.jsonobjects: JSON representation of a data processing workflow for use with task submitter application
WorkflowJson(String, String, String, List<ProcessingRuleJson>) - Constructor for class com.github.cafdataprocessing.utilities.initialization.jsonobjects.WorkflowJson
WorkflowRemover - Class in com.github.cafdataprocessing.utilities.initialization: Removes processing workflows (including its components) based on project ID and matching names in preparation for creating new workflows.
WorkflowRemover() - Constructor for class com.github.cafdataprocessing.utilities.initialization.WorkflowRemover

A B C D E F G I M N O P R S T V W