com.pega.pegarules.pub.util

Interface SchemaParser

public interface SchemaParser

SchemaParser base class, used to generate new class instances

Version:

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

Author:

Peter Tandara-Kuhns

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	generateClassRules(boolean aValue) Set a flag to indicate whether instances of Rule-Obj-Class should be generated and appended to the list of generated rules.
void	generateModelRules(boolean aValue) Set a flag to indicate whether instances of Rule-Obj-Model should be generated and appended to the list of generated rules.
void	generateParseRules(boolean aValue) Set a flag to indicate whether instances of Rule-Parse-XML should be generated and appended to the list of generated rules.
void	generatePropertyRules(boolean aValue) Set a flag to indicate whether instances of Rule-Obj-Property should be generated and appended to the list of generated rules.
ClipboardPage	generateRules() Generate rules for the selected subset of global complex element and type definitions.
void	generateStreamRules(boolean aValue) Set a flag to indicate whether instances of Rule-Obj-XML should be generated and appended to the list of generated rules.
java.util.Map	getElemNameToClassMap() Get a map of Rule-Obj-Class names, keyed by the qualified names of global element declarations.
java.util.List	getGlobalTypeSet(PRFile aFile) Parse a schema definition document to get the list of global complex element and type definitions.
java.util.List	getGlobalTypeSet(java.io.Reader aReader) Parse a schema definition document to get the list of global complex element and type definitions.
java.util.List	getGlobalTypeSet(java.lang.String aSource) Parse a schema definition document to get the list of global complex element and type definitions.
java.util.List	getParseWarnings() Get a list of warning messages for erroneous but non-fatal events that occured during the parsing of the schema document.
java.util.Map	getQNameToGeneratedClassMapping() Deprecated.
java.util.Map	getTypeNameToArrayTypeMap() Get a map of QName objects for for resolving SOAP array types.
java.util.Map	getTypeNameToClassMap() Get a map of Rule-Obj-Class names, keyed by the qualified names of complex type definitions.
java.util.Map	getXSDTypeToStringTypeMap() Get a map of Rule-Obj-Property string types, keyed by XSD type name.
ClipboardPage	parse(PRFile aFile) Parse a schema definition document into class, model, and property instances.
ClipboardPage	parse(java.io.Reader aReader) Parse a schema definition document into class, model, and property instances.
ClipboardPage	parse(java.lang.String aSource) Parse a schema definition document into class, model, and property instances.
void	setBaseClassPrefix(java.lang.String aClassName) Set the name of the PegaRULES base class that will be pre-pended to the class name of all generated rule instances.
void	setDocumentURL(java.net.URL aURL) Set the URL of the document being parsed.
void	setGlobalTypeSet(java.util.List aTypeSet) Reset the list of global complex element and type definitions that will be used for generating rules.
void	setNormalizeClassName(boolean aValue) Set the 'normalize class name' flag.
void	setNormalizePropertyName(boolean aValue) Set the 'normalize property name' flag.
void	setResultsPageName(java.lang.String aPageName) Set the name of the Code-Pega-List page where class definitions will be stored.
void	setRulesetName(java.lang.String aRulesetName) Set the name of the PegaRULES ruleset that will be used for all generated rule instances.
void	setRulesetVersion(java.lang.String aRulesetVersion) Set the name of the PegaRULES ruleset version that will be used for all generated rule instances.
void	setTruncateClassName(boolean aValue) Set the 'truncate class name' flag.

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

setDocumentURL

void setDocumentURL(java.net.URL aURL)

Set the URL of the document being parsed. If additional documents need to be loaded via include or import directives, the source document URL will be used for any relative file references.

Parameters:

aURL - source document URL

setBaseClassPrefix

void setBaseClassPrefix(java.lang.String aClassName)

Set the name of the PegaRULES base class that will be pre-pended to the class name of all generated rule instances.

Parameters:

aClassName - PegaRULES class name identifier

setRulesetName

void setRulesetName(java.lang.String aRulesetName)

Set the name of the PegaRULES ruleset that will be used for all generated rule instances.

Parameters:

aRulesetName - PegaRULES ruleset identifier

setRulesetVersion

void setRulesetVersion(java.lang.String aRulesetVersion)

Set the name of the PegaRULES ruleset version that will be used for all generated rule instances.

Parameters:

aRulesetVersion - PegaRULES ruleset version identifier

setResultsPageName

void setResultsPageName(java.lang.String aPageName)

Set the name of the Code-Pega-List page where class definitions will be stored.

Parameters:

aPageName - name of the Code-Pega-List page

generateClassRules

void generateClassRules(boolean aValue)

Set a flag to indicate whether instances of Rule-Obj-Class should be generated and appended to the list of generated rules. If not specified, the default value is true

Parameters:

aValue - flag value

generatePropertyRules

void generatePropertyRules(boolean aValue)

Set a flag to indicate whether instances of Rule-Obj-Property should be generated and appended to the list of generated rules. If not specified, the default value is true

Parameters:

aValue - flag value

generateModelRules

void generateModelRules(boolean aValue)

Set a flag to indicate whether instances of Rule-Obj-Model should be generated and appended to the list of generated rules. If not specified, the default value is true

Parameters:

aValue - flag value

generateParseRules

void generateParseRules(boolean aValue)

Set a flag to indicate whether instances of Rule-Parse-XML should be generated and appended to the list of generated rules. If not specified, the default value is false

Parameters:

aValue - flag value

generateStreamRules

void generateStreamRules(boolean aValue)

Set a flag to indicate whether instances of Rule-Obj-XML should be generated and appended to the list of generated rules. If not specified, the default value is false

Parameters:

aValue - flag value

setNormalizePropertyName

void setNormalizePropertyName(boolean aValue)

Set the 'normalize property name' flag. Used when the property names are already valid PRPC property names. If not specified, the default value is true

Parameters:

aValue - flag value

setNormalizeClassName

void setNormalizeClassName(boolean aValue)

Set the 'normalize class name' flag. Used when the class names are not valid PRPC property names. If not specified, the default value is true

Parameters:

aValue - flag value

setTruncateClassName

void setTruncateClassName(boolean aValue)

Set the 'truncate class name' flag. Used for user-configurable name mangling in the accelerator. If not specified, the default value is true

Parameters:

aValue - flag value

getGlobalTypeSet

java.util.List getGlobalTypeSet(PRFile aFile)
                                throws PRException

Parse a schema definition document to get the list of global complex element and type definitions.

Parameters:

aFile - schema definition document, as file

Returns:

list of global definition names

Throws:

PRException

getGlobalTypeSet

java.util.List getGlobalTypeSet(java.lang.String aSource)
                                throws PRException

Parse a schema definition document to get the list of global complex element and type definitions.

Parameters:

aSource - schema definition document, as string

Returns:

list of global definition names

Throws:

PRException

getGlobalTypeSet

java.util.List getGlobalTypeSet(java.io.Reader aReader)
                                throws PRException

Parse a schema definition document to get the list of global complex element and type definitions.

Parameters:

aReader - schema definition document, as reader

Returns:

list of global definition names

Throws:

PRException

setGlobalTypeSet

void setGlobalTypeSet(java.util.List aTypeSet)

Reset the list of global complex element and type definitions that will be used for generating rules. This method must be called after getGlobalTypeSet, and the list must contain a subset of the list of values returned by that method.

Parameters:

aTypeSet - list of global definition names

generateRules

ClipboardPage generateRules()
                            throws PRException

Generate rules for the selected subset of global complex element and type definitions. This method must be called after calling getGlobalTypeSet and setGlobalTypeSet.

Returns:

Code-Pega-List instance containing generated rule instances

Throws:

PRException

parse

ClipboardPage parse(PRFile aFile)
                    throws PRException

Parse a schema definition document into class, model, and property instances.

Parameters:

aFile - schema definition document, as file

Returns:

Code-Pega-List instance containing generated rule instances

Throws:

PRException

parse

ClipboardPage parse(java.lang.String aSource)
                    throws PRException

Parse a schema definition document into class, model, and property instances.

Parameters:

aSource - schema definition document, as string

Returns:

Code-Pega-List instance containing generated rule instances

Throws:

PRException

parse

ClipboardPage parse(java.io.Reader aReader)
                    throws PRException

Parse a schema definition document into class, model, and property instances.

Parameters:

aReader - schema definition document, as reader

Returns:

Code-Pega-List instance containing generated rule instances

Throws:

PRException

getParseWarnings

java.util.List getParseWarnings()

Get a list of warning messages for erroneous but non-fatal events that occured during the parsing of the schema document.

Returns:

list of warning messages

getXSDTypeToStringTypeMap

java.util.Map getXSDTypeToStringTypeMap()

Get a map of Rule-Obj-Property string types, keyed by XSD type name.

Returns:

map of class names

getTypeNameToArrayTypeMap

java.util.Map getTypeNameToArrayTypeMap()

Get a map of QName objects for for resolving SOAP array types.

Returns:

map of QName objects

getTypeNameToClassMap

java.util.Map getTypeNameToClassMap()

Get a map of Rule-Obj-Class names, keyed by the qualified names of complex type definitions. Qualified names have this format: {namespaceURI}localname

Returns:

map of class names

getElemNameToClassMap

java.util.Map getElemNameToClassMap()

Get a map of Rule-Obj-Class names, keyed by the qualified names of global element declarations. Qualified names have this format: {namespaceURI}localname

Returns:

map of class names

getQNameToGeneratedClassMapping

java.util.Map getQNameToGeneratedClassMapping()

Deprecated.

Get a map of Rule-Obj-Class names, keyed by the qualified names of global element declarations or complex type definitions. Qualified names have this format: {namespaceURI}localname

Returns:

map of class names