com.foreach.across.modules.entity.util.EntityUtils 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.util;

import com.foreach.across.modules.entity.registry.EntityRegistry;
import com.foreach.across.modules.entity.registry.properties.EntityPropertyDescriptor;
import com.foreach.across.modules.entity.registry.properties.EntityPropertyRegistry;
import org.apache.commons.lang3.StringUtils;
import org.springframework.core.ResolvableType;
import org.springframework.core.convert.TypeDescriptor;
import org.springframework.data.domain.*;
import org.springframework.lang.NonNull;

import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class EntityUtils
{
	/**
	 * Generate a default entity name for an entity type.
	 *
	 * @param entityType for which to generate the name
	 * @return default name
	 */
	public static String generateEntityName( Class entityType ) {
		return Stream.of( StringUtils.split( StringUtils.substringAfterLast( entityType.getName(), "." ), "$" ) )
		             .map( StringUtils::uncapitalize )
		             .collect( Collectors.joining( "." ) );
	}

	/**
	 * Inspects a {@link TypeDescriptor} to retrieve the target {@link TypeDescriptor} if possible.
	 * This method is meant to determine the target entity type of for example a collection or array descriptor.
	 * In the latter case the target type would usually be the member type of the descriptor.
	 * 
	 * If the type descriptor is neither array nor collection, the original type descriptor is considered to be the target.
	 * If the type descriptor is representing a class that extends any of the collection types, its member will be used.
	 * 

	 * In case of a generic {@link Map}, no target type can be resolved.
	 * 

	 * If the type extends a collection type but the {@link EntityRegistry} contains an entry for that specific type, that target type will be returned.
	 * Else the member will still be resolved.  If the type is {@link Optional}, the member will be returned.
	 * 

	 * If {@code null} is passed as the argument for a type descriptor, a generic descriptor for a {@link Object} will be returned.
	 *
	 * @param typeDescriptor to inspect for the target type
	 * @return resolved descriptor
	 */
	public static EntityTypeDescriptor resolveEntityTypeDescriptor( TypeDescriptor typeDescriptor, EntityRegistry entityRegistry ) {
		if ( typeDescriptor == null ) {
			return EntityTypeDescriptor.builder().sourceTypeDescriptor( TypeDescriptor.valueOf( Object.class ) ).build();
		}

		EntityTypeDescriptor.EntityTypeDescriptorBuilder builder = EntityTypeDescriptor.builder().sourceTypeDescriptor( typeDescriptor );

		if ( entityRegistry.contains( typeDescriptor.getType() ) ) {
			builder.targetTypeDescriptor( typeDescriptor );
		}
		else if ( typeDescriptor.isCollection() || typeDescriptor.isArray() ) {
			builder.collection( true ).targetTypeDescriptor( typeDescriptor.getElementTypeDescriptor() );
		}
		else if ( !typeDescriptor.isMap() ) {
			ResolvableType resolvableType = typeDescriptor.getResolvableType();
			if ( typeDescriptor.isAssignableTo( TypeDescriptor.valueOf( Optional.class ) ) ) {
				builder.targetTypeDescriptor( TypeDescriptor.valueOf( resolvableType.getGeneric( 0 ).resolve() ) );
			}
			else {
				builder.targetTypeDescriptor( typeDescriptor );
			}
		}

		return builder.build();
	}

	public static String generateDisplayName( String propertyName ) {
		String cleaned = propertyName.replace( '.', ' ' ).replace( '_', ' ' ).replaceAll( "[^\\p{L}\\p{Nd} ]+", " " );

		List finished = new LinkedList<>();
		for ( String part : StringUtils.split( cleaned, ' ' ) ) {
			String previous = null;
			String capitalized = StringUtils.isAllUpperCase( part )
					? StringUtils.capitalize( StringUtils.lowerCase( part ) ) : StringUtils.capitalize( part );

			for ( String subPart : StringUtils.splitByCharacterTypeCamelCase( capitalized ) ) {
				if ( previous != null && ( StringUtils.length( previous ) == 1 || StringUtils.isNumeric( subPart ) ) ) {
					previous = previous + subPart;
					finished.set( finished.size() - 1, previous );
				}
				else {
					previous = finished.isEmpty() ? subPart : StringUtils.lowerCase( subPart );
					finished.add( previous );
				}
			}
		}

		return StringUtils.join( finished, " " );
	}

	public static String combineDisplayNames( String first, String... propertyNames ) {
		List finished = new LinkedList<>();
		finished.add( generateDisplayName( first ) );
		for ( String name : propertyNames ) {
			finished.add( generateDisplayName( name ).toLowerCase() );
		}
		return StringUtils.join( finished, " " );
	}

	/**
	 * Translates the {@link Sort} property attached to this pageable.  Will create a new {@link Pageable}
	 * if sorting is modified. See {@link #translateSort(Sort, EntityPropertyRegistry)} for more details.
	 *
	 * @param pageable         instance to be translated
	 * @param propertyRegistry to be used for looking up matching properties
	 * @return modified instance or same if unmodified
	 */
	public static Pageable translateSort( Pageable pageable, EntityPropertyRegistry propertyRegistry ) {
		Sort sort = pageable.getSort();

		if ( sort != null ) {
			Sort modifiedSort = translateSort( sort, propertyRegistry );
			if ( !sort.equals( modifiedSort ) ) {
				return PageRequest.of( pageable.getPageNumber(), pageable.getPageSize(), modifiedSort );
			}
		}

		return pageable;
	}

	/**
	 * 
Translates the {@link Sort} instance based on the specified {@link EntityPropertyRegistry}.  For every
	 * {@link org.springframework.data.domain.Sort.Order} entry a property will be looked up in the registry.
	 * If a property is found, the {@link org.springframework.data.domain.Sort.Order} attribute of the property
	 * will be fetched and if one is specified, it will be used as the basis for the new entry.  Especially
	 * the {@link Sort.Order#getNullHandling()} and {@link Sort.Order#isIgnoreCase()} settings will be copied.
	 * In case null handling is native, a fixed null handling will be applied depending on the direction.
	 * Order entries for which no property or property attribute can be found, will be left unchanged.
	 *
	 * @param sort             instance to be translated
	 * @param propertyRegistry to be used for looking up matching properties
	 * @return modified or possibly same instance if unmodified
	 */
	@NonNull
	public static Sort translateSort( Sort sort, EntityPropertyRegistry propertyRegistry ) {
		List translated = new ArrayList<>();

		for ( Sort.Order order : sort ) {
			EntityPropertyDescriptor descriptor = propertyRegistry.getProperty( order.getProperty() );
			Sort.Order template = descriptor != null ? descriptor.getAttribute( Sort.Order.class ) : null;

			if ( template != null ) {
				Sort.Order clone = new Sort.Order( order.getDirection(), template.getProperty() );

				if ( template.isIgnoreCase() ) {
					clone = clone.ignoreCase();
				}
				if ( template.getNullHandling() == Sort.NullHandling.NATIVE ) {
					clone = clone.getDirection() == Sort.Direction.ASC ? clone.nullsFirst() : clone.nullsLast();
				}
				else {
					clone = clone.with( template.getNullHandling() );
				}

				translated.add( clone );
			}
			else {
				translated.add( order );
			}
		}

		return translated.isEmpty() ? Sort.unsorted() :  Sort.by( translated );
	}

	/**
	 * Merge any number of {@link Sort} instances into a single instance.
	 * Properties will only be applied once, the first time they are encountered.
	 *
	 * @param sorts to combine
	 * @return combined sort or {@code null} if no sort orders were specified
	 */
	public static Sort combineSortSpecifiers( Sort... sorts ) {
		Set props = new HashSet<>();
		List orders = new ArrayList<>();

		Stream.of( sorts )
		      .filter( Objects::nonNull )
		      .forEach( s -> s.forEach( order -> {
			                if ( !props.contains( order.getProperty() ) ) {
				                props.add( order.getProperty() );
				                orders.add( order );
			                }
		                } )
		      );

		return orders.isEmpty() ? Sort.unsorted() : Sort.by( orders );
	}

	/**
	 * Create a {@link org.springframework.data.domain.Page} from any {@link java.lang.Iterable}.
	 *
	 * @param collection contains the items in the page
	 * @return Page instance
	 */
	public static  Page asPage( Iterable collection ) {
		return new PageImpl( asList( collection ) );
	}

	/**
	 * Create a {@link List} from any {@link Iterable}.  If the iterable is a list the same instance
	 * will be returned.  In all other cases a new instance will be created from the elements of
	 * the iterable.
	 *
	 * @param iterable containing the elements
	 * @param       element type
	 * @return List instance
	 */
	public static  List asList( Iterable iterable ) {
		if ( iterable instanceof List ) {
			return (List) iterable;
		}

		if ( iterable instanceof Collection ) {
			return new ArrayList<>( (Collection) iterable );
		}

		List list = new ArrayList<>();
		for ( Y item : iterable ) {
			list.add( item );
		}

		return list;
	}
}