com.pega.pegarules.pub.clipboard.mapping

Interface EntityMap

public interface EntityMap

Map of clipboard entities to their corresponding data stream entities, e.g. JSON fields. Use the EntityMapBuilder to build individual entity metadata and then add to this map.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
void	addAppendAndMapToMapping(ClipboardEntity clipboardContext, DataStreamEntity dataStreamContext)
void	addMapping(ClipboardEntity clipboardMetadata, DataStreamEntity dataStreamMetadata) Associate mapping between a clipboard property and a data stream field (e.g.
void	addMapping(ClipboardEntity clipboardMetadata, DataStreamEntity dataStreamMetadata, boolean autoMap) Associate mapping between a clipboard property and a data stream field (e.g.
void	addUpdateContextMapping(ClipboardEntity clipboardMetadata, DataStreamEntity dataStreamMetadata) Associate mapping between a clipboard property and a data stream field and specify that it is an update context mapping.
void	convertPageListToScalarList(ClipboardEntity clipboardMetadata, java.lang.String aValueProperty) Specify that a ClipboardProperty containing a PageList should be converted to a scalar array rather than an array of JSON objects.
void	createMultidimensionalArrays(boolean aValue) Specify whether PageList properties of PageList of SingleValue- pages should be serialized to a multidimensional array
ClipboardEntity	getClipboardEntity(DataStreamEntity aEntity) Gets the associated ClipboardEntity in the mapping, or null if none exists.
DataStreamEntity	getDataStreamEntity(ClipboardEntity aEntity) Gets the associated DataStreamEntity in the mapping, or null if none exists.
DateFormat	getDateFormat() Returns the current DateFormat
java.lang.String	getTopLevelPageListClass() Returns the top level page list class set by setTopLevelPageListClass(java.lang.String)
void	removeSkippedProperty(java.lang.String aProperty) Removes the property name from the skip list.
void	setDateFormat(DateFormat dateFormat) Specify the DateFormat
void	setTopLevelPageListClass(java.lang.String className) Specify the class name of the page list property to which the top level JSON array needs to be mapped.
boolean	shouldCreateMultidimensionalArrays() Should PageList properties of PageList of SingleValue- pages should be serialized to a multidimensional array
void	skipProperty(java.lang.String aProperty) Adds the given property name to the skip list.

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

addMapping

void addMapping(ClipboardEntity clipboardMetadata,
                DataStreamEntity dataStreamMetadata)

Associate mapping between a clipboard property and a data stream field (e.g. JSON field)

Parameters:

clipboardMetadata -

dataStreamMetadata -

addMapping

void addMapping(ClipboardEntity clipboardMetadata,
                DataStreamEntity dataStreamMetadata,
                boolean autoMap)

Associate mapping between a clipboard property and a data stream field (e.g. JSON field) and specify if the sub trees represented by these fields auto map. For example, a JSON object represented by dataStreamMetadata can be auto mapped to the clipboard page represented by clipboardMetadata.

Parameters:

clipboardMetadata -

dataStreamMetadata -

autoMap -

addUpdateContextMapping

void addUpdateContextMapping(ClipboardEntity clipboardMetadata,
                             DataStreamEntity dataStreamMetadata)

Associate mapping between a clipboard property and a data stream field and specify that it is an update context mapping.

Parameters:

clipboardMetadata -

dataStreamMetadata -

getClipboardEntity

ClipboardEntity getClipboardEntity(DataStreamEntity aEntity)
                            throws java.lang.IllegalArgumentException

Gets the associated ClipboardEntity in the mapping, or null if none exists.

Parameters:

aEntity - the DataStreamEntity associated with the ClipboardEntity in the mapping

Returns:

the ClipboardEntity, or null if it is not in the mapping

Throws:

java.lang.IllegalArgumentException - when the DataStreamEntity is not of the correct child class

getDataStreamEntity

DataStreamEntity getDataStreamEntity(ClipboardEntity aEntity)

Gets the associated DataStreamEntity in the mapping, or null if none exists.

Parameters:

aEntity - the ClipboardEntity associated with the DataStreamEntity in the mapping

Returns:

the DataStreamEntity, or null if it is not in the mapping

skipProperty

void skipProperty(java.lang.String aProperty)

Adds the given property name to the skip list. Properties on this list will not be mapped even during automapping.

Parameters:

aProperty - - the name of the property to skip

removeSkippedProperty

void removeSkippedProperty(java.lang.String aProperty)

Removes the property name from the skip list. Properties on this list will not be mapped even during automapping.

Parameters:

aProperty - - the name of the property to not skip

createMultidimensionalArrays

void createMultidimensionalArrays(boolean aValue)

Specify whether PageList properties of PageList of SingleValue- pages should be serialized to a multidimensional array

Parameters:

aValue -

shouldCreateMultidimensionalArrays

boolean shouldCreateMultidimensionalArrays()

Should PageList properties of PageList of SingleValue- pages should be serialized to a multidimensional array

Returns:

whether or not multidimensional arrays will be created

convertPageListToScalarList

void convertPageListToScalarList(ClipboardEntity clipboardMetadata,
                                 java.lang.String aValueProperty)

Specify that a ClipboardProperty containing a PageList should be converted to a scalar array rather than an array of JSON objects. The values of the ClipboardProperty named aValueProperty will be taken from each page in the PageList and output to a single scalar array. Can also be used to denote a multidimensional array should be created out of a PageList of PageLists as arrays are themselves scalar elements - an array of arrays of scalars is still a scalar array

Parameters:

clipboardMetadata -

aValueProperty -

setTopLevelPageListClass

void setTopLevelPageListClass(java.lang.String className)

Specify the class name of the page list property to which the top level JSON array needs to be mapped. This class name needs to be set only if the top level page list property's page class is not defined to be a definitive class, for example $CLASS or $ANY etc.

Parameters:

className -

getTopLevelPageListClass

java.lang.String getTopLevelPageListClass()

Returns the top level page list class set by setTopLevelPageListClass(java.lang.String)

Returns:

the top level page list class

setDateFormat

void setDateFormat(DateFormat dateFormat)

Specify the DateFormat

Parameters:

dateFormat -

getDateFormat

DateFormat getDateFormat()

Returns the current DateFormat

Returns:

DateFormat

addAppendAndMapToMapping

void addAppendAndMapToMapping(ClipboardEntity clipboardContext,
                              DataStreamEntity dataStreamContext)