nxopen.validate

Class XmlComparator.Options

java.lang.Object

nxopen.validate.XmlComparator.Options

All Implemented Interfaces:

Serializable

Enclosing interface:

XmlComparator

public static class XmlComparator.Options
extends Object
implements Serializable

Represents config options in comparison

For example:

case 1: Defines filter file to control what nodes will be compared; generates comparison report and log; ignores CDATA and processing instruction nodes.

 compareOptions.ReportFile           = "auto_report.html";
                          compareOptions.FilterFile           = "filter.xml";
                          compareOptions.LogFile              = "log.log";
                          compareOptions.IgnoreNamespaces     = FALSE;
                          compareOptions.IgnoreUnmatchedNodes = FALSE;
                          compareOptions.IgnoreComments       = FALSE;
                          compareOptions.IgnoreCdata          = TRUE;
                          compareOptions.IgnorePI             = TRUE;
                          CompareXmlFiles("fileOne.xml", "fileTwo.xml", compareOptions)
                     

case 2: Compares all nodes and does not generate report file and log file.

 compareOptions.ReportFile           = null;
                          compareOptions.FilterFile           = null;
                          compareOptions.LogFile              = null;
                          CompareXmlFiles("fileOne.xml", "fileTwo.xml", compareOptions)
                    

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	filterFile File specification of filter file.
boolean	ignoreCdata Ignores CDATA nodes in comparison.
boolean	ignoreComments Ignores comment nodes in comparison.
boolean	ignoreNamespaces Ignores namespace definition during comparison.
boolean	ignorePI Ignores processing instruction nodes in comparison.
boolean	ignoreUnmatchedNodes Ignores unmatched nodes in comparison.
String	logFile File specification of comparison log file.
String	reportFile File specification of report file.

Constructor Summary

Constructors

Constructor and Description
Options()
Options(String filterFileInitial, String reportFileInitial, String logFileInitial, boolean ignoreNamespacesInitial, boolean ignoreUnmatchedNodesInitial, boolean ignoreCommentsInitial, boolean ignoreCdataInitial, boolean ignorePIInitial) Constructor for the Options object.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filterFile

public String filterFile

File specification of filter file. The filter file defines what nodes will be compared and how to compare them. It can be null, which means all nodes will be compared.

reportFile

public String reportFile

File specification of report file. The report file contains the detail comparison results. It can be null, which means the comparator won't generate a report file.

logFile

public String logFile

File specification of comparison log file. The log file contains detail comparison steps and comparison information. It can be null, which means the comparator won't generate a log file.

ignoreNamespaces

public boolean ignoreNamespaces

Ignores namespace definition during comparison. But if the filter file has namespace definition, the comparator will ignore this option and always compare the nodes with namespace definitions. Default if false.

ignoreUnmatchedNodes

public boolean ignoreUnmatchedNodes

Ignores unmatched nodes in comparison. Default is false.

ignoreComments

public boolean ignoreComments

Ignores comment nodes in comparison. Default is false.

ignoreCdata

public boolean ignoreCdata

Ignores CDATA nodes in comparison. Default is false.

ignorePI

public boolean ignorePI

Ignores processing instruction nodes in comparison. Default is false.

Constructor Detail

Options

public Options()

Options

public Options(String filterFileInitial,
               String reportFileInitial,
               String logFileInitial,
               boolean ignoreNamespacesInitial,
               boolean ignoreUnmatchedNodesInitial,
               boolean ignoreCommentsInitial,
               boolean ignoreCdataInitial,
               boolean ignorePIInitial)

Constructor for the Options object.

Parameters:

filterFileInitial - File specification of filter file. The filter file defines what nodes will be compared and how to compare them. It can be null, which means all nodes will be compared.

reportFileInitial - File specification of report file. The report file contains the detail comparison results. It can be null, which means the comparator won't generate a report file.

logFileInitial - File specification of comparison log file. The log file contains detail comparison steps and comparison information. It can be null, which means the comparator won't generate a log file.

ignoreNamespacesInitial - Ignores namespace definition during comparison. But if the filter file has namespace definition, the comparator will ignore this option and always compare the nodes with namespace definitions. Default if false.

ignoreUnmatchedNodesInitial - Ignores unmatched nodes in comparison. Default is false.

ignoreCommentsInitial - Ignores comment nodes in comparison. Default is false.

ignoreCdataInitial - Ignores CDATA nodes in comparison. Default is false.

ignorePIInitial - Ignores processing instruction nodes in comparison. Default is false.