org.appng.api.rest.ActionHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of appng-rest-api Show documentation
The appNG REST API
The newest version!
/*
 * Copyright 2011-2021 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 org.appng.api.rest;

import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

import org.apache.commons.lang3.StringUtils;
import org.appng.api.rest.model.Action;
import org.appng.api.rest.model.ActionField;
import org.appng.api.rest.model.FieldType;
import org.appng.api.rest.model.Option;
import org.appng.api.rest.model.Options;
import org.springframework.http.ResponseEntity;

/**
 * Utility class that helps dealing with {@link Action}s.
 */
public class ActionHelper {

	private ResponseEntity action;

	public ActionHelper(ResponseEntity action) {
		this.action = action;
	}

	public static ActionHelper create(ResponseEntity action) {
		return new ActionHelper(action);
	}

	public ActionHelper setFieldValue(String name, Object value) {
		Optional field = getField(name);
		if (field.isPresent() && !isSelectionType(field.get())) {
			field.get().setValue(value);
		}
		return this;
	}

	/**
	 * Marks an {@link Option} as selected. If the field's {@link Options} allow multiple selected values, active
	 * {@link Option}s will remain active. Otherwise, previously active {@link Options} will be de-selected.
	 * 
	 * @param name
	 *              the name of the field
	 * @param value
	 *              the option value to select
	 * 
	 * @return the current {@link ActionHelper}
	 */
	public ActionHelper setFieldSelectionValue(String name, String value) {
		Optional field = getField(name);
		if (field.isPresent() && isSelectionType(field.get())) {
			Options options = field.get().getOptions();
			options.getEntries().forEach(o -> {
				boolean selected = Objects.equals(value, o.getValue());
				if (selected || !Boolean.TRUE.equals(options.isMultiple())) {
					o.setSelected(selected);
				}
			});
		}
		return this;
	}

	/**
	 * De-selects all {@link Option}s of a selection
	 * 
	 * @param name
	 *             the name of the selection field
	 */
	public ActionHelper deselectAllOptions(String name) {
		Optional field = getField(name);
		if (field.isPresent() && isSelectionType(field.get())) {
			field.get().getOptions().getEntries().forEach(o -> o.setSelected(false));
		}
		return this;
	}

	private boolean isSelectionType(ActionField actionField) {
		return Arrays.asList(FieldType.LIST_CHECKBOX, FieldType.LIST_RADIO, FieldType.LIST_SELECT)
				.contains(actionField.getFieldType());
	}

	public Optional getField(List fields, String name) {
		Optional flatField = fields.stream().filter(f -> f.getName().equals(name)).findFirst();
		if (flatField.isPresent()) {
			return flatField;
		}
		if (!name.contains(".")) {
			return Optional.empty();
		}
		String[] segments = name.split("\\.");
		Optional root = fields.stream().filter(f -> f.getName().equals(segments[0])).findFirst();
		if (root.isPresent()) {
			return getField(root.get().getFields(),
					StringUtils.join(Arrays.copyOfRange(segments, 1, segments.length), "."));
		}
		return Optional.empty();
	}

	public Optional getField(String name) {
		return getField(action.getBody().getFields(), name);
	}

}