com.marklogic.hub

Interface MappingManager

All Known Implementing Classes:

MappingManagerImpl

public interface MappingManager

Handles the artifacts associated with mapping of source documents into entity services models.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAPPING_FILE_EXTENSION String value for the mapping file extension

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 incrementVersion) Saves a map to disk, incrementing its version by 1

Field Detail

MAPPING_FILE_EXTENSION

static final java.lang.String MAPPING_FILE_EXTENSION

String value for the mapping file extension

See Also:

Constant Field Values

Method Detail

createMapping

Mapping createMapping(java.lang.String mappingName)

Creates a mapping given a string name

Parameters:

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

Returns:

- a Mapping object

createMapping

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

Creates a mapping given a string name

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

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

Creates a mapping from a given JSON string

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

Mapping createMappingFromJSON(com.fasterxml.jackson.databind.JsonNode json)
                       throws java.io.IOException

Creates a mapping from a given JsonNode

Parameters:

json - - JsonNode

Returns:

- a Mapping object

Throws:

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

saveMapping

void saveMapping(Mapping mapping)

Saves a map to disk

Parameters:

mapping - - the mapping object to be saved

saveMapping

void saveMapping(Mapping mapping,
                 boolean incrementVersion)

Saves a map to disk, incrementing its version by 1

Parameters:

mapping - the mapping object to be saved

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

deleteMapping

void deleteMapping(java.lang.String mappingName)

Deletes a defined mapping by string name

Parameters:

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

getMappings

java.util.ArrayList<Mapping> getMappings()

Returns a list of all mappings currently defined

Returns:

- an arraylist of ALL mapping objects from disk

getMappingsNames

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

Returns a string list of names for all mappings currently defined

Returns:

- A list of strings that represent mapping names

getMapping

Mapping getMapping(java.lang.String mappingName)

Returns a mapping based on the provided name

Parameters:

mappingName - - the basename of the mapping

Returns:

Mapping object for the defined map

getMapping

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

Returns a mapping based on the provided name

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

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

Returns a mapping based on the provided name as JSON string

Parameters:

mappingName - - name of the mapping

Returns:

string json respresentation of the mapping object

getMappingAsJSON

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

Returns a mapping based on the provided name as JSON string

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