com.marklogic.hub

Interface EntityManager

All Known Implementing Classes:

EntityManagerImpl

public interface EntityManager

Manages existing entities' MarkLogic Server database index settings and query options.

Method Summary

Modifier and Type	Method and Description
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)
HubEntity	getEntityFromProject(java.lang.String entityName)
HubEntity	getEntityFromProject(java.lang.String entityName, java.lang.Boolean extendSubEntities)
HubEntity	getEntityFromProject(java.lang.String entityName, java.lang.String version)
HubEntity	getEntityFromProject(java.lang.String entityName, java.lang.String version, java.lang.Boolean extendSubEntities)
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

Method Detail

saveQueryOptions

boolean saveQueryOptions()

Updates the query options to the file system

Returns:

boolean - if it fails to so, false is returned

generateExplorerQueryOptions

void generateExplorerQueryOptions()

Updates the explorer query options to the file system

deployQueryOptions

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

Deploys the query option

Returns:

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

saveDbIndexes

boolean saveDbIndexes()

Updates the indexes for the entity on the filesystem

Returns:

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

savePii

boolean savePii()

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

Returns:

- true if successfully saved, false if it did not

deployFinalQueryOptions

boolean deployFinalQueryOptions()

deployStagingQueryOptions

boolean deployStagingQueryOptions()

getEntityFromProject

HubEntity getEntityFromProject(java.lang.String entityName)

getEntityFromProject

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

getEntityFromProject

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

getEntityFromProject

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

getEntities

java.util.List<HubEntity> getEntities()

getEntities

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

saveEntity

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

Throws:

java.io.IOException

deleteEntity

void deleteEntity(java.lang.String entity)
           throws java.io.IOException

Throws:

java.io.IOException