org.elasticsearch.index.mapper.DocumentMapperParser Maven / Gradle / Ivy

Go to download
/*
 * Licensed to Elastic Search and Shay Banon under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. Elastic Search licenses this
 * file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.index.mapper;

import javax.annotation.Nullable;

/**
 * @author kimchy (shay.banon)
 */
public interface DocumentMapperParser {

    /**
     * Parses the source mapping definition into a document mapper.
     */
    DocumentMapper parse(String mappingSource) throws MapperParsingException;

    /**
     * Parses the source mapping definition into a document mapper with the specified
     * type (overriding the one defined in the source mapping).
     */
    DocumentMapper parse(@Nullable String type, String mappingSource) throws MapperParsingException;

    /**
     * Parses the source mapping definition into a document mapper with the specified
     * type (overriding the one defined in the source mapping).
     */
    DocumentMapper parse(@Nullable String type, String mappingSource, String defaultMappingSource) throws MapperParsingException;
}