com.ocs.dynamo.domain.model.FieldCreationContext Maven / Gradle / Ivy

Go to download
/*
   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.ocs.dynamo.domain.model;

import java.util.Map;

import com.ocs.dynamo.domain.AbstractEntity;
import com.vaadin.flow.data.provider.DataProvider;
import com.vaadin.flow.function.SerializablePredicate;

import lombok.Builder;
import lombok.Data;

/**
 * DTO object that can be used to construct the context that is used for
 * constructing a component
 * 
 * @author Bas Rutten
 *
 */
@Data
@Builder(toBuilder = true)
public class FieldCreationContext {

	/**
	 * Creates a blank context
	 * 
	 * @return the freshly created context
	 */
	public static FieldCreationContext.FieldCreationContextBuilder create() {
		return FieldCreationContext.builder();
	}

	/**
	 * Creates a default context based on only the attribute model
	 * 
	 * @param am the attribute model
	 * @return the freshly created context
	 */
	public static FieldCreationContext createDefault(AttributeModel am) {
		return FieldCreationContext.builder().attributeModel(am).build();
	}

	private AttributeModel attributeModel;

	private boolean editableGrid;

	private EntityModel fieldEntityModel;

	private Map> fieldFilters;

	private AbstractEntity parentEntity;

	private boolean search;

	private Map>> sharedProviders;

	private boolean viewMode;

	public void addSharedProvider(String attribute,
			DataProvider, SerializablePredicate> sharedProvider) {
		sharedProviders.put(attribute, sharedProvider);
	}

	public DataProvider> getSharedProvider(String attribute) {
		return sharedProviders == null ? null : sharedProviders.get(attribute);
	}

	/**
	 * Returns the AttributeSelectMode of the attribute model to use depending on
	 * the context
	 * 
	 * @param am the attribute model
	 * @return
	 */
	public AttributeSelectMode getAppropriateMode(AttributeModel am) {
		return isSearch() ? am.getSearchSelectMode() : (isEditableGrid() ? am.getGridSelectMode() : am.getSelectMode());
	}

}