com.marklogic.hub.dataservices

Interface MappingService

public interface MappingService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
void	generateMappingTransforms() Generates a transform in the modules database for each legacy mapping or mapping step
com.fasterxml.jackson.databind.JsonNode	getDocument(java.lang.String stepName, java.lang.String uri) Gets the document based on the given URI from the source database associated with the given step name
com.fasterxml.jackson.databind.JsonNode	getEntitiesForMapping(java.lang.String entityName) Gets the specified entity model and all its related entity models
com.fasterxml.jackson.databind.JsonNode	getMappingFunctions() Invokes the getMappingFunctions operation on the database server.
com.fasterxml.jackson.databind.JsonNode	getMappingFunctions(java.lang.Boolean excludeMLMappingFunctions) Invokes the getMappingFunctions operation on the database server
com.fasterxml.jackson.databind.JsonNode	getReferences(java.lang.String stepName) Gets the references associated with given mapping step name.
com.fasterxml.jackson.databind.JsonNode	getUris(java.lang.String stepName, java.lang.Integer limit) Gets the list of URIs that match the 'sourceQuery' from source db associated with given step name.
static MappingService	on(com.marklogic.client.DatabaseClient db) Creates a MappingService object for executing operations on the database server.
static MappingService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a MappingService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	testMapping(java.lang.String uri, java.lang.String database, com.fasterxml.jackson.databind.JsonNode jsonMapping) Invokes the testMapping operation on the database server

Method Detail

on

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

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

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

getReferences

com.fasterxml.jackson.databind.JsonNode getReferences(java.lang.String stepName)

Gets the references associated with given mapping step name.

Parameters:

stepName - provides input

Returns:

An array of objects, where each object has a reference name and an optional description

getEntitiesForMapping

com.fasterxml.jackson.databind.JsonNode getEntitiesForMapping(java.lang.String entityName)

Gets the specified entity model and all its related entity models

Parameters:

entityName - provides input

Returns:

as output

testMapping

com.fasterxml.jackson.databind.JsonNode testMapping(java.lang.String uri,
                                                    java.lang.String database,
                                                    com.fasterxml.jackson.databind.JsonNode jsonMapping)

Invokes the testMapping operation on the database server

Parameters:

uri - provides input

database - provides input

jsonMapping - provides input

Returns:

as output

getDocument

com.fasterxml.jackson.databind.JsonNode getDocument(java.lang.String stepName,
                                                    java.lang.String uri)

Gets the document based on the given URI from the source database associated with the given step name

Parameters:

stepName - provides input

uri - provides input

Returns:

as output

getUris

com.fasterxml.jackson.databind.JsonNode getUris(java.lang.String stepName,
                                                java.lang.Integer limit)

Gets the list of URIs that match the 'sourceQuery' from source db associated with given step name. The uri count is specified by 'limit' parameter

Parameters:

stepName - provides input

limit - provides input

Returns:

as output

generateMappingTransforms

void generateMappingTransforms()

Generates a transform in the modules database for each legacy mapping or mapping step

getMappingFunctions

com.fasterxml.jackson.databind.JsonNode getMappingFunctions(java.lang.Boolean excludeMLMappingFunctions)

Invokes the getMappingFunctions operation on the database server

Parameters:

excludeMLMappingFunctions - provides input

Returns:

as output

getMappingFunctions

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

Invokes the getMappingFunctions operation on the database server. This will include ML Mapping Functions. Keeping this method for compatibility with DHCCE.

Parameters:

excludeMLMappingFunctions - provides input

Returns:

as output