de.hybris.platform.webservicescommons.mapping.impl

Class DefaultFieldSetBuilder

java.lang.Object

de.hybris.platform.webservicescommons.mapping.impl.DefaultFieldSetBuilder

All Implemented Interfaces:

FieldSetBuilder

public class DefaultFieldSetBuilder
extends Object
implements FieldSetBuilder

Default implementation of FieldSetBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultFieldSetBuilder()

Method Summary

Modifier and Type	Method and Description
Set<String>	createFieldSet(Class clazz, String fieldPrefix, String configuration) Method converts configuration string to set of field names
Set<String>	createFieldSet(Class clazz, String fieldPrefix, String configuration, FieldSetBuilderContext context) Method converts configuration string to set of fully qualified field names eg.
protected String	createFullFieldName(String basePrefix, String fieldName) Method create fully qualified field name
int	getDefaultMaxFieldSetSize()
int	getDefaultRecurrencyLevel()
FieldSetLevelHelper	getFieldSetLevelHelper()
protected Type	getFieldType(String fieldName, Class objectClass) Method returns field type
Set<Class>	getSimpleClassSet()
SubclassRegistry	getSubclassRegistry()
protected boolean	isSimpleClass(Class clazz) Method check if class should be considered as simple.
void	setDefaultMaxFieldSetSize(int defaultMaxFieldSetSize)
void	setDefaultRecurrencyLevel(int defaultRecurrencyLevel)
void	setFieldSetLevelHelper(FieldSetLevelHelper fieldSetLevelHelper)
void	setSimpleClassSet(Set<Class> simpleTypeSet)
void	setSubclassRegistry(SubclassRegistry subclassRegistry)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFieldSetBuilder

public DefaultFieldSetBuilder()

Method Detail

createFieldSet

public Set<String> createFieldSet(Class clazz,
                                  String fieldPrefix,
                                  String configuration)

Description copied from interface: FieldSetBuilder

Method converts configuration string to set of field names

Specified by:

createFieldSet in interface FieldSetBuilder

Parameters:

clazz - - class of object for which field set is created

fieldPrefix - - prefix which should be added to field name

configuration - - string describing properties which should be added to the set

Returns:

set of fully qualified field names

createFieldSet

public Set<String> createFieldSet(Class clazz,
                                  String fieldPrefix,
                                  String configuration,
                                  FieldSetBuilderContext context)

Method converts configuration string to set of fully qualified field names eg. address.country.name, address.country.isocode.
For example :
- createFieldSet(AddressData.class,"address","firstName, lastName") will return set {address.firstName,address.lastName}
- createFieldSet(AddressData.class,"address","BASIC,town") when definition for BASIC level ="firstName, lastName" will return {address.firstName,address.lastName,address.town}

Specified by:

createFieldSet in interface FieldSetBuilder

Parameters:

clazz - - class of object for which field set is created

fieldPrefix - - prefix which should be added to field name

configuration - - string describing properties which should be added to the set

context - - object storing additional information like :
typeVariableMap - map containing information about types used in generic class
e.g. if we have type class like ProductSearchPageData we should give map like {STATE=SearchStateData.class, RESULT=ProductData.class}
recurrencyLevel - define how many recurrency level builder should support (it is case when object have it's own type field e.g. VariantMatrixElementData have elements which are also VariantMatrixElementData type)
recurrencyMap - map for controlling recurrency level

Returns:

set of fully qualified field names

getFieldType

protected Type getFieldType(String fieldName,
                            Class objectClass)

Method returns field type

Parameters:

fieldName - - field name

objectClass - - object class

Returns:

field type

createFullFieldName

protected String createFullFieldName(String basePrefix,
                                     String fieldName)

Method create fully qualified field name

Parameters:

basePrefix - - prefix

fieldName - - field name

Returns:

fully qualified field name

isSimpleClass

protected boolean isSimpleClass(Class clazz)

Method check if class should be considered as simple. Simple class cannot have configuration. So if class of field1 is simple we cannot use : field1(field11,field12)

Parameters:

clazz - - field class

Returns:

true - if field type is simple
false - if field type is complex

getSimpleClassSet

public Set<Class> getSimpleClassSet()

setSimpleClassSet

public void setSimpleClassSet(Set<Class> simpleTypeSet)

getDefaultRecurrencyLevel

public int getDefaultRecurrencyLevel()

setDefaultRecurrencyLevel

public void setDefaultRecurrencyLevel(int defaultRecurrencyLevel)

getFieldSetLevelHelper

public FieldSetLevelHelper getFieldSetLevelHelper()

setFieldSetLevelHelper

public void setFieldSetLevelHelper(FieldSetLevelHelper fieldSetLevelHelper)

getDefaultMaxFieldSetSize

public int getDefaultMaxFieldSetSize()

setDefaultMaxFieldSetSize

public void setDefaultMaxFieldSetSize(int defaultMaxFieldSetSize)

getSubclassRegistry

public SubclassRegistry getSubclassRegistry()

setSubclassRegistry

public void setSubclassRegistry(SubclassRegistry subclassRegistry)