org.finra.herd.service.helper

Class TagHelper

java.lang.Object

org.finra.herd.service.helper.TagHelper

@Component
public class TagHelper
extends Object

A helper class for Tag related code

Constructor Summary

Constructors

Constructor and Description
TagHelper()

Method Summary

Modifier and Type	Method and Description
void	executeFunctionForTagEntities(String indexName, String documentType, List<TagEntity> tagEntities, QuadConsumer<String,String,String,String> function) Executes a function for tag entities.
String	safeObjectMapperWriteValueAsString(TagEntity tagEntity) Wrapper method that will safely call the object mapper write value as string method and handle the JsonProcessingException.
void	validateTagKey(TagKey tagKey) Validates a tag key.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagHelper

public TagHelper()

Method Detail

executeFunctionForTagEntities

public void executeFunctionForTagEntities(String indexName,
                                          String documentType,
                                          List<TagEntity> tagEntities,
                                          QuadConsumer<String,String,String,String> function)

Executes a function for tag entities.

Parameters:

indexName - the name of the index

documentType - the document type

tagEntities - the list of tag entities

function - the function to apply to all tags

safeObjectMapperWriteValueAsString

public String safeObjectMapperWriteValueAsString(TagEntity tagEntity)

Wrapper method that will safely call the object mapper write value as string method and handle the JsonProcessingException. This wrapper is needed so that we can do the object mapping within a Java stream.

Parameters:

tagEntity - the entity to convert to JSON

Returns:

JSON string value of the object

validateTagKey

public void validateTagKey(TagKey tagKey)
                    throws IllegalArgumentException

Validates a tag key. This method also trims the key parameters.

Parameters:

tagKey - the tag key

Throws:

IllegalArgumentException - if any validation errors were found