com.marklogic.hub.mapping

Class MappingImpl

java.lang.Object

com.marklogic.hub.mapping.MappingImpl

All Implemented Interfaces:

Mapping

public class MappingImpl
extends java.lang.Object
implements Mapping

Constructor Summary

Constructors

Constructor and Description
MappingImpl(java.lang.String name)
MappingImpl(java.lang.String name, HubEntity entity)

Method Summary

Modifier and Type	Method and Description
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.marklogic.hub.mapping.Mapping

create, create

Constructor Detail

MappingImpl

public MappingImpl(java.lang.String name)

MappingImpl

public MappingImpl(java.lang.String name,
                   HubEntity entity)

Method Detail

deserialize

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

Description copied from interface: Mapping

Deserializes a json response and applies it to this mapping

Specified by:

deserialize in interface Mapping

Parameters:

json - - the jsonnode you want deserialized

Returns:

this mapping

getNamespaces

public java.util.Map<java.lang.String,java.lang.String> getNamespaces()

Description copied from interface: Mapping

Gets the map of the namespaces for mapping

Specified by:

getNamespaces in interface Mapping

Returns:

a map of all the namespace prefixes and their full URIs

setNamespaces

public void setNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)

Description copied from interface: Mapping

Sets the namespaces map for the mapping

Specified by:

setNamespaces in interface Mapping

Parameters:

namespaces - - map of namespace prefixes and their full URIs for the mapping

getVersion

public int getVersion()

Description copied from interface: Mapping

Returns the mapping version

Specified by:

getVersion in interface Mapping

Returns:

mapping version

setVersion

public void setVersion(int version)

Description copied from interface: Mapping

Sets the version for the mapping

Specified by:

setVersion in interface Mapping

Parameters:

version - - a whole integer representing the version of the mapping

getProperties

public java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> getProperties()

Description copied from interface: Mapping

Gets the hashmap of the properties mapping

Specified by:

getProperties in interface Mapping

Returns:

a hashmap of all the properties that have been mapped

setProperties

public void setProperties(java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> properties)

Description copied from interface: Mapping

Sets the properties hashmap for the mapping

Specified by:

setProperties in interface Mapping

Parameters:

properties - - hashmap of properties and their settings for the mapping

getName

public java.lang.String getName()

Description copied from interface: Mapping

Returns the name of the mapping as a string

Specified by:

getName in interface Mapping

Returns:

name of the mapping as a string

setName

public void setName(java.lang.String name)

Description copied from interface: Mapping

Sets the name of the mapping as a string

Specified by:

setName in interface Mapping

Parameters:

name - - the name of the mapping (warning: be careful of name changes)

getSourceContext

public java.lang.String getSourceContext()

Description copied from interface: Mapping

Returns the source context string for the mapping

Specified by:

getSourceContext in interface Mapping

Returns:

string representation of source context

setSourceContext

public void setSourceContext(java.lang.String sourceContext)

Description copied from interface: Mapping

Sets the source context for the mapping

Specified by:

setSourceContext in interface Mapping

Parameters:

sourceContext - - the xpath to start the mapping from inside the root of the documents

getTargetEntityType

public java.lang.String getTargetEntityType()

Description copied from interface: Mapping

Returns the IRI for the targeted entity type

Specified by:

getTargetEntityType in interface Mapping

Returns:

- IRI as string for what entity this mapping is targeted towards

setTargetEntityType

public void setTargetEntityType(java.lang.String targetEntityType)

Description copied from interface: Mapping

Setting the IRI for the target entity type

Specified by:

setTargetEntityType in interface Mapping

Parameters:

targetEntityType - - the IRI of the entity you want this mapping to use

getDescription

public java.lang.String getDescription()

Description copied from interface: Mapping

Returns a string description of what the mapping is/does

Specified by:

getDescription in interface Mapping

Returns:

a string description

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: Mapping

Set the description for the mapping

Specified by:

setDescription in interface Mapping

Parameters:

description - - a short description of what this mapping's purpose is

getSourceURI

public java.lang.String getSourceURI()

Description copied from interface: Mapping

Returns a URI of the mapping source document

Specified by:

getSourceURI in interface Mapping

Returns:

a source URI

setSourceURI

public void setSourceURI(java.lang.String sourceURI)

Description copied from interface: Mapping

Set the URI for the mapping source document

Specified by:

setSourceURI in interface Mapping

Parameters:

sourceURI - - a source URI

getLanguage

@Deprecated
public java.lang.String getLanguage()

Deprecated.

Description copied from interface: Mapping

Return the language key setting

Specified by:

getLanguage in interface Mapping

Returns:

the string key

setLanguage

@Deprecated
public void setLanguage(java.lang.String language)

Deprecated.

Description copied from interface: Mapping

*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

Specified by:

setLanguage in interface Mapping

Parameters:

language - - sets the language key for the server - don't modify please!

getLang

public java.lang.String getLang()

Description copied from interface: Mapping

Return the language key setting

Specified by:

getLang in interface Mapping

Returns:

the string key

setLang

public void setLang(java.lang.String lang)

Description copied from interface: Mapping

*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

Specified by:

setLang in interface Mapping

Parameters:

lang - - sets the language key for the server - don't modify please!

serialize

public java.lang.String serialize()

Description copied from interface: Mapping

Serializes the mapping as a json string

Specified by:

serialize in interface Mapping

Returns:

the serialized JSON string

incrementVersion

public void incrementVersion()

Description copied from interface: Mapping

Automatically increments the version of the mapping by 1

Specified by:

incrementVersion in interface Mapping