com.marklogic.hub.impl

Class EntityManagerImpl

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.hub.impl.EntityManagerImpl

All Implemented Interfaces:

EntityManager

@Component
public class EntityManagerImpl
extends com.marklogic.client.ext.helper.LoggingObject
implements EntityManager

Field Summary

Fields inherited from class com.marklogic.client.ext.helper.LoggingObject

logger

Constructor Summary

Constructors

Constructor and Description
EntityManagerImpl()
EntityManagerImpl(HubConfig hubConfig) For use outside of a Spring container.

Method Summary

Modifier and Type	Method and Description
protected void	addSubProperties(HubEntity entity, java.util.List<HubEntity> entityDefinitions, java.lang.String version) Adds "sub" properties - i.e.
protected java.util.List<HubEntity>	convertModelFilesToEntityDefinitions(java.util.List<HubEntity> modelFilesInProject) An entity model file can contain one to many entity definitions.
void	deleteEntity(java.lang.String entity)
boolean	deployFinalQueryOptions()
java.util.HashMap<java.lang.Enum,java.lang.Boolean>	deployQueryOptions() Deploys the query option
boolean	deployStagingQueryOptions()
void	generateExplorerQueryOptions() Updates the explorer query options to the file system
java.util.List<HubEntity>	getEntities()
java.util.List<HubEntity>	getEntities(java.lang.Boolean extendSubEntities)
protected HubEntity	getEntityFromEntityDefinitions(java.lang.String entityName, java.util.List<HubEntity> entityDefinitions, java.lang.String version, java.lang.Boolean extendSubEntities)
HubEntity	getEntityFromProject(java.lang.String entityName)
HubEntity	getEntityFromProject(java.lang.String entityName, java.lang.Boolean extendSubEntities)
protected HubEntity	getEntityFromProject(java.lang.String entityName, java.util.List<HubEntity> modelFilesInProject, java.lang.String version, java.lang.Boolean extendSubEntities) Extracted for unit testing so that it doesn't depend on entity model files existing within a project directory structure.
HubEntity	getEntityFromProject(java.lang.String entityName, java.lang.String version)
HubEntity	getEntityFromProject(java.lang.String entityName, java.lang.String version, java.lang.Boolean extendSubEntities)
protected void	removeCollationFromEntityReferenceProperties(com.fasterxml.jackson.databind.JsonNode node) Per DHFPROD-3472, when a property in QS is changed to an entity reference, a collation is still defined for it.
boolean	saveDbIndexes() Updates the indexes for the entity on the filesystem
HubEntity	saveEntity(HubEntity entity, java.lang.Boolean rename)
boolean	savePii() Scans the entities in the project for pii properties, and saves the required ELS configurations to support those properties.
boolean	saveQueryOptions() Updates the query options to the file system

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject

format

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityManagerImpl

public EntityManagerImpl()

EntityManagerImpl

public EntityManagerImpl(HubConfig hubConfig)

For use outside of a Spring container.

Parameters:

hubConfig -

Method Detail

saveQueryOptions

public boolean saveQueryOptions()

Description copied from interface: EntityManager

Updates the query options to the file system

Specified by:

saveQueryOptions in interface EntityManager

Returns:

boolean - if it fails to so, false is returned

generateExplorerQueryOptions

public void generateExplorerQueryOptions()

Description copied from interface: EntityManager

Updates the explorer query options to the file system

Specified by:

generateExplorerQueryOptions in interface EntityManager

deployQueryOptions

public java.util.HashMap<java.lang.Enum,java.lang.Boolean> deployQueryOptions()

Description copied from interface: EntityManager

Deploys the query option

Specified by:

deployQueryOptions in interface EntityManager

Returns:

hashmap - ENUM DatabaseKind of what database and boolean if the deploy was successful or not.

deployFinalQueryOptions

public boolean deployFinalQueryOptions()

Specified by:

deployFinalQueryOptions in interface EntityManager

deployStagingQueryOptions

public boolean deployStagingQueryOptions()

Specified by:

deployStagingQueryOptions in interface EntityManager

saveDbIndexes

public boolean saveDbIndexes()

Description copied from interface: EntityManager

Updates the indexes for the entity on the filesystem

Specified by:

saveDbIndexes in interface EntityManager

Returns:

boolean - if it fails to do so, false is returned

getEntityFromProject

public HubEntity getEntityFromProject(java.lang.String entityName)

Specified by:

getEntityFromProject in interface EntityManager

getEntityFromProject

public HubEntity getEntityFromProject(java.lang.String entityName,
                                      java.lang.String version)

Specified by:

getEntityFromProject in interface EntityManager

getEntityFromProject

public HubEntity getEntityFromProject(java.lang.String entityName,
                                      java.lang.Boolean extendSubEntities)

Specified by:

getEntityFromProject in interface EntityManager

getEntityFromProject

public HubEntity getEntityFromProject(java.lang.String entityName,
                                      java.lang.String version,
                                      java.lang.Boolean extendSubEntities)

Specified by:

getEntityFromProject in interface EntityManager

getEntityFromProject

protected HubEntity getEntityFromProject(java.lang.String entityName,
                                         java.util.List<HubEntity> modelFilesInProject,
                                         java.lang.String version,
                                         java.lang.Boolean extendSubEntities)

Extracted for unit testing so that it doesn't depend on entity model files existing within a project directory structure. This method also "flattens" the entity models that are passed into it. Currently, the entity title and version number are used to uniquely reference an entity definition - unless version is null, in which case only the entity title is used to reference an entity definition.

Parameters:

entityName -

modelFilesInProject -

version -

extendSubEntities -

Returns:

getEntityFromEntityDefinitions

protected HubEntity getEntityFromEntityDefinitions(java.lang.String entityName,
                                                   java.util.List<HubEntity> entityDefinitions,
                                                   java.lang.String version,
                                                   java.lang.Boolean extendSubEntities)

Parameters:

entityName -

entityDefinitions - each HubEntity in this list is expected to have a single definition in it. In addition, the order of these definitions matters in case the version parameter is null.

version -

extendSubEntities -

Returns:

convertModelFilesToEntityDefinitions

protected java.util.List<HubEntity> convertModelFilesToEntityDefinitions(java.util.List<HubEntity> modelFilesInProject)

An entity model file can contain one to many entity definitions. This method then produces a list of HubEntity instances, where each instance has a single entity definition. The filename is preserved on each HubEntity, but the InfoType/Title property is modified to match that of the single entity definition that the HubEntity contains.

Parameters:

modelFilesInProject -

Returns:

addSubProperties

protected void addSubProperties(HubEntity entity,
                                java.util.List<HubEntity> entityDefinitions,
                                java.lang.String version)

Adds "sub" properties - i.e. each complex property type is expanded so that it contains all of the properties from the referenced entity definition type. This is a recursive method, thus ensuring that properties are added at any depth of nested entities.

Parameters:

entity -

entityDefinitions -

version -

getEntities

public java.util.List<HubEntity> getEntities()

Specified by:

getEntities in interface EntityManager

getEntities

public java.util.List<HubEntity> getEntities(java.lang.Boolean extendSubEntities)

Specified by:

getEntities in interface EntityManager

saveEntity

public HubEntity saveEntity(HubEntity entity,
                            java.lang.Boolean rename)
                     throws java.io.IOException

Specified by:

saveEntity in interface EntityManager

Throws:

java.io.IOException

removeCollationFromEntityReferenceProperties

protected void removeCollationFromEntityReferenceProperties(com.fasterxml.jackson.databind.JsonNode node)

Per DHFPROD-3472, when a property in QS is changed to an entity reference, a collation is still defined for it. This method removes the collation for any property that is an entity reference.

Parameters:

node -

deleteEntity

public void deleteEntity(java.lang.String entity)

Specified by:

deleteEntity in interface EntityManager

savePii

public boolean savePii()

Description copied from interface: EntityManager

Scans the entities in the project for pii properties, and saves the required ELS configurations to support those properties.

Specified by:

savePii in interface EntityManager

Returns:

- true if successfully saved, false if it did not