Package io.jmix.rest.transform

Class AbstractEntityJsonTransformer

java.lang.Object

io.jmix.rest.transform.AbstractEntityJsonTransformer

All Implemented Interfaces:

EntityJsonTransformer

Direct Known Subclasses:

StandardEntityJsonTransformer

public abstract class AbstractEntityJsonTransformer
extends Object
implements EntityJsonTransformer

Class containing a basic functionality of standard JSON transformer. It doest the following transformations:

• change entity name
• change attribute name
• remove attribute

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	attributesToRemove
protected Map<String,String>	attributesToRename
protected JsonTransformationDirection	direction
protected String	fromEntityName
protected RestJsonTransformations	jsonTransformations
protected static final org.slf4j.Logger	log
protected String	toEntityName
protected String	version

Constructor Summary

Constructors

Constructor	Description
AbstractEntityJsonTransformer(String fromEntityName, String toEntityName, String version, JsonTransformationDirection direction)

Method Summary

Modifier and Type	Method	Description
protected void	doCustomTransformations(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Override this method in the subclass to perform custom transformations
Set<String>	getAttributesToRemove()
Map<String,String>	getAttributesToRename()
JsonTransformationDirection	getDirection()
String	getFromEntityName()
String	getToEntityName()
String	getTransformedEntityName()
String	getVersion()
protected void	removeAttributes(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode)
protected void	renameAttributes(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode)
protected void	replaceEntityName(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode)
void	setAttributesToRemove(Set<String> attributesToRemove)
void	setAttributesToRename(Map<String,String> attributesToRename)
void	setDirection(JsonTransformationDirection direction)
void	setFromEntityName(String fromEntityName)
void	setToEntityName(String toEntityName)
void	setVersion(String version)
protected void	transformEntityJson(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
String	transformJson(String json)	Method checks whether the passed JSON is an array of entities and if so it executes the transformEntityJson(ObjectNode, ObjectMapper) method for each array element.
protected void	transformNestedToManyReferences(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
protected void	transformNestedToOneReferences(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final org.slf4j.Logger log

fromEntityName

protected String fromEntityName

toEntityName

protected String toEntityName

attributesToRename

protected Map<String,String> attributesToRename

version

protected String version

direction

protected JsonTransformationDirection direction

attributesToRemove

protected Set<String> attributesToRemove

jsonTransformations

@Autowired
protected RestJsonTransformations jsonTransformations

Constructor Details

AbstractEntityJsonTransformer

public AbstractEntityJsonTransformer(String fromEntityName,
 String toEntityName,
 String version,
 JsonTransformationDirection direction)

Method Details

getTransformedEntityName

public String getTransformedEntityName()

Specified by:

getTransformedEntityName in interface EntityJsonTransformer

transformJson

public String transformJson(String json)

Method checks whether the passed JSON is an array of entities and if so it executes the transformEntityJson(ObjectNode, ObjectMapper) method for each array element. Method executes the transformEntityJson(ObjectNode, ObjectMapper) method otherwise.

Specified by:

transformJson in interface EntityJsonTransformer

Parameters:

json - JSON containing an entity or a list of entities

Returns:

transformed JSON

transformEntityJson

protected void transformEntityJson(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)
                            throws IOException

Throws:

IOException

removeAttributes

protected void removeAttributes(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode)

transformNestedToOneReferences

protected void transformNestedToOneReferences(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)
                                       throws IOException

Throws:

IOException

transformNestedToManyReferences

protected void transformNestedToManyReferences(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)
                                        throws IOException

Throws:

IOException

renameAttributes

protected void renameAttributes(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode)

replaceEntityName

protected void replaceEntityName(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode)

doCustomTransformations

protected void doCustomTransformations(com.fasterxml.jackson.databind.node.ObjectNode rootObjectNode,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Override this method in the subclass to perform custom transformations

getFromEntityName

public String getFromEntityName()

setFromEntityName

public void setFromEntityName(String fromEntityName)

getToEntityName

public String getToEntityName()

setToEntityName

public void setToEntityName(String toEntityName)

getAttributesToRename

public Map<String,String> getAttributesToRename()

setAttributesToRename

public void setAttributesToRename(Map<String,String> attributesToRename)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getDirection

public JsonTransformationDirection getDirection()

setDirection

public void setDirection(JsonTransformationDirection direction)

getAttributesToRemove

public Set<String> getAttributesToRemove()

setAttributesToRemove

public void setAttributesToRemove(Set<String> attributesToRemove)