public interface Mapping
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
|
static Mapping create(java.lang.String mappingName)
mappingName
- - the name of the mappingstatic Mapping create(java.lang.String mappingName, HubEntity entity)
mappingName
- - the name of the mappingentity
- - the entity the mapping is targetingint getVersion()
void setVersion(int version)
version
- - a whole integer representing the version of the mappingjava.util.Map<java.lang.String,java.lang.String> getNamespaces()
void setNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
namespaces
- - map of namespace prefixes and their full URIs for the mappingjava.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> getProperties()
void setProperties(java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> properties)
properties
- - hashmap of properties and their settings for the mappingjava.lang.String getName()
void setName(java.lang.String name)
name
- - the name of the mapping (warning: be careful of name changes)java.lang.String getSourceContext()
void setSourceContext(java.lang.String sourceContext)
sourceContext
- - the xpath to start the mapping from inside the root of the documentsjava.lang.String getTargetEntityType()
void setTargetEntityType(java.lang.String targetEntityType)
targetEntityType
- - the IRI of the entity you want this mapping to usejava.lang.String getDescription()
void setDescription(java.lang.String description)
description
- - a short description of what this mapping's purpose isjava.lang.String getSourceURI()
void setSourceURI(java.lang.String sourceURI)
sourceURI
- - a source URI@Deprecated java.lang.String getLanguage()
java.lang.String getLang()
@Deprecated void setLanguage(java.lang.String language)
language
- - sets the language key for the server - don't modify please!void setLang(java.lang.String lang)
lang
- - sets the language key for the server - don't modify please!java.lang.String serialize()
Mapping deserialize(com.fasterxml.jackson.databind.JsonNode json)
json
- - the jsonnode you want deserializedvoid incrementVersion()