com.github.cafdataprocessing.utilities.initialization.boilerplate

Class BoilerplateNameResolver

java.lang.Object

com.github.cafdataprocessing.utilities.initialization.boilerplate.BoilerplateNameResolver

public class BoilerplateNameResolver
extends Object

Resolves boilerplate expression and tag names to their IDs

Constructor Summary

Constructors

Constructor and Description
BoilerplateNameResolver(com.hpe.caf.boilerplate.webcaller.ApiClient apiClient) Creates new instance of BoilerplateNameResolver

Method Summary

Modifier and Type	Method and Description
void	populateExpressionsFromApiCall() Populates the known mapping of expression names to expression IDs by querying the boilerplate API for all existing expressions.
void	populateExpressionsFromApiCall(String projectId)
void	populateFromCreationResult(CreationResultJson boilerplateCreationResult) Records the names and IDs from the provided creation result for use in later resolution.
void	populateTagsFromApiCall() Populates the known mapping of tag names to tag IDs by querying the boilerplate API for all existing tags.
List<Object>	resolveExpressionIds(ArrayList expressionIdsObj) 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.
Long	resolveFromExpressionName(String expressionName) Returns the boilerplate expression ID matching the provided name.
Long	resolveFromTagName(String tagName) Returns the tag ID matching the provided name.
Object	resolveTagId(Object tagId) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoilerplateNameResolver

public BoilerplateNameResolver(com.hpe.caf.boilerplate.webcaller.ApiClient apiClient)

Creates new instance of BoilerplateNameResolver

Parameters:

apiClient - ApiClient to use to create BoilerplateApi which will be contacted to resolve unknown names.

Method Detail

populateFromCreationResult

public void populateFromCreationResult(CreationResultJson boilerplateCreationResult)

Records the names and IDs from the provided creation result for use in later resolution.

Parameters:

boilerplateCreationResult - Creation Result with boilerplate expression/tag names and IDs.

populateExpressionsFromApiCall

public void populateExpressionsFromApiCall(String projectId)
                                    throws com.hpe.caf.boilerplate.webcaller.ApiException

Throws:

com.hpe.caf.boilerplate.webcaller.ApiException

populateExpressionsFromApiCall

public void populateExpressionsFromApiCall()
                                    throws com.hpe.caf.boilerplate.webcaller.ApiException

Populates the known mapping of expression names to expression IDs by querying the boilerplate API for all existing expressions.

Throws:

com.hpe.caf.boilerplate.webcaller.ApiException - Thrown if there is an error communicating with the API or if error response received from API.

populateTagsFromApiCall

public void populateTagsFromApiCall()
                             throws com.hpe.caf.boilerplate.webcaller.ApiException

Populates the known mapping of tag names to tag IDs by querying the boilerplate API for all existing tags.

Throws:

com.hpe.caf.boilerplate.webcaller.ApiException - Thrown if there is an error communicating with the API or if error response received from API.

resolveFromTagName

public Long resolveFromTagName(String tagName)

Returns the tag ID matching the provided name.

Parameters:

tagName - Name to get ID for.

Returns:

ID matching the passed name.

resolveFromExpressionName

public Long resolveFromExpressionName(String expressionName)

Returns the boilerplate expression ID matching the provided name.

Parameters:

expressionName - Name to get ID for.

Returns:

ID matching the passed name.

resolveExpressionIds

public List<Object> resolveExpressionIds(ArrayList expressionIdsObj)

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.

Parameters:

expressionIdsObj - Array of numeric IDs and expression names.

Returns:

Array of numeric IDs with any names converted to their appropriate IDs.

resolveTagId

public Object resolveTagId(Object tagId)

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.

Parameters:

tagId - Possible tag name or ID.

Returns:

Matching tag ID.