com.deltaxml.cores9api.config

Class HtmlTableConfiguration

java.lang.Object

com.deltaxml.cores9api.config.HtmlTableConfiguration

public class HtmlTableConfiguration
extends java.lang.Object

Specifies configuration options for HTML table comparison. These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing tables.

Since:

10.2

Constructor Summary

Constructors

Constructor and Description
HtmlTableConfiguration() Constructs a new HtmlTableConfiguration instance.

Method Summary

Modifier and Type	Method and Description
HtmlColumnKeyingMode	getHtmlColumnKeyingMode() Returns the HtmlColumnKeyingMode currently in use when comparing HTML tables.
InvalidTableBehaviour	getInvalidTableBehaviour() Returns the current behaviour in use when inputs contain invalid HTML tables.
ValidationLevel	getValidationLevel() Returns the ValidationLevel current in use when validating HTML tables.
WarningReportMode	getWarningReportMode() Returns the WarningReportMode in use when invalid HTML tables are encountered.
boolean	isIgnoreColumnOrder() Determines whether ignoring HTML table column order is enabled.
boolean	isMarkTableCellSpanExtentChanges() Returns true if markTableCellSpanExtentChanges feature is on, otherwise false.
boolean	isNormalizeTable() Determines whether HTML table column specification is normalized.
boolean	isProcessTables() Determines whether HTML table processing is enabled.
void	setHtmlColumnKeyingMode(HtmlColumnKeyingMode mode) Sets the HtmlColumnKeyingMode to use when comparing HTML tables.
void	setIgnoreColumnOrder(boolean ignoreColumnOrder) Sets whether the DocumentComparator should ignore HTML table column order.
void	setInvalidTableBehaviour(InvalidTableBehaviour behaviour) Sets the behaviour to use when inputs contain invalid HTML tables.
void	setMarkTableCellSpanExtentChanges(boolean value) Sets the markTableCellSpanExtentChanges feature on or off.
void	setNormalizeTable(boolean value) Sets whether the DocumentComparator should normalize the specification of columns in HTML tables.
void	setProcessTables(boolean value) Sets whether the DocumentComparator should process HTML tables.
void	setValidationLevel(ValidationLevel level) Sets the ValidationLevel to use for HTML table validation.
void	setWarningReportMode(WarningReportMode mode) Specifies how HTML table invalidity warnings should be reported.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlTableConfiguration

public HtmlTableConfiguration()

Constructs a new HtmlTableConfiguration instance.

Method Detail

setProcessTables

public void setProcessTables(boolean value)

Sets whether the DocumentComparator should process HTML tables.

HTML table processing is recommended as it will perform sophisticated processing when comparing two HTML tables to ensure that the resulting HTML table is valid.

Parameters:

value - whether to use HTML table processing

isProcessTables

public boolean isProcessTables()

Determines whether HTML table processing is enabled.

Returns:

a boolean describing the enabled state of HTML table processing

setValidationLevel

public void setValidationLevel(ValidationLevel level)

Sets the ValidationLevel to use for HTML table validation.

A value of ValidationLevel.STRICT will cause the InvalidTableBehaviour mode to be used for any HTML invalidity. A value of ValidationLevel.RELAXED means that invalidities which are known to have no effect on HTML processing will not prevent HTML processing from running. N.B. Warnings will be reported according to the WarningReportMode regardless of the setting used here.

Parameters:

level - an instance of ValidationLevel describing the level to use

getValidationLevel

public ValidationLevel getValidationLevel()

Returns the ValidationLevel current in use when validating HTML tables.

Returns:

an instance of ValidationLevel describing the level in use

setInvalidTableBehaviour

public void setInvalidTableBehaviour(InvalidTableBehaviour behaviour)

Sets the behaviour to use when inputs contain invalid HTML tables.

Parameters:

behaviour - an instance of InvalidTableBehaviour specifying the behaviour to use when invalid HTML tables are encountered

getInvalidTableBehaviour

public InvalidTableBehaviour getInvalidTableBehaviour()

Returns the current behaviour in use when inputs contain invalid HTML tables.

Returns:

an instance of InvalidTableBehaviour describing the behaviour in use

setWarningReportMode

public void setWarningReportMode(WarningReportMode mode)

Specifies how HTML table invalidity warnings should be reported.

Parameters:

mode - the WarningReportMode to use when invalid HTML tables are encountered

getWarningReportMode

public WarningReportMode getWarningReportMode()

Returns the WarningReportMode in use when invalid HTML tables are encountered.

Returns:

an instance of WarningReportMode describing the reporting mode in use

setNormalizeTable

public void setNormalizeTable(boolean value)

Sets whether the DocumentComparator should normalize the specification of columns in HTML tables.

This setting is recommended when there is a difference between inputs of specifying columns, e.g. if one uses just <colgroup> and another uses <col> without <colgroup>.

Parameters:

value - whether to normalize HTML Table column specification

isNormalizeTable

public boolean isNormalizeTable()

Determines whether HTML table column specification is normalized.

Returns:

a boolean describing the enabled state of normalization of HTML Table column specification

setIgnoreColumnOrder

public void setIgnoreColumnOrder(boolean ignoreColumnOrder)

Sets whether the DocumentComparator should ignore HTML table column order.

Parameters:

ignoreColumnOrder - whether to ignore HTML table column order

isIgnoreColumnOrder

public boolean isIgnoreColumnOrder()

Determines whether ignoring HTML table column order is enabled.

Returns:

a boolean describing whether the HTML table column order is ignored

setHtmlColumnKeyingMode

public void setHtmlColumnKeyingMode(HtmlColumnKeyingMode mode)

Sets the HtmlColumnKeyingMode to use when comparing HTML tables.

Parameters:

mode - an instance of HtmlColumnKeyingMode describing the keying mode to use

getHtmlColumnKeyingMode

public HtmlColumnKeyingMode getHtmlColumnKeyingMode()

Returns the HtmlColumnKeyingMode currently in use when comparing HTML tables.

Returns:

an instance of HtmlColumnKeyingMode describing the keying mode in use

setMarkTableCellSpanExtentChanges

public void setMarkTableCellSpanExtentChanges(boolean value)

Sets the markTableCellSpanExtentChanges feature on or off. When set, a deltaxml:span-extent-changed attribute is added to table cell elements that have changed spans.

Parameters:

value - A boolean value to set this feature.

isMarkTableCellSpanExtentChanges

public boolean isMarkTableCellSpanExtentChanges()

Returns true if markTableCellSpanExtentChanges feature is on, otherwise false.

Returns:

the current setting for markTableCellSpanExtentChanges.