Mapping (marklogic-data-hub 5.2.6 API)

All Known Implementing Classes:

MappingImpl
```
public interface Mapping
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static Mapping`	`create(java.lang.String mappingName)` Creates an in-memory default instance of a mapping given a name
`static Mapping`	`create(java.lang.String mappingName, HubEntity entity)` Creates an in-memory default instance of a mapping given a name
`Mapping`	`deserialize(com.fasterxml.jackson.databind.JsonNode json)` Deserializes a json response and applies it to this mapping
`java.lang.String`	`getDescription()` Returns a string description of what the mapping is/does
`java.lang.String`	`getLang()` Return the language key setting
`java.lang.String`	`getLanguage()` Deprecated.
`java.lang.String`	`getName()` Returns the name of the mapping as a string
`java.util.Map<java.lang.String,java.lang.String>`	`getNamespaces()` Gets the map of the namespaces for mapping
`java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode>`	`getProperties()` Gets the hashmap of the properties mapping
`java.lang.String`	`getSourceContext()` Returns the source context string for the mapping
`java.lang.String`	`getSourceURI()` Returns a URI of the mapping source document
`java.lang.String`	`getTargetEntityType()` Returns the IRI for the targeted entity type
`int`	`getVersion()` Returns the mapping version
`void`	`incrementVersion()` Automatically increments the version of the mapping by 1
`java.lang.String`	`serialize()` Serializes the mapping as a json string
`void`	`setDescription(java.lang.String description)` Set the description for the mapping
`void`	`setLang(java.lang.String lang)` CAREFUL - DO NOT TOUCH IF YOU DON'T EXPLICITLY KNOW WHAT THIS VALUE REPRESENTS Sets the language for the mapping to use for MarkLogic server
`void`	`setLanguage(java.lang.String language)` Deprecated.
`void`	`setName(java.lang.String name)` Sets the name of the mapping as a string
`void`	`setNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)` Sets the namespaces map for the mapping
`void`	`setProperties(java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> properties)` Sets the properties hashmap for the mapping
`void`	`setSourceContext(java.lang.String sourceContext)` Sets the source context for the mapping
`void`	`setSourceURI(java.lang.String sourceURI)` Set the URI for the mapping source document
`void`	`setTargetEntityType(java.lang.String targetEntityType)` Setting the IRI for the target entity type
`void`	`setVersion(int version)` Sets the version for the mapping

- Method Detail
  - create
```
static Mapping create(java.lang.String mappingName)
```
    Creates an in-memory default instance of a mapping given a name
    
    Parameters:
    
    mappingName - - the name of the mapping
    
    Returns:
    
    a Mapping object to manipulate further
  - create
```
static Mapping create(java.lang.String mappingName,
                      HubEntity entity)
```
    Creates an in-memory default instance of a mapping given a name
    
    Parameters:
    
    mappingName - - the name of the mapping
    
    entity - - the entity the mapping is targeting
    
    Returns:
    
    a Mapping object to manipulate further
  - getVersion
```
int getVersion()
```
    Returns the mapping version
    
    Returns:
    
    mapping version
  - setVersion
```
void setVersion(int version)
```
    Sets the version for the mapping
    
    Parameters:
    
    version - - a whole integer representing the version of the mapping
  - getNamespaces
```
java.util.Map<java.lang.String,java.lang.String> getNamespaces()
```
    Gets the map of the namespaces for mapping
    
    Returns:
    
    a map of all the namespace prefixes and their full URIs
  - setNamespaces
```
void setNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
```
    Sets the namespaces map for the mapping
    
    Parameters:
    
    namespaces - - map of namespace prefixes and their full URIs for the mapping
  - getProperties
```
java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> getProperties()
```
    Gets the hashmap of the properties mapping
    
    Returns:
    
    a hashmap of all the properties that have been mapped
  - setProperties
```
void setProperties(java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> properties)
```
    Sets the properties hashmap for the mapping
    
    Parameters:
    
    properties - - hashmap of properties and their settings for the mapping
  - getName
```
java.lang.String getName()
```
    Returns the name of the mapping as a string
    
    Returns:
    
    name of the mapping as a string
  - setName
```
void setName(java.lang.String name)
```
    Sets the name of the mapping as a string
    
    Parameters:
    
    name - - the name of the mapping (warning: be careful of name changes)
  - getSourceContext
```
java.lang.String getSourceContext()
```
    Returns the source context string for the mapping
    
    Returns:
    
    string representation of source context
  - setSourceContext
```
void setSourceContext(java.lang.String sourceContext)
```
    Sets the source context for the mapping
    
    Parameters:
    
    sourceContext - - the xpath to start the mapping from inside the root of the documents
  - getTargetEntityType
```
java.lang.String getTargetEntityType()
```
    Returns the IRI for the targeted entity type
    
    Returns:
    
    - IRI as string for what entity this mapping is targeted towards
  - setTargetEntityType
```
void setTargetEntityType(java.lang.String targetEntityType)
```
    Setting the IRI for the target entity type
    
    Parameters:
    
    targetEntityType - - the IRI of the entity you want this mapping to use
  - getDescription
```
java.lang.String getDescription()
```
    Returns a string description of what the mapping is/does
    
    Returns:
    
    a string description
  - setDescription
```
void setDescription(java.lang.String description)
```
    Set the description for the mapping
    
    Parameters:
    
    description - - a short description of what this mapping's purpose is
  - getSourceURI
```
java.lang.String getSourceURI()
```
    Returns a URI of the mapping source document
    
    Returns:
    
    a source URI
  - setSourceURI
```
void setSourceURI(java.lang.String sourceURI)
```
    Set the URI for the mapping source document
    
    Parameters:
    
    sourceURI - - a source URI
  - getLanguage
```
@Deprecated
java.lang.String getLanguage()
```
    Deprecated.
    
    Return the language key setting
    
    Returns:
    
    the string key
  - getLang
```
java.lang.String getLang()
```
    Return the language key setting
    
    Returns:
    
    the string key
  - setLanguage
```
@Deprecated
void setLanguage(java.lang.String language)
```
    Deprecated.
    
    *CAREFUL - DO NOT TOUCH IF YOU DON'T EXPLICITLY KNOW WHAT THIS VALUE REPRESENTS* Sets the language for the mapping to use for MarkLogic server
    
    Parameters:
    
    language - - sets the language key for the server - don't modify please!
  - setLang
```
void setLang(java.lang.String lang)
```
    *CAREFUL - DO NOT TOUCH IF YOU DON'T EXPLICITLY KNOW WHAT THIS VALUE REPRESENTS* Sets the language for the mapping to use for MarkLogic server
    
    Parameters:
    
    lang - - sets the language key for the server - don't modify please!
  - serialize
```
java.lang.String serialize()
```
    Serializes the mapping as a json string
    
    Returns:
    
    the serialized JSON string
  - deserialize
```
Mapping deserialize(com.fasterxml.jackson.databind.JsonNode json)
```
    Deserializes a json response and applies it to this mapping
    
    Parameters:
    
    json - - the jsonnode you want deserialized
    
    Returns:
    
    this mapping
  - incrementVersion
```
void incrementVersion()
```
    Automatically increments the version of the mapping by 1

Interface Mapping

Method Summary

Method Detail

create

create

getVersion

setVersion

getNamespaces

setNamespaces

getProperties

setProperties

getName

setName

getSourceContext

setSourceContext

getTargetEntityType

setTargetEntityType

getDescription

setDescription

getSourceURI

setSourceURI

getLanguage

getLang

setLanguage

setLang

serialize

deserialize

incrementVersion