com.foreach.across.modules.entity.views.EntityViewElementBuilderHelper 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.views;

import com.foreach.across.modules.entity.registry.EntityConfiguration;
import com.foreach.across.modules.entity.registry.EntityRegistry;
import com.foreach.across.modules.entity.registry.properties.EntityPropertyRegistry;
import com.foreach.across.modules.entity.registry.properties.EntityPropertySelector;
import com.foreach.across.modules.entity.support.EntityMessageCodeResolver;
import com.foreach.across.modules.entity.views.bootstrapui.util.SortableTableBuilder;
import com.foreach.across.modules.entity.views.context.EntityViewContext;
import com.foreach.across.modules.entity.views.helpers.EntityViewElementBatch;
import com.foreach.across.modules.entity.views.support.EntityMessages;
import com.foreach.across.modules.entity.web.EntityViewModel;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.util.ClassUtils;

/**
 * Provides methods to creating helper beans for view element generation.
 *
 * @author Arne Vandamme
 * @since 2.0.0
 */
@Service
@RequiredArgsConstructor
public class EntityViewElementBuilderHelper
{
	private final EntityViewElementBuilderService builderService;
	private final EntityRegistry entityRegistry;
	private final BeanFactory beanFactory;

	@Autowired
	public EntityViewElementBuilderHelper( BeanFactory beanFactory ) {
		this.beanFactory = beanFactory;
		this.entityRegistry = beanFactory.getBean( EntityRegistry.class );
		this.builderService = beanFactory.getBean( EntityViewElementBuilderService.class );
	}

	/**
	 * Create a new batch builder for a given entity.  Requires an {@link EntityConfiguration} to exist for that
	 * entity type.  The default {@link com.foreach.across.modules.entity.support.EntityMessageCodeResolver} for
	 * the configuration will be used.  The entity will be set as {@link EntityViewModel#ENTITY} attribute.
	 *
	 * @param entity instance, should not be null
	 * @return batch instance
	 */
	public  EntityViewElementBatch createBatchForEntity( @NonNull V entity ) {
		EntityViewElementBatch batch = createBatchForEntityType( (Class) ClassUtils.getUserClass( entity ) );
		batch.setEntity( entity );

		return batch;
	}

	/**
	 * Create a new batch builder for a given entity.  Requires an {@link EntityConfiguration} to exist for that
	 * entity type.  The default {@link com.foreach.across.modules.entity.support.EntityMessageCodeResolver} for
	 * the configuration will be used.
	 *
	 * @param entityType should not be null
	 * @return batch instance
	 */
	public  EntityViewElementBatch createBatchForEntityType( @NonNull Class entityType ) {
		EntityViewElementBatch batch = new EntityViewElementBatch<>( builderService );
		EntityConfiguration entityConfiguration = entityRegistry.getEntityConfiguration( entityType );
		batch.setPropertyRegistry( entityConfiguration.getPropertyRegistry() );
		batch.setPropertySelector( new EntityPropertySelector( EntityPropertySelector.ALL ) );

		batch.setAttribute( EntityMessageCodeResolver.class, entityConfiguration.getEntityMessageCodeResolver() );

		return batch;
	}

	/**
	 * Create a new {@link SortableTableBuilder} instance for the entity type specified.
	 * Requires an {@link EntityConfiguration} to exist for that entity type.
	 */
	public  SortableTableBuilder createSortableTableBuilder( @NonNull Class entityType ) {
		SortableTableBuilder tableBuilder = createSortableTableBuilder();
		EntityConfiguration entityConfiguration = entityRegistry.getEntityConfiguration( entityType );

		return tableBuilder.entityConfiguration( entityConfiguration );
	}

	/**
	 * Create a new {@link SortableTableBuilder} instance for a specific {@link EntityViewContext}.
	 * The table builder will be initialized with the {@link EntityConfiguration}, {@link EntityPropertyRegistry} and {@link EntityMessages}
	 * configured on the {@link EntityViewContext}.
	 *
	 * @param entityViewContext to use for initializing the table builder
	 * @return table builders
	 */
	public SortableTableBuilder createSortableTableBuilder( @NonNull EntityViewContext entityViewContext ) {
		SortableTableBuilder tableBuilder = createSortableTableBuilder();
		tableBuilder.entityConfiguration( entityViewContext.getEntityConfiguration() );
		tableBuilder.propertyRegistry( entityViewContext.getPropertyRegistry() );
		tableBuilder.pagingMessages( entityViewContext.getEntityMessages() );
		return tableBuilder;
	}

	/**
	 * Create a new {@link SortableTableBuilder} instance, initialized with the necessary dependencies.
	 *
	 * @return table builders
	 */
	public SortableTableBuilder createSortableTableBuilder() {
		return beanFactory.getBean( SortableTableBuilder.class );
	}
}