All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.foreach.across.modules.webcms.data.WebCmsDataEntry Maven / Gradle / Ivy

Go to download

Web CMS Module

There is a newer version: 6.5.1
Show newest version
/*
 * Copyright 2017 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.webcms.data;

import lombok.Builder;
import lombok.Data;
import lombok.NonNull;
import org.apache.commons.lang3.StringUtils;

import java.util.*;
import java.util.function.Consumer;

/**
 * Represents a set of data to be imported.
 * Data should be either a {@link Map} or a {@link Collection} (usually of {@link Map} items).
 * 

 *
 * @author Arne Vandamme
 * @see WebCmsDataImportServiceImpl
 * @see WebCmsDataImportAction
 * @since 0.0.1
 */
@Data
public final class WebCmsDataEntry
{
	public final static String ROOT = "";

	/**
	 * Defines the kind of data type a {@link WebCmsDataEntry} holds.
	 */
	private enum WebCmsDataEntryType
	{
		SINGLE_VALUE,
		MAP_DATA,
		COLLECTION_DATA

	}

	/**
	 * Key of this mapData entry item.
	 */
	private final String key;

	/**
	 * Data itself.
	 */
	private final Map mapData;

	/**
	 * Data itself as a collection of objects.
	 */
	private final Collection collectionData;

	/**
	 * Data itself if neither collection nor map.
	 */
	private final Object singleValue;

	/**
	 * Optional parent data entry.
	 */
	private final WebCmsDataEntry parent;

	/**
	 * Optional identifier of the data entry, child entries have the same identifier as their parent.
	 */
	private String identifier;

	/**
	 * Action that should be performed with this data.
	 */
	@NonNull
	private WebCmsDataImportAction importAction = WebCmsDataImportAction.CREATE_OR_UPDATE;

	/**
	 * Callback functions that should run when the import of this data entry has been completed.
	 */
	private List> completedCallbacks;

	/**
	 * Type of data held in the entry.
	 */
	private WebCmsDataEntryType dataType;

	@Builder
	@SuppressWarnings("unchecked")
	private WebCmsDataEntry( String identifier,
	                         String key,
	                         WebCmsDataEntry parent,
	                         Object data,
	                         WebCmsDataImportAction importAction ) {
		this.identifier = identifier;

		completedCallbacks = new ArrayList<>();

		this.key = key;
		this.parent = parent;

		if ( parent != null ) {
			this.importAction = parent.importAction;
			this.identifier = parent.identifier;
		}

		if ( importAction != null ) {
			this.importAction = importAction;
		}

		if ( data instanceof Map ) {
			dataType = WebCmsDataEntryType.MAP_DATA;
			Map map = new LinkedHashMap<>( (Map) data );
			this.importAction = Optional.ofNullable( WebCmsDataImportAction.fromAttributeValue( (String) map.remove( WebCmsDataImportAction.ATTRIBUTE_NAME ) ) )
			                            .orElse( this.importAction );

			this.mapData = Collections.unmodifiableMap( map );
			this.collectionData = Collections.emptyList();
			this.singleValue = null;
		}
		else if ( data instanceof Collection ) {
			dataType = WebCmsDataEntryType.COLLECTION_DATA;
			this.collectionData = (Collection) data;
			this.mapData = Collections.emptyMap();
			this.singleValue = null;
		}
		else {
			dataType = WebCmsDataEntryType.SINGLE_VALUE;
			this.singleValue = data;
			this.mapData = Collections.emptyMap();
			this.collectionData = Collections.emptyList();
		}
	}

	/**
	 * @return true if data is of type map
	 */
	public boolean isMapData() {
		return WebCmsDataEntryType.MAP_DATA.equals( dataType );
	}

	/**
	 * @return true if data is of type collection
	 */
	public boolean isCollectionData() {
		return WebCmsDataEntryType.COLLECTION_DATA.equals( dataType );
	}

	/**
	 * Get the single value and cast it to the expected type.
	 *
	 * @param expectedType to cast to
	 * @param           expected type
	 * @param           specific (generic-aware) implementation of the expected type
	 * @return single value as type
	 */
	@SuppressWarnings("unchecked")
	public  U getSingleValue( Class expectedType ) {
		return (U) expectedType.cast( getSingleValue() );
	}

	/**
	 * @return true if data is a single (usually primitive) value
	 */
	public boolean isSingleValue() {
		return WebCmsDataEntryType.SINGLE_VALUE.equals( dataType );
	}

	/**
	 * @return true if the data entry has a parent data entry
	 */
	public boolean hasParent() {
		return parent != null;
	}

	/**
	 * Shortcut to retrieve the key of the optional parent data.
	 *
	 * @return parent key or {@code null} if no parent data
	 */
	public String getParentKey() {
		return hasParent() ? parent.getKey() : null;
	}

	/**
	 * Attempt to build a relative location of this data entry in the parent data.
	 *
	 * @return location (null if no parent)
	 */
	public String getLocation() {
		String current = "/" +
				( StringUtils.isEmpty( key )
						? ( isMapData() ? "" : ( isCollectionData() ? "" : "" ) )
						: ( ROOT.equals( key ) ) ? "" : key );

		if ( hasParent() ) {
			String parent = getParent().getLocation();
			if ( !"/".equals( parent ) ) {
				return parent + current;
			}
		}

		return current;
	}

	public String toString() {
		Object data = isMapData() ? mapData : ( isCollectionData() ? collectionData : singleValue );

		return "WebCmsDataEntry(" +
				"identifier='" + identifier + "'," +
				"location='" + getLocation() + "'," +
				"data=" + data +
				")";
	}

	/**
	 * Adds a callback to execute once the data entry is completed
	 *
	 * @param consumer the callback
	 */
	public void addCompletedCallback( Consumer consumer ) {
		this.completedCallbacks.add( consumer );
	}
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy