com.adobe.aemds.guide.utils

Class TranslationUtils

java.lang.Object

com.adobe.aemds.guide.utils.TranslationUtils

public class TranslationUtils
extends Object

Utility helper functions for translation.

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.databind.ObjectMapper	mapper
static String	PN_TRANSLATION_IDS
static String	TRANSLATION_TOKEN

Method Summary

Modifier and Type	Method and Description
static void	addPropertyToTranslationIds(org.apache.sling.api.resource.Resource resource, String propertyName, String dictKeyForPropertyName) Adds the given dictionary key to the resource value map
static String	get(String path, String propertyOrObjectKey, Integer index, boolean isProperty) Returns unique dictionary key based on path and property provided.
static String	get(String path, String propertyOrObjectKey, Integer index, boolean isProperty, String originalKey) Returns unique dictionary key based on path and property provided.
static String	getDictionaryPath(org.apache.sling.api.resource.ResourceResolver resourceResolver, String guideContainerPath) Returns path to the old or new dictionary based on the container path provided
static javax.jcr.Node	getOrAddDictionaryNode(org.apache.sling.api.resource.ResourceResolver resolver, String containerPath) Returns or adds dictionary node based on the adaptive form container path provided
static String	getTranslationId(org.apache.sling.api.resource.Resource resource, String propertyName, String propertyValue) Returns translation id for the property name and property value
static String	getTranslationId(org.apache.sling.api.resource.Resource resource, String propertyName, String propertyValue, boolean checkArray) Returns translation id for the property name and property value
static String	getTranslationId(org.apache.sling.api.resource.ValueMap properties, String propertyName, String propertyValue) Returns translation id for the property name and property value
static String	getTranslationId(org.apache.sling.api.resource.ValueMap properties, String propertyName, String propertyValue, boolean checkArray) Returns translation id for the property name and property value
static boolean	isNewTranslation(org.apache.sling.api.resource.Resource resource) Checks if the given resource use's new translation technique (unique keys for each property)
static boolean	isNewTranslation(org.apache.sling.api.resource.ValueMap properties) Checks if the given resource use's new translation technique (unique keys for each property)
static void	removePropertyFromTranslationIds(org.apache.sling.api.resource.Resource resource, String propertyName) Deletes the given dictionary key from the resource value map

Field Detail

TRANSLATION_TOKEN

public static final String TRANSLATION_TOKEN

See Also:

Constant Field Values

PN_TRANSLATION_IDS

public static final String PN_TRANSLATION_IDS

See Also:

Constant Field Values

mapper

public static final com.fasterxml.jackson.databind.ObjectMapper mapper

Method Detail

get

public static String get(String path,
                         String propertyOrObjectKey,
                         Integer index,
                         boolean isProperty,
                         String originalKey)

Returns unique dictionary key based on path and property provided. Additionally for array types, index could be provided.

Parameters:

path - path of the current object from its parent

propertyOrObjectKey - property or name of the object

index - index, if property value is of type array

isProperty - isProperty, true if the key is a property

originalKey - existing dictionary key, if a random id is not provided

Returns:

unique dictionary key

get

public static String get(String path,
                         String propertyOrObjectKey,
                         Integer index,
                         boolean isProperty)

Returns unique dictionary key based on path and property provided. Additionally for array types, index could be provided.

Parameters:

path - path of the current object from its parent

propertyOrObjectKey - property or name of the object

index - index, if property value is of type array

isProperty - isProperty, true if the key is a property

Returns:

unique dictionary key

getDictionaryPath

public static String getDictionaryPath(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                       String guideContainerPath)

Returns path to the old or new dictionary based on the container path provided

Parameters:

resourceResolver - reference to the ResourceResolver

guideContainerPath - path to the form container

Returns:

path to the dictionary

getOrAddDictionaryNode

public static javax.jcr.Node getOrAddDictionaryNode(org.apache.sling.api.resource.ResourceResolver resolver,
                                                    String containerPath)
                                             throws javax.jcr.RepositoryException

Returns or adds dictionary node based on the adaptive form container path provided

Parameters:

resolver - reference to the ResourceResolver

containerPath - path to the form container

Returns:

returns dicitionary node or add's one if it does not exist

Throws:

javax.jcr.RepositoryException

getTranslationId

public static String getTranslationId(org.apache.sling.api.resource.ValueMap properties,
                                      String propertyName,
                                      String propertyValue,
                                      boolean checkArray)
                               throws IOException

Returns translation id for the property name and property value

Parameters:

properties - reference to the properties ValueMap

propertyName - name of the property

propertyValue - property value

checkArray - if property value is of array type, this should be true

Returns:

translation id of the property name stored in the resource

Throws:

IOException

getTranslationId

public static String getTranslationId(org.apache.sling.api.resource.ValueMap properties,
                                      String propertyName,
                                      String propertyValue)
                               throws IOException

Returns translation id for the property name and property value

Parameters:

properties - reference to the properties ValueMap

propertyName - name of the property

propertyValue - property value

Returns:

translation id of the property name stored in the resource

Throws:

IOException

isNewTranslation

public static boolean isNewTranslation(org.apache.sling.api.resource.ValueMap properties)

Checks if the given resource use's new translation technique (unique keys for each property)

Parameters:

properties - reference to the ValueMap

Returns:

true for new translation technique

isNewTranslation

public static boolean isNewTranslation(org.apache.sling.api.resource.Resource resource)

Checks if the given resource use's new translation technique (unique keys for each property)

Parameters:

resource - reference to the Resource

Returns:

true for new translation technique

getTranslationId

public static String getTranslationId(org.apache.sling.api.resource.Resource resource,
                                      String propertyName,
                                      String propertyValue)
                               throws IOException

Returns translation id for the property name and property value

Parameters:

resource - reference to the resource Resource

propertyName - name of the property

propertyValue - property value

Returns:

translation id of the property name stored in the resource

Throws:

IOException

getTranslationId

public static String getTranslationId(org.apache.sling.api.resource.Resource resource,
                                      String propertyName,
                                      String propertyValue,
                                      boolean checkArray)
                               throws IOException

Returns translation id for the property name and property value

Parameters:

resource - reference to the resource Resource

propertyName - name of the property

propertyValue - property value

checkArray - if property value is of array type, this should be true

Returns:

translation id of the property name stored in the resource

Throws:

IOException

addPropertyToTranslationIds

public static void addPropertyToTranslationIds(org.apache.sling.api.resource.Resource resource,
                                               String propertyName,
                                               String dictKeyForPropertyName)
                                        throws IOException,
                                               javax.jcr.RepositoryException

Adds the given dictionary key to the resource value map

Parameters:

resource - reference to the Resource

propertyName - name of the property

dictKeyForPropertyName - dictionary key for the property

Throws:

IOException

javax.jcr.RepositoryException

removePropertyFromTranslationIds

public static void removePropertyFromTranslationIds(org.apache.sling.api.resource.Resource resource,
                                                    String propertyName)
                                             throws IOException,
                                                    javax.jcr.RepositoryException

Deletes the given dictionary key from the resource value map

Parameters:

resource - reference to the Resource

propertyName - name of the property

Throws:

IOException

javax.jcr.RepositoryException