/*
 * Copyright 2017-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.relational.core.mapping;

import org.springframework.data.mapping.PersistentProperty;
import org.springframework.data.relational.core.sql.SqlIdentifier;
import org.springframework.lang.Nullable;

/**
 * A {@link PersistentProperty} with methods for additional RDBMS related metadata based on columns.
 *
 * @author Jens Schauder
 * @author Oliver Gierke
 * @author Bastian Wilhelm
 */
public interface RelationalPersistentProperty extends PersistentProperty<RelationalPersistentProperty> {

	/**
	 * Returns the name of the column backing this property.
	 *
	 * @return the name of the column backing this property.
	 */
	SqlIdentifier getColumnName();

	/**
	 * Returns whether the property uses an annotated field name through {@link Column}.
	 *
	 * @return
	 * @since 3.2
	 */
	boolean hasExplicitColumnName();

	@Override
	RelationalPersistentEntity<?> getOwner();

	/**
	 * @deprecated use {@link #getReverseColumnName(RelationalPersistentEntity)} instead
	 */
	@Deprecated(since = "3.2", forRemoval = true)
	SqlIdentifier getReverseColumnName(PersistentPropertyPathExtension path);

	/**
	 * @param owner the owning entity.
	 * @return the column name to represent the owning side.
	 */
	SqlIdentifier getReverseColumnName(RelationalPersistentEntity<?> owner);

	@Nullable
	SqlIdentifier getKeyColumn();

	/**
	 * Returns if this property is a qualified property, i.e. a property referencing multiple elements that can get picked
	 * by a key or an index.
	 */
	boolean isQualified();

	Class<?> getQualifierColumnType();

	/**
	 * Returns whether this property is an ordered property.
	 */
	boolean isOrdered();

	/**
	 * @return true, if the Property is an embedded value object, otherwise false.
	 */
	default boolean isEmbedded() {
		return false;
	}

	/**
	 * @return Prefix for embedded columns. If the column is not embedded the return value is null.
	 */
	@Nullable
	default String getEmbeddedPrefix() {
		return null;
	}

	/**
	 * Returns whether an empty embedded object is supposed to be created for this property.
	 */
	boolean shouldCreateEmptyEmbedded();

	/**
	 * Returns whether this property is only to be used during inserts and read.
	 *
	 * @since 3.0
	 */
	boolean isInsertOnly();
}
