com.foreach.across.modules.entity.EntityAttributes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of entity-module Show documentation
Entity Module
There is a newer version: 4.5.1
/*
 * Copyright 2014 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
 *
 * 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 com.foreach.across.modules.entity;

import com.foreach.across.modules.entity.registry.properties.EntityPropertyDescriptor;
import com.foreach.across.modules.entity.views.bootstrapui.options.OptionGenerator;
import com.foreach.across.modules.entity.views.bootstrapui.options.OptionIterableBuilder;
import com.foreach.across.modules.entity.views.bootstrapui.processors.element.EntityListActionsProcessor;
import com.foreach.across.modules.entity.views.processors.SingleEntityFormViewProcessor;
import org.apache.commons.lang3.StringUtils;
import org.springframework.transaction.PlatformTransactionManager;

/**
 * Contains common {@link com.foreach.across.modules.entity.registry.EntityConfiguration}, {@link com.foreach.across.modules.entity.registry.EntityAssociation}
 * and {@link EntityPropertyDescriptor} attribute keys.
 *
 * @see com.foreach.across.modules.entity.views.EntityViewFactoryAttributes
 */
public interface EntityAttributes
{
	/**
	 * If set, holds the name of the {@link PlatformTransactionManager} bean that the repositories of this entity use.
	 */
	String TRANSACTION_MANAGER_NAME = PlatformTransactionManager.class.getName() + ".name";

	/**
	 * If set, contains the control name that should be used for form elements.
	 */
	String CONTROL_NAME = EntityPropertyDescriptor.class.getName() + ".controlName";

	/**
	 * If set, indicates that the property descriptor represents a native property on a class.
	 * The class is usually the entity this property belongs to.
	 * 
	 * The actual value can differ, for example {@link org.springframework.core.convert.Property} or {@link java.beans.PropertyDescriptor}.
	 */
	String NATIVE_PROPERTY_DESCRIPTOR = EntityPropertyDescriptor.class.getName() + ".nativeProperty";

	/**
	 * If set, determines if a control for this property should be marked as required or not.
	 * The actual value should be either {@code true} or {@code false}.
	 */
	String PROPERTY_REQUIRED = EntityPropertyDescriptor.class.getName() + ".required";

	/**
	 * If set, this attribute should contain the
	 * {@link com.foreach.across.modules.entity.registry.properties.EntityPropertySelector} to be used for selecting
	 * the members of a {@link com.foreach.across.modules.bootstrapui.elements.FieldsetFormElement}.
	 */
	String FIELDSET_PROPERTY_SELECTOR = "com.foreach.across.modules.bootstrapui.elements.FieldsetFormElement.EntityPropertySelector";

	/**
	 * If set, contains the EQL statement or {@link com.foreach.across.modules.entity.query.EntityQuery} that should be used
	 * to fetch the selectable options.  Can be used to for example filter out deleted items.
	 * 

	 * Will only be used if there is no {@link com.foreach.across.modules.entity.views.bootstrapui.options.OptionGenerator}
	 * or {@link OptionIterableBuilder} attribute set.
	 */
	String OPTIONS_ENTITY_QUERY = OptionIterableBuilder.class.getName() + ".EntityQuery";

	/**
	 * If set, should contain a collection of the allowed values.  Usually used in combination with an enum option,
	 * in which case the value is expected to be an {@link java.util.EnumSet}.
	 */
	String OPTIONS_ALLOWED_VALUES = OptionIterableBuilder.class.getName() + ".AllowedValues";

	/**
	 * If set, should contain an {@link com.foreach.across.modules.bootstrapui.elements.builder.OptionFormElementBuilder} consumer.
	 * Used to apply changes to an {@link com.foreach.across.modules.bootstrapui.elements.builder.OptionFormElementBuilder}.
	 */
	String OPTIONS_ENHANCER = OptionGenerator.class.getName() + ".enhancer";

	/**
	 * In case of a nested {@link EntityPropertyDescriptor}, this attribute can hold the original target {@link EntityPropertyDescriptor}
	 * that was used, in combination with the parent descriptor, to build the nested property descriptor.
	 */
	String TARGET_DESCRIPTOR = EntityPropertyDescriptor.class.getName() + ".target";

	/**
	 * Can be set on either {@link com.foreach.across.modules.entity.views.EntityViewFactory} or {@link EntityPropertyDescriptor}.
	 * Holds the suggested form enctype to submit a form holding a control for that property.
	 *
	 * @see SingleEntityFormViewProcessor
	 */
	String FORM_ENCTYPE = SingleEntityFormViewProcessor.ATTR_ENCTYPE;

	/**
	 * Can be set on either {@link com.foreach.across.modules.entity.views.EntityViewFactory} or {@link com.foreach.across.modules.entity.registry.EntityConfiguration}.
	 * Holds whether views should link to the {@link com.foreach.across.modules.entity.views.EntityView#DETAIL_VIEW_NAME} by default or not.
	 * The actual value should be {@code true} or {@code false}
	 */
	String LINK_TO_DETAIL_VIEW = EntityListActionsProcessor.class.getName() + ".linkToDetailView";

	/**
	 * Holds {@code true} if a property (or a target {@link com.foreach.across.modules.entity.registry.EntityConfiguration} represents
	 * an embedded object instead of a related object. This will impact the control types being generated for this property.
	 * An attribute value set on the {@link EntityPropertyDescriptor} will take precedence over the value on an
	 * {@link com.foreach.across.modules.entity.registry.EntityConfiguration}.
	 * 
	 * If not explicitly set, a strategy will be used to determine if a property should behave as an embedded object.
	 */
	String IS_EMBEDDED_OBJECT = EntityPropertyDescriptor.class.getName() + ".embedded";

	/**
	 * Retrieve the control name to use for a {@link EntityPropertyDescriptor}.
	 * If an attribute {@link #CONTROL_NAME} is present, it will be used, else the regular name will be used.
	 *
	 * @param descriptor of the property
	 * @return control name to use
	 */
	@Deprecated
	static String controlName( EntityPropertyDescriptor descriptor ) {
		return StringUtils.defaultString( descriptor.getAttribute( CONTROL_NAME, String.class ), descriptor.getName() );
	}

	/**
	 * Check if the descriptor has the {@link #PROPERTY_REQUIRED} attribute with a {@code true} value,
	 * marking the control as required.
	 *
	 * @param descriptor of the property
	 * @return true if it is required
	 */
	static boolean isRequired( EntityPropertyDescriptor descriptor ) {
		return Boolean.TRUE.equals( descriptor.getAttribute( PROPERTY_REQUIRED, Boolean.class ) );
	}
}