org.springframework.data.elasticsearch.core.convert.ElasticsearchTypeMapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-elasticsearch Show documentation

Spring Data Implementation for Elasticsearch

There is a newer version: 5.3.3

Show newest version

/*
 * Copyright 2019-2023 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.data.elasticsearch.core.convert;

import java.util.Map;

import org.springframework.data.convert.TypeMapper;
import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentProperty;
import org.springframework.data.mapping.context.MappingContext;
import org.springframework.lang.Nullable;

/**
 * Elasticsearch specific {@link TypeMapper} definition.
 *
 * @author Christoph Strobl
 * @since 3.2
 */
public interface ElasticsearchTypeMapper extends TypeMapper> {

	String DEFAULT_TYPE_KEY = "_class";

	/**
	 * Returns whether the given key is the type key.
	 *
	 * @return {@literal true} if given {@literal key} is used as type hint key.
	 */
	boolean isTypeKey(String key);

	/**
	 * @return the type key.
	 * @since 4.4
	 */
	@Nullable
	String getTypeKey();

	default boolean containsTypeInformation(Map source) {
		return readType(source) != null;
	}

	/**
	 * Creates a new default {@link ElasticsearchTypeMapper}.
	 *
	 * @param mappingContext the mapping context.
	 * @return a new default {@link ElasticsearchTypeMapper}.
	 * @see DefaultElasticsearchTypeMapper
	 */
	static ElasticsearchTypeMapper create(
			MappingContext, ElasticsearchPersistentProperty> mappingContext) {
		return new DefaultElasticsearchTypeMapper(DEFAULT_TYPE_KEY, mappingContext);
	}
}