com.marklogic.hub.dataservices

Interface ModelsService

public interface ModelsService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	createDraftModel(com.fasterxml.jackson.databind.JsonNode input) Create a new draft model, resulting in a new entity descriptor with a primary entity type in it.
void	deleteDraftModel(java.lang.String entityName) Mark a draft entity model to be deleted
com.fasterxml.jackson.databind.JsonNode	generateDatabaseProperties(com.fasterxml.jackson.databind.JsonNode models) Returns a JSON object containing database properties based on entity models
com.fasterxml.jackson.databind.JsonNode	generateModelConfig() Invokes the generateModelConfig operation on the database server
com.fasterxml.jackson.databind.JsonNode	generateProtectedPathConfig(com.fasterxml.jackson.databind.JsonNode models) Generate a CMA config object with protected paths and query rolesets based on the 'pii' arrays in the given entity models
com.fasterxml.jackson.databind.JsonNode	getLatestJobData(java.lang.String entityCollection) Invokes the getLatestJobData operation on the database server
com.fasterxml.jackson.databind.JsonNode	getModelReferences(java.lang.String entityName, java.lang.String propertyName) Returns a json containing the names of the models and steps that reference the given entity model.
com.fasterxml.jackson.databind.JsonNode	getPrimaryEntityTypes(java.lang.Boolean includeDrafts) Returns an array of primary entity types.
static ModelsService	on(com.marklogic.client.DatabaseClient db) Creates a ModelsService object for executing operations on the database server.
static ModelsService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a ModelsService object for executing operations on the database server.
void	publishDraftModels() Moves draft entity models to the published collection and clear out the draft collection
void	saveDraftModel(com.fasterxml.jackson.databind.JsonNode model) Save a draft model, where the input is a JSON model
void	saveModels(com.fasterxml.jackson.databind.JsonNode models) Save an array of entity models to only the database associated with the app server that receives this request
void	updateDraftModelEntityTypes(com.fasterxml.jackson.databind.JsonNode input) Update entity model types in the entity models draft collection.
com.fasterxml.jackson.databind.JsonNode	updateDraftModelInfo(java.lang.String name, com.fasterxml.jackson.databind.JsonNode input) Update the description and optionally the namespace and namespace prefix of an existing model.

Method Detail

on

static ModelsService on(com.marklogic.client.DatabaseClient db)

Creates a ModelsService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads.

Parameters:

db - provides a client for communicating with the database server

Returns:

an object for executing database operations

on

static ModelsService on(com.marklogic.client.DatabaseClient db,
                        com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a ModelsService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads. The service declaration uses a custom implementation of the same service instead of the default implementation of the service by specifying an endpoint directory in the modules database with the implementation. A service.json file with the declaration can be read with FileHandle or a string serialization of the JSON declaration with StringHandle.

Parameters:

db - provides a client for communicating with the database server

serviceDeclaration - substitutes a custom implementation of the service

Returns:

an object for executing database operations

generateDatabaseProperties

com.fasterxml.jackson.databind.JsonNode generateDatabaseProperties(com.fasterxml.jackson.databind.JsonNode models)

Returns a JSON object containing database properties based on entity models

Parameters:

models - Array of entity models

Returns:

Object containing database properties

saveDraftModel

void saveDraftModel(com.fasterxml.jackson.databind.JsonNode model)

Save a draft model, where the input is a JSON model

Parameters:

model - provides input

deleteDraftModel

void deleteDraftModel(java.lang.String entityName)

Mark a draft entity model to be deleted

Parameters:

entityName - The name of the primary entity in the model

createDraftModel

com.fasterxml.jackson.databind.JsonNode createDraftModel(com.fasterxml.jackson.databind.JsonNode input)

Create a new draft model, resulting in a new entity descriptor with a primary entity type in it.

Parameters:

input - provides input

Returns:

as output

generateProtectedPathConfig

com.fasterxml.jackson.databind.JsonNode generateProtectedPathConfig(com.fasterxml.jackson.databind.JsonNode models)

Generate a CMA config object with protected paths and query rolesets based on the 'pii' arrays in the given entity models

Parameters:

models - Array of entity models

Returns:

as output

updateDraftModelInfo

com.fasterxml.jackson.databind.JsonNode updateDraftModelInfo(java.lang.String name,
                                                             com.fasterxml.jackson.databind.JsonNode input)

Update the description and optionally the namespace and namespace prefix of an existing model. Model title and version cannot yet be edited because doing so would break existing mapping and mastering configurations. Changes are saved to the entity model draft collection.

Parameters:

name - The name of the model

input - provides input

Returns:

as output

generateModelConfig

com.fasterxml.jackson.databind.JsonNode generateModelConfig()

Invokes the generateModelConfig operation on the database server

Returns:

as output

getPrimaryEntityTypes

com.fasterxml.jackson.databind.JsonNode getPrimaryEntityTypes(java.lang.Boolean includeDrafts)

Returns an array of primary entity types. A primary entity type is the entity type in a model descriptor with a name equal to the title of the model descriptor.

Parameters:

includeDrafts - Determines if draft models should be included. Default: false

Returns:

as output

saveModels

void saveModels(com.fasterxml.jackson.databind.JsonNode models)

Save an array of entity models to only the database associated with the app server that receives this request

Parameters:

models - The array of entity models

getModelReferences

com.fasterxml.jackson.databind.JsonNode getModelReferences(java.lang.String entityName,
                                                           java.lang.String propertyName)

Returns a json containing the names of the models and steps that reference the given entity model.

Parameters:

entityName - The name of the primary entity in the model

propertyName - The property in the primary entity in the model

Returns:

as output

publishDraftModels

void publishDraftModels()

Moves draft entity models to the published collection and clear out the draft collection

getLatestJobData

com.fasterxml.jackson.databind.JsonNode getLatestJobData(java.lang.String entityCollection)

Invokes the getLatestJobData operation on the database server

Parameters:

entityCollection - provides input

Returns:

as output

updateDraftModelEntityTypes

void updateDraftModelEntityTypes(com.fasterxml.jackson.databind.JsonNode input)

Update entity model types in the entity models draft collection.

Parameters:

input - provides input