com.marklogic.hub.mapping.Mapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-data-hub Show documentation
Library for Creating an Operational Data Hub on MarkLogic
There is a newer version: 6.1.1
package com.marklogic.hub.mapping;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.marklogic.hub.entity.HubEntity;

import java.util.HashMap;
import java.util.Map;

public interface Mapping {

    /**
     * Creates an in-memory default instance of a mapping given a name
     * @param mappingName - the name of the mapping
     * @return a Mapping object to manipulate further
     */
    static Mapping create(String mappingName) {
        return new MappingImpl(mappingName);
    }

    /**
     * Creates an in-memory default instance of a mapping given a name
     * @param mappingName - the name of the mapping
     * @param entity - the entity the mapping is targeting
     * @return a Mapping object to manipulate further
     */
    static Mapping create(String mappingName, HubEntity entity) {
        return new MappingImpl(mappingName, entity);
    }

    /**
     * Returns the mapping version
     * @return mapping version
     */
    int getVersion();

    /**
     * Sets the version for the mapping
     * @param version - a whole integer representing the version of the mapping
     */
    void setVersion(int version);

    /**
     * Gets the map of the namespaces for mapping
     * @return a map of all the namespace prefixes and their full URIs
     */
    Map getNamespaces();

    /**
     * Sets the namespaces map for the mapping
     * @param namespaces - map of namespace prefixes and their full URIs for the mapping
     */
    void setNamespaces(Map namespaces);

    /**
     * Gets the hashmap of the properties mapping
     * @return a hashmap of all the properties that have been mapped
     */
    HashMap getProperties();

    /**
     * Sets the properties hashmap for the mapping
     * @param properties - hashmap of properties and their settings for the mapping
     */
    void setProperties(HashMap properties);

    /**
     * Returns the name of the mapping as a string
     * @return name of the mapping as a string
     */
    String getName();

    /**
     * Sets the name of the mapping as a string
     * @param name - the name of the mapping (warning: be careful of name changes)
     */
    void setName(String name);

    /**
     *  Returns the source context string for the mapping
     * @return string representation of source context
     */
    String getSourceContext();

    /**
     * Sets the source context for the mapping
     * @param sourceContext - the xpath to start the mapping from inside the root of the documents
     */
    void setSourceContext(String sourceContext);

    /**
     * Returns the IRI for the targeted entity type
     * @return - IRI as string for what entity this mapping is targeted towards
     */
    String getTargetEntityType();

    /**
     * Setting the IRI for the target entity type
     * @param targetEntityType - the IRI of the entity you want this mapping to use
     */
    void setTargetEntityType(String targetEntityType);

    /**
     * Returns a string description of what the mapping is/does
     * @return a string description
     */
    String getDescription();

    /**
     * Set the description for the mapping
     * @param description - a short description of what this mapping's purpose is
     */
    void setDescription(String description);

    /**
     * Returns a URI of the mapping source document
     * @return a source URI
     */
    String getSourceURI();

    /**
     * Set the URI for the mapping source document
     * @param sourceURI - a source URI
     */
    void setSourceURI(String sourceURI);

    /**
     * Return the language key setting
     * @return the string key
     */
    @Deprecated
    String getLanguage();

    /**
     * Return the language key setting
     * @return the string key
     */
    String getLang();

    /**
     * *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
     * @param language - sets the language key for the server - don't modify please!
     */
    @Deprecated
    void setLanguage(String language);

    /**
     * *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
     * @param lang - sets the language key for the server - don't modify please!
     */
    void setLang(String lang);

    /**
     * Serializes the mapping as a json string
     * @return the serialized JSON string
     */
    String serialize();

    /**
     * Deserializes a json response and applies it to this mapping
     * @param json - the jsonnode you want deserialized
     * @return this mapping
     */
    Mapping deserialize(JsonNode json);

    /**
     * Automatically increments the version of the mapping by 1
     */
    void incrementVersion();
}