com.pega.pegarules.pub.generator

Interface PRObjectWrapperGenerator

public interface PRObjectWrapperGenerator

PRObjectWrapperGenerator provides the interface for standard java page wrapper generators. All access to wrappers should be made via the PRObjectWrapperGenerator class.

Version:

$Revision: 69724 $ $Date: 2013-09-24 15:19:02 -0400 (Tue, 24 Sep 2013) $

Author:

David Burns

Field Summary

Fields

Modifier and Type	Field and Description
static double	COMPAT_42SP1
static double	COMPAT_42SP2
static java.lang.String	COPYRIGHT
static java.lang.String	PRPC_WRAPPER_PACKAGE Last component of the package name for wrappers we will generate.
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Class	generateWrapper(java.lang.String wrapperClassName) Generate the specified wrapper.
java.lang.Class	generateWrapper(java.lang.String wrapperClassName, java.util.List userSelectedProperties) Generate the specified wrapper, only include properties listed.
double	getCompatibility() Return the compatibility setting for this Object Wrapper Generator.
boolean	getDesignTime() Get the current value of the design time flag.
java.lang.String	getSchema() Get the associated schema document.
void	setDesignTime(boolean designTime) Set flag to indicate that this generation is taking place at design time.
java.lang.String	typeNameFromWrapperName(java.lang.String wrapperName) Given a fully qualified wrapper name, return the type name.
java.lang.String	wrapperNameFromType(java.lang.Class type) Given a java type, return the wrapper name.
java.lang.String	wrapperNameFromTypeName(java.lang.String typeName) Given a fully qualified type name, return the wrapper name.

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

COMPAT_42SP2

static final double COMPAT_42SP2

See Also:

Constant Field Values

COMPAT_42SP1

static final double COMPAT_42SP1

See Also:

Constant Field Values

PRPC_WRAPPER_PACKAGE

static final java.lang.String PRPC_WRAPPER_PACKAGE

Last component of the package name for wrappers we will generate.

See Also:

Constant Field Values

Method Detail

getCompatibility

double getCompatibility()

Return the compatibility setting for this Object Wrapper Generator.

Returns:

the compatibility setting

wrapperNameFromTypeName

java.lang.String wrapperNameFromTypeName(java.lang.String typeName)

Given a fully qualified type name, return the wrapper name.

Parameters:

typeName - name of the type to be wrapped

Returns:

the name of the associated wrapper

typeNameFromWrapperName

java.lang.String typeNameFromWrapperName(java.lang.String wrapperName)

Given a fully qualified wrapper name, return the type name.

Parameters:

wrapperName - name of the wrapper

Returns:

the name of the associated type

wrapperNameFromType

java.lang.String wrapperNameFromType(java.lang.Class type)

Given a java type, return the wrapper name.

Parameters:

type - type to be wrapped

Returns:

the name of the associated wrapper

setDesignTime

void setDesignTime(boolean designTime)

Set flag to indicate that this generation is taking place at design time. When the design time flag is set, generator should also build the schema matching the bean structure for use in the accelerators. The schema will be accessed with the "getSchema" method following a call to "generateWrapper".

Parameters:

designTime - true if we are in design time, false otherwise.

getDesignTime

boolean getDesignTime()

Get the current value of the design time flag.

Returns:

true if we are in design time, false otherwise.

getSchema

java.lang.String getSchema()

Get the associated schema document. The document should be available at design time after a call to generateWrapps a design time

Returns:

the matching schema document

generateWrapper

java.lang.Class generateWrapper(java.lang.String wrapperClassName)
                                throws PRObjectWrapperException

Generate the specified wrapper. This generator should only attempt to generate wrappers it identifies as one that it generated. This allows wrappers to be modified without being overwritten.

Parameters:

wrapperClassName -

Returns:

Class object for the specified wrapper.

Throws:

PRObjectWrapperException - if the wrapper should not be generated.

generateWrapper

java.lang.Class generateWrapper(java.lang.String wrapperClassName,
                              java.util.List userSelectedProperties)
                                throws PRObjectWrapperException

Generate the specified wrapper, only include properties listed.

Parameters:

wrapperClassName - Names of the wrapper class to generate.

userSelectedProperties - Names of the properties we are interested in.

Returns:

Class object for the specified wrapper.

Throws:

PRObjectWrapperException