com.marklogic.hub.impl

Class MappingManagerImpl

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.hub.impl.MappingManagerImpl

All Implemented Interfaces:

MappingManager

@Component
public class MappingManagerImpl
extends com.marklogic.client.ext.helper.LoggingObject
implements MappingManager

Field Summary

Fields

Modifier and Type	Field and Description
protected HubConfig	hubConfig

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

logger

Fields inherited from interface com.marklogic.hub.MappingManager

MAPPING_FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
MappingManagerImpl()
MappingManagerImpl(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
Mapping	createMapping(java.lang.String mappingName) Creates a mapping given a string name
Mapping	createMapping(java.lang.String mappingName, java.lang.String entityName) Creates a mapping given a string name
Mapping	createMappingFromJSON(com.fasterxml.jackson.databind.JsonNode json) Creates a mapping from a given JsonNode
Mapping	createMappingFromJSON(java.lang.String json) Creates a mapping from a given JSON string
void	deleteMapping(java.lang.String mappingName) Deletes a defined mapping by string name
Mapping	getMapping(java.lang.String mappingName) Returns a mapping based on the provided name
Mapping	getMapping(java.lang.String mappingName, int version, boolean createIfNotExisted) Returns a mapping based on the provided name
java.lang.String	getMappingAsJSON(java.lang.String mappingName) Returns a mapping based on the provided name as JSON string
java.lang.String	getMappingAsJSON(java.lang.String mappingName, int version, boolean createIfNotExisted) Returns a mapping based on the provided name as JSON string
java.util.ArrayList<Mapping>	getMappings() Returns a list of all mappings currently defined
java.util.ArrayList<java.lang.String>	getMappingsNames() Returns a string list of names for all mappings currently defined
void	saveMapping(Mapping mapping) Saves a map to disk
void	saveMapping(Mapping mapping, boolean autoIncrement) Saves a map to disk, incrementing its version by 1

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

Field Detail

hubConfig

@Autowired
protected HubConfig hubConfig

Constructor Detail

MappingManagerImpl

public MappingManagerImpl()

MappingManagerImpl

public MappingManagerImpl(HubConfig hubConfig)

Method Detail

createMapping

public Mapping createMapping(java.lang.String mappingName)

Description copied from interface: MappingManager

Creates a mapping given a string name

Specified by:

createMapping in interface MappingManager

Parameters:

mappingName - - the base name of the mapping you want to create

Returns:

- a Mapping object

createMapping

public Mapping createMapping(java.lang.String mappingName,
                             java.lang.String entityName)

Description copied from interface: MappingManager

Creates a mapping given a string name

Specified by:

createMapping in interface MappingManager

Parameters:

mappingName - - the base name of the mapping you want to create

entityName - - the name of the entity being mapped to

Returns:

- a Mapping object

createMappingFromJSON

public Mapping createMappingFromJSON(java.lang.String json)
                              throws java.io.IOException

Description copied from interface: MappingManager

Creates a mapping from a given JSON string

Specified by:

createMappingFromJSON in interface MappingManager

Parameters:

json - - string representation of json

Returns:

- a Mapping object

Throws:

java.io.IOException - - thrown if mapping file cannot be found/read off disk

createMappingFromJSON

public Mapping createMappingFromJSON(com.fasterxml.jackson.databind.JsonNode json)

Description copied from interface: MappingManager

Creates a mapping from a given JsonNode

Specified by:

createMappingFromJSON in interface MappingManager

Parameters:

json - - JsonNode

Returns:

- a Mapping object

deleteMapping

public void deleteMapping(java.lang.String mappingName)

Description copied from interface: MappingManager

Deletes a defined mapping by string name

Specified by:

deleteMapping in interface MappingManager

Parameters:

mappingName - - the base-name of the mapping you want to delete as a string

saveMapping

public void saveMapping(Mapping mapping)

Description copied from interface: MappingManager

Saves a map to disk

Specified by:

saveMapping in interface MappingManager

Parameters:

mapping - - the mapping object to be saved

saveMapping

public void saveMapping(Mapping mapping,
                        boolean autoIncrement)

Description copied from interface: MappingManager

Saves a map to disk, incrementing its version by 1

Specified by:

saveMapping in interface MappingManager

Parameters:

mapping - the mapping object to be saved

autoIncrement - - true to increment version, false if not to

getMappingsNames

public java.util.ArrayList<java.lang.String> getMappingsNames()

Description copied from interface: MappingManager

Returns a string list of names for all mappings currently defined

Specified by:

getMappingsNames in interface MappingManager

Returns:

- A list of strings that represent mapping names

getMappings

public java.util.ArrayList<Mapping> getMappings()

Description copied from interface: MappingManager

Returns a list of all mappings currently defined

Specified by:

getMappings in interface MappingManager

Returns:

- an arraylist of ALL mapping objects from disk

getMapping

public Mapping getMapping(java.lang.String mappingName)

Description copied from interface: MappingManager

Returns a mapping based on the provided name

Specified by:

getMapping in interface MappingManager

Parameters:

mappingName - - the basename of the mapping

Returns:

Mapping object for the defined map

getMapping

public Mapping getMapping(java.lang.String mappingName,
                          int version,
                          boolean createIfNotExisted)

Description copied from interface: MappingManager

Returns a mapping based on the provided name

Specified by:

getMapping in interface MappingManager

Parameters:

mappingName - - name of the map

version - - the version of the mapping

createIfNotExisted - - create mapping object if true, otherwise throws exception

Returns:

Mapping object for the defined map

getMappingAsJSON

public java.lang.String getMappingAsJSON(java.lang.String mappingName)

Description copied from interface: MappingManager

Returns a mapping based on the provided name as JSON string

Specified by:

getMappingAsJSON in interface MappingManager

Parameters:

mappingName - - name of the mapping

Returns:

string json respresentation of the mapping object

getMappingAsJSON

public java.lang.String getMappingAsJSON(java.lang.String mappingName,
                                         int version,
                                         boolean createIfNotExisted)

Description copied from interface: MappingManager

Returns a mapping based on the provided name as JSON string

Specified by:

getMappingAsJSON in interface MappingManager

Parameters:

mappingName - - name of the mapping

version - - the version number of the mapping

createIfNotExisted - - create mapping object if true, otherwise throws exception

Returns:

string json respresentation of the mapping object