com.pega.pegarules.pub.clipboard

Interface IComparePagesAPI

public interface IComparePagesAPI

Provides constants for use in conjunction with the ComparePages logic. The current implementation of this facility is considered a Pega private internal API at this time. When the facility has matured it is likely to become a public facility in a future release. This facility should not be used except for carefully controlled internal development - it WILL change in non-compatible ways from the current implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPARE_DEBUG
static java.lang.String	COMPARE_PEGA
static java.lang.String	COMPARE_PEGATEST
static java.lang.String	COMPARE_TECHNIQUE Options for debugging alternate comparison techniques.
static java.lang.String	COMPARE_XMLUNIT
static java.lang.String	COPYRIGHT
static java.lang.String	FALSE Constant for specifying a false option
static java.lang.String	IGNORE_EMPTY_PROPERTIES If true empty properties are ignored and treated the same as non-existent properties (default behavior).
static java.lang.String	IGNORED_PROPERTY_ARRAY_SORTED Key to entry in control map specifying a sorted String[] of property names to be ignored
static java.lang.String	IGNORED_PROPERTY_ARRAY_UNSORTED Key to entry in control map specifying a unsorted String[] of property names to be ignored.
static java.lang.String	IGNORED_PROPERTY_USE_DEFAULT Key to entry in control map specifying that a default list of ignored properties should be used.
static java.lang.String	LIST_EXPAND_AGGREGATE_ELEMENTS When using RETURN_DIFFERENCE_LIST, this true/false option controls whether or not an insert or delete of an aggregate element also shows all of scalar values in that element as a separate insert/delete change.
static java.lang.String	MERGE_FLAG_AGGREGATE_ELEMENTS When using RETURN_MERGED_PAGE, these true/false options control how changes to lists and groups are reported.
static java.lang.String	MERGE_FLAG_AGGREGATES When using RETURN_MERGED_PAGE, these true/false options control how changes to lists and groups are reported.
static java.lang.String	NOFLAG_PROPERTY_ARRAY_SORTED Key to entry in control map specifying a sorted String[] of property names that should not be flagged as different when RETURN_MERGED_PAGE is used.
static java.lang.String	NOFLAG_PROPERTY_ARRAY_UNSORTED Key to entry in control map specifying a unsorted String[] of property names that should not be flagged as different when RETURN_MERGED_PAGE is used.
static java.lang.String	NOFLAG_PROPERTY_USE_DEFAULT Key to entry in control map specifying use of a default list of property names that should not be flagged as different when RETURN_MERGED_PAGE is used.
static java.lang.String	RETURN_DIFFERENCE_LIST Value for RETURN_VALUE_DESIRED indicating that a list of differences should be returned The List returned will contain elements each of which is an array of 7 Strings representing one difference.
static java.lang.String	RETURN_MERGED_PAGE Value for RETURN_VALUE_DESIRED indicating that a ClipboardPage of merged data should be returned.
static java.lang.String	RETURN_STREAMED_PAGE Value for RETURN_VALUE_DESIRED indicating that a streamed version should be returned for debugging.
static java.lang.String	RETURN_TIMINGS
static java.lang.String	RETURN_VALUE_DESIRED Key to entry in control map specifying type of comparison data desired
static java.lang.String	SORT_PROPERTIES If true properties are sorted before comparision - which greatly increases the overhead of processing.
static java.lang.String	TRUE Constant for specifying a true option
static java.lang.String	VERSION

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

RETURN_VALUE_DESIRED

static final java.lang.String RETURN_VALUE_DESIRED

Key to entry in control map specifying type of comparison data desired

See Also:

Constant Field Values

RETURN_STREAMED_PAGE

static final java.lang.String RETURN_STREAMED_PAGE

Value for RETURN_VALUE_DESIRED indicating that a streamed version should be returned for debugging. This option is for internal use while debugging the facility - the format of the data returned is subject to change.

See Also:

Constant Field Values

RETURN_DIFFERENCE_LIST

static final java.lang.String RETURN_DIFFERENCE_LIST

Value for RETURN_VALUE_DESIRED indicating that a list of differences should be returned The List returned will contain elements each of which is an array of 7 Strings representing one difference. The elements of the array are:

• 0 difference type code 0-6 corresponding to
• 1 difference type name: "Value", "AnnotatedValue", "Insert", "Delete", "Moved", "NameChange", "IndexChange"
• 2 clipboard property reference to change in page 1
• 3 value of scalar property in page 1, blank if it is an aggregate property (inserted or deleted)
• 4 clipboard property reference to change in page 2
• 5 value of scalar property in page 2, blank if it is an aggregate property (inserted or deleted)
• 6 annotated difference of multi-line text block (if difference type = annotatedvalue)

See Also:

Constant Field Values

RETURN_MERGED_PAGE

static final java.lang.String RETURN_MERGED_PAGE

Value for RETURN_VALUE_DESIRED indicating that a ClipboardPage of merged data should be returned. The format by which changes are inidicated in the merged page is subject to change. The initial implementaion marks changed/inserted/deleted properties with messages.

See Also:

Constant Field Values

IGNORED_PROPERTY_ARRAY_SORTED

static final java.lang.String IGNORED_PROPERTY_ARRAY_SORTED

Key to entry in control map specifying a sorted String[] of property names to be ignored

See Also:

Constant Field Values

IGNORED_PROPERTY_ARRAY_UNSORTED

static final java.lang.String IGNORED_PROPERTY_ARRAY_UNSORTED

Key to entry in control map specifying a unsorted String[] of property names to be ignored. This is very inefficient as the array is copied and sorted prior to use. Avoid this option if at all possible.

See Also:

Constant Field Values

IGNORED_PROPERTY_USE_DEFAULT

static final java.lang.String IGNORED_PROPERTY_USE_DEFAULT

Key to entry in control map specifying that a default list of ignored properties should be used. The list is subject to change during development of this facility and will stabilize when the facility is made public.

See Also:

Constant Field Values

IGNORE_EMPTY_PROPERTIES

static final java.lang.String IGNORE_EMPTY_PROPERTIES

If true empty properties are ignored and treated the same as non-existent properties (default behavior). If false then empty properties and non-existent properties are different. With the default (true) behavior, a change to an empty property will be reported as an "insert" or "delete". With the alternate behavior, the change will be reported as a "value change".

See Also:

Constant Field Values

TRUE

static final java.lang.String TRUE

Constant for specifying a true option

See Also:

Constant Field Values

FALSE

static final java.lang.String FALSE

Constant for specifying a false option

See Also:

Constant Field Values

SORT_PROPERTIES

static final java.lang.String SORT_PROPERTIES

If true properties are sorted before comparision - which greatly increases the overhead of processing. The default is false which does not sort the properties.

See Also:

Constant Field Values

LIST_EXPAND_AGGREGATE_ELEMENTS

static final java.lang.String LIST_EXPAND_AGGREGATE_ELEMENTS

When using RETURN_DIFFERENCE_LIST, this true/false option controls whether or not an insert or delete of an aggregate element also shows all of scalar values in that element as a separate insert/delete change. The default is false.

See Also:

Constant Field Values

MERGE_FLAG_AGGREGATES

static final java.lang.String MERGE_FLAG_AGGREGATES

When using RETURN_MERGED_PAGE, these true/false options control how changes to lists and groups are reported. MERGE_FLAG_AGGREGATES indicates that the aggregate element itself should be marked as changed. (With existing Rule Form display, this may be undesirable for Page Lists and introduce "spurious" messages on the form. By default, this value is FALSE.)

See Also:

Constant Field Values

MERGE_FLAG_AGGREGATE_ELEMENTS

static final java.lang.String MERGE_FLAG_AGGREGATE_ELEMENTS

When using RETURN_MERGED_PAGE, these true/false options control how changes to lists and groups are reported. MERGE_FLAG_AGGREGATE_ELEMENTS indicates that each scalar element of the aggregate should be marked as changed. (With existing Rule Form display, this will result in multiple fields of a Page List element to be flagged with the same notation, cluttering the display - but insures that each message is associated with a field (that could appear on the form). By default, this value is TRUE.)

See Also:

Constant Field Values

NOFLAG_PROPERTY_ARRAY_SORTED

static final java.lang.String NOFLAG_PROPERTY_ARRAY_SORTED

Key to entry in control map specifying a sorted String[] of property names that should not be flagged as different when RETURN_MERGED_PAGE is used. These properties are still compared (unless they also appear in the "ignore property" list) but will not be marked as different in the merged page. Typically this list would contain the names of properties that do not appear as visible fields on the form.

See Also:

Constant Field Values

NOFLAG_PROPERTY_ARRAY_UNSORTED

static final java.lang.String NOFLAG_PROPERTY_ARRAY_UNSORTED

Key to entry in control map specifying a unsorted String[] of property names that should not be flagged as different when RETURN_MERGED_PAGE is used. These properties are still compared (unless they also appear in the "ignore property" list) but will not be marked as different in the merged page. Typically this list would contain the names of properties that do not appear as visible fields on the form. This is very inefficient as the array is copied and sorted prior to use. Avoid this option if at all possible.

See Also:

Constant Field Values

NOFLAG_PROPERTY_USE_DEFAULT

static final java.lang.String NOFLAG_PROPERTY_USE_DEFAULT

Key to entry in control map specifying use of a default list of property names that should not be flagged as different when RETURN_MERGED_PAGE is used. These properties are still compared (unless they also appear in the "ignore property" list) but will not be marked as different in the merged page. Typically this list would contain the names of properties that do not appear as visible fields on the form. The list is subject to change during development of this facility and will stabilize when the facility is made public.

See Also:

Constant Field Values

COMPARE_TECHNIQUE

static final java.lang.String COMPARE_TECHNIQUE

Options for debugging alternate comparison techniques. Not for public use.

See Also:

Constant Field Values

COMPARE_XMLUNIT

static final java.lang.String COMPARE_XMLUNIT

See Also:

Constant Field Values

COMPARE_PEGATEST

static final java.lang.String COMPARE_PEGATEST

See Also:

Constant Field Values

COMPARE_PEGA

static final java.lang.String COMPARE_PEGA

See Also:

Constant Field Values

COMPARE_DEBUG

static final java.lang.String COMPARE_DEBUG

See Also:

Constant Field Values

RETURN_TIMINGS

static final java.lang.String RETURN_TIMINGS

See Also:

Constant Field Values