org.cyclos.model.utils

Class ModelHelper

java.lang.Object

org.cyclos.model.utils.ModelHelper

public class ModelHelper
extends java.lang.Object

Helper for handling CurrencyAmountDTOs

Author:

luis

Constructor Summary

Constructors

Constructor and Description
ModelHelper()

Method Summary

Modifier and Type	Method and Description
static AccountOwnerLocator	accountOwnerLocator(java.lang.String principal) Creates a new AccountOwnerLocator.
static AmountSummaryVO	amountSummary(java.math.BigDecimal sum, java.math.BigDecimal average, int count, CurrencyVO currency) Creates an amount summary
static void	clearIds(java.lang.Iterable<? extends EntityModel> models) Sets the ids of all models to null
static <S extends Bean,T extends Bean> void	copyProperties(S source, T target) It copies from source to target (apply a bean over another bean) traversing all source's properties. If a property is not found in the target bean or has a different type then it's ignored.
static CurrencyAmountDTO	currencyAmount(CurrencyVO currency, java.math.BigDecimal amount) Creates a new CurrencyAmountDTO.
static CurrencyAmountRangeDTO	currencyRange(CurrencyVO currency, java.math.BigDecimal min, java.math.BigDecimal max) Creates a new CurrencyAmountRangeDTO.
static DatePeriodDTO	datePeriod(DateTime begin, DateTime end) Creates a new DatePeriodDTO
static DecimalRangeDTO	decimalRange(java.math.BigDecimal min, java.math.BigDecimal max) Creates a new DecimalRangeDTO
static DictionaryVO	dictionary(java.lang.String dictionary, java.lang.String label) Creates a new DictionaryVO.
static DimensionsDTO	dimensions(int width, int height) Creates a new DimensionsDTO
static boolean	equals(LatLongDTO first, LatLongDTO second) Check if both coordinates are the same
static java.lang.String	escapeIdentifierIfNeeded(java.lang.String value) When the given value is a valid Long, return it escaped with a trailing '.
static java.lang.String	getActualInternalNameOrId(EntityVO vo) Returns the internal name of the given VO if it is valid (no nested paths contains a null part).
static java.util.Set<java.lang.String>	getAllowedMimeTypes(java.util.Collection<FileMimeType> allowedMimeTypes, java.util.Collection<java.lang.String> otherMimeTypes) Expand the list of allowed mime types into the actual mime types as string
static java.lang.String	getEmailValidationMesssage(UserValidationResult result, MessageProducer mProducer)
static java.util.List<java.lang.String>	getFriendlyMimeTypes(java.util.Collection<FileMimeType> mimes, java.util.Collection<java.lang.String> otherTypes, MessageProducer messageProducer) Returns a list of user-friendly displayed mime types
static java.util.List<java.lang.String>	getFriendlyMimeTypes(java.util.Collection<java.lang.String> mimeTypes, MessageProducer messageProducer) Returns a list of user-friendly displayed mime types
static <T extends Bean> java.util.List<T>	getHierarchyPath(T bean, Property<T,T> parentProperty) Returns a list with the path from the hierarchy root up to the given object, having the given parent property to resolve an object's parent.
static <T extends Bean> int	getLevel(T bean, Property<T,T> parentProperty) Returns the level of a given hierarchical bean.
static java.lang.String	getPublicRegistrationMesssage(UserRegistrationResult result, MessageProducer mProducer)
static java.util.Comparator<UserLocatorVO>	getUserLocatorComparator()
static IntegerRangeDTO	integerRange(java.lang.Integer min, java.lang.Integer max) Creates a new IntegerRangeDTO
static java.lang.String	internalNameOrId(IEntity entity) For a given entity model, returns the internal name, if available, otherwise the id
static <T extends Bean> boolean	isEmpty(T bean, Property<?,? super T>... properties)
static boolean	isValid(DistanceDTO distance) Returns whether the given latitude / longitude is valid
static boolean	isValid(LatLongDTO latLong) Returns whether the given latitude / longitude is valid
static boolean	isValid(UserLocatorVO user) Returns whether the given user locator is valid
static LatLongDTO	latLong(java.math.BigDecimal latitude, java.math.BigDecimal longitude) Creates a new LatLongDTO
static LatLongDTO	latLong(double latitude, double longitude) Creates a new LatLongDTO
static java.lang.String	locatorText(java.lang.String text) Prepares the given text to be used as locator.
static Property<?,? super OperatorWithFieldsVO>	operatorWithFieldsProperty(BasicProfileField profileField) Returns the property from OperatorWithFieldsVO which matches the given profile field, or null if not applicable
static ImageNature	resolveImageNature(ImageVO image) Returns the image nature for the given ImageVO
static java.lang.String	stringFromVO(EntityVO vo) Returns the locator string from the given EntityVO.
static java.lang.String	stringOrIdFromVO(EntityVO vo) Same as stringFromVO(EntityVO), however, if no string can be resolved, returns the id
static TimeIntervalDTO	timeInterval(int amount, TimeField field) Creates a new TimeIntervalDTO
static java.lang.String	unqualifiedInternalNameOrId(IEntity entity) For a given entity model, returns the internal name, if available, otherwise the id
static java.lang.String	unqualifyInternalName(IInternalNamedEntity entity) Returns the unqualified internal name of the given entity.
static java.lang.String	unqualifyInternalName(java.lang.String internalName) Returns the unqualified internal name, for example, "a.b.c" returns "c".
static Property<?,? super UserWithFieldsVO>	userWithFieldsProperty(BasicProfileField profileField) Returns the property from UserWithFieldsVO which matches the given profile field, or null if not applicable
static <VO extends EntityVO> VO	voFromString(java.lang.Class<VO> voClass, java.lang.String value) Converts a textual value to a VO.
static <VO extends EntityVO> java.util.List<VO>	voListFromString(java.lang.Class<VO> voClass, java.util.Collection<java.lang.String> values) Returns each string element as a VO in a new set.
static <VO extends EntityVO> java.util.Set<VO>	vosFromString(java.lang.Class<VO> voClass, java.util.Collection<java.lang.String> values) Returns each string element as a VO in a new set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelHelper

public ModelHelper()

Method Detail

accountOwnerLocator

public static AccountOwnerLocator accountOwnerLocator(java.lang.String principal)

Creates a new AccountOwnerLocator.

amountSummary

public static AmountSummaryVO amountSummary(java.math.BigDecimal sum,
                                            java.math.BigDecimal average,
                                            int count,
                                            CurrencyVO currency)

Creates an amount summary

clearIds

public static void clearIds(java.lang.Iterable<? extends EntityModel> models)

Sets the ids of all models to null

copyProperties

public static <S extends Bean,T extends Bean> void copyProperties(S source,
                                                                  T target)

It copies from source to target (apply a bean over another bean) traversing all source's properties.
If a property is not found in the target bean or has a different type then it's ignored.

Throws:

java.lang.IllegalArgumentException - if source, target or both are null.

currencyAmount

public static CurrencyAmountDTO currencyAmount(CurrencyVO currency,
                                               java.math.BigDecimal amount)

Creates a new CurrencyAmountDTO.

currencyRange

public static CurrencyAmountRangeDTO currencyRange(CurrencyVO currency,
                                                   java.math.BigDecimal min,
                                                   java.math.BigDecimal max)

Creates a new CurrencyAmountRangeDTO.

datePeriod

public static DatePeriodDTO datePeriod(DateTime begin,
                                       DateTime end)

Creates a new DatePeriodDTO

decimalRange

public static DecimalRangeDTO decimalRange(java.math.BigDecimal min,
                                           java.math.BigDecimal max)

Creates a new DecimalRangeDTO

dictionary

public static DictionaryVO dictionary(java.lang.String dictionary,
                                      java.lang.String label)

Creates a new DictionaryVO.

dimensions

public static DimensionsDTO dimensions(int width,
                                       int height)

Creates a new DimensionsDTO

equals

public static boolean equals(LatLongDTO first,
                             LatLongDTO second)

Check if both coordinates are the same

escapeIdentifierIfNeeded

public static java.lang.String escapeIdentifierIfNeeded(java.lang.String value)

When the given value is a valid Long, return it escaped with a trailing '. Otherwise return the value as is.

getActualInternalNameOrId

public static java.lang.String getActualInternalNameOrId(EntityVO vo)

Returns the internal name of the given VO if it is valid (no nested paths contains a null part). Otherwise, returns the id as string

getAllowedMimeTypes

public static java.util.Set<java.lang.String> getAllowedMimeTypes(java.util.Collection<FileMimeType> allowedMimeTypes,
                                                                  java.util.Collection<java.lang.String> otherMimeTypes)

Expand the list of allowed mime types into the actual mime types as string

getEmailValidationMesssage

public static java.lang.String getEmailValidationMesssage(UserValidationResult result,
                                                          MessageProducer mProducer)

getFriendlyMimeTypes

public static java.util.List<java.lang.String> getFriendlyMimeTypes(java.util.Collection<FileMimeType> mimes,
                                                                    java.util.Collection<java.lang.String> otherTypes,
                                                                    MessageProducer messageProducer)

Returns a list of user-friendly displayed mime types

getFriendlyMimeTypes

public static java.util.List<java.lang.String> getFriendlyMimeTypes(java.util.Collection<java.lang.String> mimeTypes,
                                                                    MessageProducer messageProducer)

Returns a list of user-friendly displayed mime types

getHierarchyPath

public static <T extends Bean> java.util.List<T> getHierarchyPath(T bean,
                                                                  Property<T,T> parentProperty)

Returns a list with the path from the hierarchy root up to the given object, having the given parent property to resolve an object's parent. For example, if the given object is A1.1.1, the result is [A, A1, A1.1, A1.1.1]

getLevel

public static <T extends Bean> int getLevel(T bean,
                                            Property<T,T> parentProperty)

Returns the level of a given hierarchical bean. The given property needs to resolve the parent bean. Objects with no parent have level 1

getPublicRegistrationMesssage

public static java.lang.String getPublicRegistrationMesssage(UserRegistrationResult result,
                                                             MessageProducer mProducer)

getUserLocatorComparator

public static java.util.Comparator<UserLocatorVO> getUserLocatorComparator()

integerRange

public static IntegerRangeDTO integerRange(java.lang.Integer min,
                                           java.lang.Integer max)

Creates a new IntegerRangeDTO

internalNameOrId

public static java.lang.String internalNameOrId(IEntity entity)

For a given entity model, returns the internal name, if available, otherwise the id

isEmpty

@SafeVarargs
public static <T extends Bean> boolean isEmpty(T bean,
                                                            Property<?,? super T>... properties)

Parameters:

properties - list of Properties to be checked for empty/null

Returns:

true if observable is null or all of the specified properties are null or empty (see #isEmpty(Object)).

isValid

public static boolean isValid(DistanceDTO distance)

Returns whether the given latitude / longitude is valid

isValid

public static boolean isValid(LatLongDTO latLong)

Returns whether the given latitude / longitude is valid

isValid

public static boolean isValid(UserLocatorVO user)

Returns whether the given user locator is valid

latLong

public static LatLongDTO latLong(java.math.BigDecimal latitude,
                                 java.math.BigDecimal longitude)

Creates a new LatLongDTO

latLong

public static LatLongDTO latLong(double latitude,
                                 double longitude)

Creates a new LatLongDTO

locatorText

public static java.lang.String locatorText(java.lang.String text)

Prepares the given text to be used as locator. Basically removes leading and trailing single quotes, if any.

operatorWithFieldsProperty

public static Property<?,? super OperatorWithFieldsVO> operatorWithFieldsProperty(BasicProfileField profileField)

Returns the property from OperatorWithFieldsVO which matches the given profile field, or null if not applicable

resolveImageNature

public static ImageNature resolveImageNature(ImageVO image)

Returns the image nature for the given ImageVO

stringFromVO

public static java.lang.String stringFromVO(EntityVO vo)

Returns the locator string from the given EntityVO. For example, for UserLocatorVO, returns the principal. Will never return the id. If the VO has no representing string, returns null.

stringOrIdFromVO

public static java.lang.String stringOrIdFromVO(EntityVO vo)

Same as stringFromVO(EntityVO), however, if no string can be resolved, returns the id

timeInterval

public static TimeIntervalDTO timeInterval(int amount,
                                           TimeField field)

Creates a new TimeIntervalDTO

unqualifiedInternalNameOrId

public static java.lang.String unqualifiedInternalNameOrId(IEntity entity)

For a given entity model, returns the internal name, if available, otherwise the id

unqualifyInternalName

public static java.lang.String unqualifyInternalName(IInternalNamedEntity entity)

Returns the unqualified internal name of the given entity.

See Also:

unqualifyInternalName(String)

unqualifyInternalName

public static java.lang.String unqualifyInternalName(java.lang.String internalName)

Returns the unqualified internal name, for example, "a.b.c" returns "c".

userWithFieldsProperty

public static Property<?,? super UserWithFieldsVO> userWithFieldsProperty(BasicProfileField profileField)

Returns the property from UserWithFieldsVO which matches the given profile field, or null if not applicable

voFromString

public static <VO extends EntityVO> VO voFromString(java.lang.Class<VO> voClass,
                                                    java.lang.String value)

Converts a textual value to a VO. If the value is null, returns null. Else, if the value is a number, use it as id. Otherwise, use it as either internal name, principal (if a userLocatorVO) or account number (if an AccountVO)

voListFromString

public static <VO extends EntityVO> java.util.List<VO> voListFromString(java.lang.Class<VO> voClass,
                                                                        java.util.Collection<java.lang.String> values)

Returns each string element as a VO in a new set.

See Also:

voFromString(Class, String)

vosFromString

public static <VO extends EntityVO> java.util.Set<VO> vosFromString(java.lang.Class<VO> voClass,
                                                                    java.util.Collection<java.lang.String> values)

Returns each string element as a VO in a new set.

See Also:

voFromString(Class, String)