org.cyclos.utils

Class CustomFieldHelper

java.lang.Object

org.cyclos.utils.CustomFieldHelper

public class CustomFieldHelper
extends java.lang.Object

Helper class for handling custom fields and their values

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<ICustomFieldPossibleValue<?>>	POSSIBLE_VALUES_COMPARATOR Comparator for possible values (any ICustomFieldPossibleValue with a null value will be placed first in the sorted result)
static java.lang.String	VALUE_SEPARATOR Separator used when multiple values are parsed from a String

Constructor Summary

Constructors

Constructor and Description
CustomFieldHelper()

Method Summary

Modifier and Type	Method and Description
static void	fillNewFieldValue(CustomFieldDetailedVO field, CustomFieldValueDTO customValue) Fills-in a new custom field value instance for a new value on the given field.
static void	fillNewFieldValue(UserCustomFieldDetailedVO field, UserCustomFieldValueDTO customValue) Same as fillNewFieldValue(CustomFieldDetailedVO, CustomFieldValueDTO) but working with UserCustomFieldDetailedVO
static UserProfileFieldActions	findActions(ProfileField profileField, java.lang.Iterable<UserProfileFieldActions> actions) Returns the actions collection for the given profile field
static <V extends ICustomFieldValue<?,?>> V	findValue(ICustomField field, java.util.Collection<? extends V> values) Finds a custom field value inside a collection We assume that the values collection and the field passed are of the same entity, so we can unqualify both of them
static CustomFieldValueDTO	findValueOrNew(CustomFieldDetailedVO field, java.util.Collection<CustomFieldValueDTO> customValues) Finds a custom field value inside a collection.
static java.util.List<UserCustomFieldDetailedVO>	getCustomFields(java.lang.Iterable<UserProfileFieldActions> actions) Returns the custom fields in the given collection of actions
static java.lang.Object	getCustomFieldValue(CustomFieldType type, ICustomFieldValue value) Returns the property used to retrieve the value of a field given it's type
static java.lang.Object	getCustomFieldValue(ICustomFieldValue<?,?> value) Returns the property used to retrieve the value of a field given it's type
static java.lang.Object	getDefaultValue(CustomFieldDetailedVO field) Returns the default value for the given field
static java.util.Collection<CustomFieldPossibleValueVO>	getEnumeratedValues(ICustomFieldValue<?,?> fieldValue)
static EntityVO	getLinkedEntity(LinkedEntityVO vo) Returns the specific EntityVO associated with the given LinkedEntityVO, according to the subclass.
static ProfileField	getProfileField(UserProfileFieldActions actions) Returns the profile field for the given actions collection
static java.lang.String	getReferenceValue(ICustomFieldValue<?,?> fieldValue)
static java.lang.Object	getValue(java.lang.Long customFieldId, java.util.Collection<? extends ICustomFieldValue<?,?>> customValues) Returns the value of a custom field from a collection, finding the value by internal name.
static java.lang.Object	getValue(java.lang.String internalName, java.util.Collection<? extends ICustomFieldValue<?,?>> customValues) Returns the value of a custom field from a collection, finding the value by internal name.
static java.lang.Object	getValue(UserWithFieldsVO user, ProfileField profileField) Returns a profile field value for a given UserWithFieldsVO
static java.util.List<?>	getValuesList(CustomFieldDetailedVO field) Returns the values list from a given custom field
static boolean	hasAnyFieldWithInformation(java.util.Collection<?> fieldActions) Returns whether at least one of the given fields (either field detailed or field actions) have information text
static boolean	hasValue(CustomFieldValueDTO fieldValue)
static CustomFieldValueDTO	newFieldValue(CustomFieldDetailedVO field) Creates a new custom field value for the given field
static void	qualifyInternalName(java.lang.String customFieldInternalName, CustomFieldPossibleValueVO possibleValue) Qualifies the internal name of the given possible value with the custom field internal name.
static void	setCustomFieldValue(ICustomFieldValue<?,?> fieldValue, java.lang.Object value) Returns the property used to retrieve the value of a field given it's type
static boolean	setValue(java.lang.String internalName, java.util.Collection<? extends ICustomFieldValue<?,?>> customValues, java.lang.Object value) Sets the value of a custom field given the values collection, finding by field internal name
static java.util.Map<java.lang.String,ICustomField>	toFieldsMap(java.util.Collection<? extends ICustomField> fields) Returns a Map, keyed by the custom field's unqualified internal name , whose value is the custom field of the received collection.
static java.util.Map<ICustomField,ICustomFieldValue>	toMap(java.util.Collection<? extends ICustomFieldValue> customValues) Returns a Map, keyed by the custom field , whose values are the custom field values of the received collection.
static java.lang.String	toReference(ICustomFieldValue<RawFileVO,ImageVO> fieldValue) Converts a ICustomFieldValue to a reference, that is, a string representation

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_SEPARATOR

public static java.lang.String VALUE_SEPARATOR

Separator used when multiple values are parsed from a String

POSSIBLE_VALUES_COMPARATOR

public static java.util.Comparator<ICustomFieldPossibleValue<?>> POSSIBLE_VALUES_COMPARATOR

Comparator for possible values (any ICustomFieldPossibleValue with a null value will be placed first in the sorted result)

Constructor Detail

CustomFieldHelper

public CustomFieldHelper()

Method Detail

fillNewFieldValue

public static void fillNewFieldValue(CustomFieldDetailedVO field,
                                     CustomFieldValueDTO customValue)

Fills-in a new custom field value instance for a new value on the given field. Should be used when there are custom subclasses of CustomFieldValueDTO and newFieldValue(CustomFieldDetailedVO) is not enough. Sets the field reference and the default value.

fillNewFieldValue

public static void fillNewFieldValue(UserCustomFieldDetailedVO field,
                                     UserCustomFieldValueDTO customValue)

Same as fillNewFieldValue(CustomFieldDetailedVO, CustomFieldValueDTO) but working with UserCustomFieldDetailedVO

findActions

public static UserProfileFieldActions findActions(ProfileField profileField,
                                                  java.lang.Iterable<UserProfileFieldActions> actions)

Returns the actions collection for the given profile field

findValue

public static <V extends ICustomFieldValue<?,?>> V findValue(ICustomField field,
                                                             java.util.Collection<? extends V> values)

Finds a custom field value inside a collection We assume that the values collection and the field passed are of the same entity, so we can unqualify both of them

findValueOrNew

public static CustomFieldValueDTO findValueOrNew(CustomFieldDetailedVO field,
                                                 java.util.Collection<CustomFieldValueDTO> customValues)

Finds a custom field value inside a collection. If none found, creates a new one and adds to the collection before returning

getCustomFields

public static java.util.List<UserCustomFieldDetailedVO> getCustomFields(java.lang.Iterable<UserProfileFieldActions> actions)

Returns the custom fields in the given collection of actions

getCustomFieldValue

public static java.lang.Object getCustomFieldValue(CustomFieldType type,
                                                   ICustomFieldValue value)

Returns the property used to retrieve the value of a field given it's type

getCustomFieldValue

public static java.lang.Object getCustomFieldValue(ICustomFieldValue<?,?> value)

Returns the property used to retrieve the value of a field given it's type

getDefaultValue

public static java.lang.Object getDefaultValue(CustomFieldDetailedVO field)

Returns the default value for the given field

getEnumeratedValues

public static java.util.Collection<CustomFieldPossibleValueVO> getEnumeratedValues(ICustomFieldValue<?,?> fieldValue)

getLinkedEntity

public static EntityVO getLinkedEntity(LinkedEntityVO vo)

Returns the specific EntityVO associated with the given LinkedEntityVO, according to the subclass.

See Also:

LinkedUserVO.getUser(), LinkedTransactionVO.getTransaction(), LinkedTransferVO.getTransfer(), LinkedAdVO.getAd(), LinkedRecordVO.getRecord()

getProfileField

public static ProfileField getProfileField(UserProfileFieldActions actions)

Returns the profile field for the given actions collection

getReferenceValue

public static java.lang.String getReferenceValue(ICustomFieldValue<?,?> fieldValue)

getValue

public static java.lang.Object getValue(java.lang.Long customFieldId,
                                        java.util.Collection<? extends ICustomFieldValue<?,?>> customValues)

Returns the value of a custom field from a collection, finding the value by internal name.

getValue

public static java.lang.Object getValue(java.lang.String internalName,
                                        java.util.Collection<? extends ICustomFieldValue<?,?>> customValues)

Returns the value of a custom field from a collection, finding the value by internal name.

getValue

public static java.lang.Object getValue(UserWithFieldsVO user,
                                        ProfileField profileField)

Returns a profile field value for a given UserWithFieldsVO

getValuesList

public static java.util.List<?> getValuesList(CustomFieldDetailedVO field)

Returns the values list from a given custom field

hasAnyFieldWithInformation

public static boolean hasAnyFieldWithInformation(java.util.Collection<?> fieldActions)

Returns whether at least one of the given fields (either field detailed or field actions) have information text

hasValue

public static boolean hasValue(CustomFieldValueDTO fieldValue)

newFieldValue

public static CustomFieldValueDTO newFieldValue(CustomFieldDetailedVO field)

Creates a new custom field value for the given field

qualifyInternalName

public static void qualifyInternalName(java.lang.String customFieldInternalName,
                                       CustomFieldPossibleValueVO possibleValue)

Qualifies the internal name of the given possible value with the custom field internal name. For example if the custom field internal name is "a" and the internal name of tej possible value is "b" then it returns "a.b"

setCustomFieldValue

public static void setCustomFieldValue(ICustomFieldValue<?,?> fieldValue,
                                       java.lang.Object value)

Returns the property used to retrieve the value of a field given it's type

setValue

public static boolean setValue(java.lang.String internalName,
                               java.util.Collection<? extends ICustomFieldValue<?,?>> customValues,
                               java.lang.Object value)

Sets the value of a custom field given the values collection, finding by field internal name

toFieldsMap

public static java.util.Map<java.lang.String,ICustomField> toFieldsMap(java.util.Collection<? extends ICustomField> fields)

Returns a Map, keyed by the custom field's unqualified internal name , whose value is the custom field of the received collection.

toMap

public static java.util.Map<ICustomField,ICustomFieldValue> toMap(java.util.Collection<? extends ICustomFieldValue> customValues)

Returns a Map, keyed by the custom field , whose values are the custom field values of the received collection.

toReference

public static java.lang.String toReference(ICustomFieldValue<RawFileVO,ImageVO> fieldValue)

Converts a ICustomFieldValue to a reference, that is, a string representation