com.marklogic.hub.dataservices

Interface ConceptService

public interface ConceptService

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 Concept descriptor.
void	deleteDraftModel(java.lang.String conceptName) Mark a draft concept class to be deleted
com.fasterxml.jackson.databind.JsonNode	getModelReferences(java.lang.String conceptName) Returns a json containing the names of the entities that reference the given concept class.
static ConceptService	on(com.marklogic.client.DatabaseClient db) Creates a ConceptService object for executing operations on the database server.
static ConceptService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a ConceptService object for executing operations on the database server.
void	saveConceptModels(com.fasterxml.jackson.databind.JsonNode models) Save an array of concept models
com.fasterxml.jackson.databind.JsonNode	updateDraftModelInfo(java.lang.String name, com.fasterxml.jackson.databind.JsonNode input) Update the description of an existing concept class.

Method Detail

on

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

Creates a ConceptService 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 ConceptService on(com.marklogic.client.DatabaseClient db,
                         com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a ConceptService 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

updateDraftModelInfo

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

Update the description of an existing concept class. Concept name cannot yet be edited because doing so would break existing mapping and mastering configurations. Changes are saved to the concept class draft collection.

Parameters:

name - The name of the model

input - provides input

Returns:

as output

deleteDraftModel

void deleteDraftModel(java.lang.String conceptName)

Mark a draft concept class to be deleted

Parameters:

conceptName - The name of the concept in the model

saveConceptModels

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

Save an array of concept models

Parameters:

models - The array of concept models

createDraftModel

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

Create a new draft model, resulting in a new Concept descriptor.

Parameters:

input - provides input

Returns:

as output

getModelReferences

com.fasterxml.jackson.databind.JsonNode getModelReferences(java.lang.String conceptName)

Returns a json containing the names of the entities that reference the given concept class.

Parameters:

conceptName - The name of the concept class

Returns:

as output