com.pega.pegarules.pub.util
Interface ParseUtils

public interface ParseUtils

Utilities for using Rule-Parse-XML and Rule-Parse-Delimited.

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

David Dority

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

boolean	parseDelimited(java.io.Reader aData, java.lang.String aNamespace, java.lang.String aRecordType, ClipboardPage aPrimaryPage, ParameterPage aParameterPage) Apply a delimited parse rule.
boolean	parseDelimited(java.io.Reader aData, java.lang.String aNamespace, java.lang.String aRecordType, ClipboardPage aPrimaryPage, ParameterPage aParameterPage, int length) Apply a delimited parse rule.
boolean	parseDelimited(java.io.Reader aData, java.lang.String aNamespace, java.lang.String aRecordType, ClipboardPage aPrimaryPage, ParameterPage aParameterPage, java.lang.String aDelimiter) Apply a delimited parse rule.
void	parseStructured(java.io.Reader aData, java.lang.String aRecordType, ClipboardPage aPrimaryPage, ParameterPage aParameterPage) Apply a structured parse rule.
void	parseXML(org.w3c.dom.Element aNode, java.lang.String aNamespace, ClipboardPage aPrimaryPage) Deprecated.
void	parseXML(org.w3c.dom.Element aNode, java.lang.String aNamespace, java.lang.String aElementName, ClipboardPage aPrimaryPage) Apply an XML parse rule.
void	parseXML(java.io.Reader aReader, java.lang.String aNamespace, ClipboardPage aPrimaryPage) Deprecated.
void	parseXML(java.io.Reader aReader, java.lang.String aNamespace, java.lang.String aElementName, ClipboardPage aPrimaryPage) Apply an XML parse rule.
void	parseXML(java.lang.String aXMLData, java.lang.String aNamespace, ClipboardPage aPrimaryPage) Deprecated.
void	parseXML(java.lang.String aXMLData, java.lang.String aNamespace, ClipboardPage aPrimaryPage, java.lang.String aElementName) Deprecated.
void	parseXML(java.lang.String aXMLData, java.lang.String aNamespace, java.lang.String aElementName, ClipboardPage aPrimaryPage) Apply an XML parse rule.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

Method Detail

parseXML

void parseXML(java.lang.String aXMLData,
              java.lang.String aNamespace,
              java.lang.String aElementName,
              ClipboardPage aPrimaryPage)

Apply an XML parse rule.

Parameters:

aXMLData - the XML data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aElementName - the 'pyElementName' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

parseXML

void parseXML(java.io.Reader aReader,
              java.lang.String aNamespace,
              java.lang.String aElementName,
              ClipboardPage aPrimaryPage)

Apply an XML parse rule.

Parameters:

aReader - the XML data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aElementName - the 'pyElementName' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

parseXML

void parseXML(org.w3c.dom.Element aNode,
              java.lang.String aNamespace,
              java.lang.String aElementName,
              ClipboardPage aPrimaryPage)

Apply an XML parse rule.

Parameters:

aNode - the DOM node that contains the data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aElementName - the 'pyElementName' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

parseXML

void parseXML(java.lang.String aXMLData,
              java.lang.String aNamespace,
              ClipboardPage aPrimaryPage,
              java.lang.String aElementName)

Deprecated.

Apply an XML parse rule.

Parameters:

aXMLData - the XML data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

aElementName - the 'pyElementName' key from the Rule-Parse-XML instance

parseXML

void parseXML(java.lang.String aXMLData,
              java.lang.String aNamespace,
              ClipboardPage aPrimaryPage)

Deprecated.

Apply an XML parse rule. The 'pyElementName' key will be derived from the root element of the XML data being parsed.

Parameters:

aXMLData - the XML data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

parseXML

void parseXML(java.io.Reader aReader,
              java.lang.String aNamespace,
              ClipboardPage aPrimaryPage)

Deprecated.

Apply an XML parse rule. The 'pyElementName' key will be derived from the local name of the root element of the XML data being parsed.

Parameters:

aReader - a stream of XML data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

parseXML

void parseXML(org.w3c.dom.Element aNode,
              java.lang.String aNamespace,
              ClipboardPage aPrimaryPage)

Deprecated.

Apply an XML parse rule. The 'pyElementName' key will be derived from the local name of the root element of the XML data being parsed.

Parameters:

aNode - the DOM node that contains the data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-XML instance

aPrimaryPage - the primary page of Rule-Parse-XML instance

parseStructured

void parseStructured(java.io.Reader aData,
                     java.lang.String aRecordType,
                     ClipboardPage aPrimaryPage,
                     ParameterPage aParameterPage)

Apply a structured parse rule. The key is derived from the class of the primary page and the record type parameter.

Parameters:

aData - structured data to be parsed

aRecordType - record type portion of the key

aPrimaryPage - the primary page

aParameterPage - the page that results will be placed on

parseDelimited

boolean parseDelimited(java.io.Reader aData,
                       java.lang.String aNamespace,
                       java.lang.String aRecordType,
                       ClipboardPage aPrimaryPage,
                       ParameterPage aParameterPage)

Apply a delimited parse rule. Parsing will terminate once the end of the stream has been reached.

Parameters:

aData - the delimited data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-Delimited instance

aRecordType - the 'pyRecordType' key from the Rule-Parse-Delimited instance

aPrimaryPage - the primary page

aParameterPage - the page that results will be placed on

Returns:

true if end of stream was reached

parseDelimited

boolean parseDelimited(java.io.Reader aData,
                       java.lang.String aNamespace,
                       java.lang.String aRecordType,
                       ClipboardPage aPrimaryPage,
                       ParameterPage aParameterPage,
                       int length)

Apply a delimited parse rule. Terminate after parsing a specific number of characters.

Parameters:

aData - the delimited data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-Delimited instance

aRecordType - the 'pyRecordType' key from the Rule-Parse-Delimited instance

aPrimaryPage - the primary page

aParameterPage - the page that results will be placed on

length - the number of characters to parse.

Returns:

true if end of stream was reached

parseDelimited

boolean parseDelimited(java.io.Reader aData,
                       java.lang.String aNamespace,
                       java.lang.String aRecordType,
                       ClipboardPage aPrimaryPage,
                       ParameterPage aParameterPage,
                       java.lang.String aDelimiter)

Apply a delimited parse rule. Parsing is terminated when the supplied delimiter is reached.

Parameters:

aData - the delimited data to be parsed

aNamespace - the 'pyNamespace' key from the Rule-Parse-Delimited instance

aRecordType - the 'pyRecordType' key from the Rule-Parse-Delimited instance

aPrimaryPage - the primary page

aParameterPage - the page that results will be placed on

aDelimiter - the delimiter that marks where to stop parsing

Returns:

true if end of stream was reached